Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add plugin: Wakatime / Wakapi #5438

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

Kovah
Copy link

@Kovah Kovah commented Feb 18, 2025

I am submitting a new Community Plugin

Repo URL

Link to my plugin: https://github.com/Kovah/obsidian-wakatime

Release Checklist

  • I have tested the plugin on
    • Windows
    • macOS
    • Linux (not available for me)
    • Android (if applicable) (not available for me)
    • iOS (if applicable)
  • My GitHub release contains all required files (as individual files, not just in the source.zip / source.tar.gz)
    • main.js
    • manifest.json
    • styles.css (optional)
  • GitHub release name matches the exact version number specified in my manifest.json (Note: Use the exact version number, don't include a prefix v)
  • The id in my manifest.json matches the id in the community-plugins.json file.
  • My README.md describes the plugin's purpose and provides clear usage instructions.
  • I have read the developer policies at https://docs.obsidian.md/Developer+policies, and have assessed my plugins's adherence to these policies.
  • I have read the tips in https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines and have self-reviewed my plugin to avoid these common pitfalls.
  • I have added a license in the LICENSE file.
  • My project respects and is compatible with the original license of any code from other plugins that I'm using.
    I have given proper attribution to these other projects in my README.md.

Copy link

Hello!

I found the following issues in your plugin submission

Errors:

❌ Please don't use the word obsidian in the plugin ID. The ID is used for your plugin's folder so keeping it short and simple avoids clutter and helps with sorting.
❌ Please don't include Obsidian in the plugin description
❌ The authorUrl field in your manifest should not point to the GitHub repository of the plugin.


This check was done automatically. Do NOT open a new PR for re-validation. Instead, to trigger this check again, make a change to your PR and wait a few minutes, or close and re-open it.

@github-actions github-actions bot changed the title Add obsidian-wakatime-kvh Add plugin: Wakatime / Wakapi Feb 18, 2025
@ObsidianReviewBot
Copy link
Collaborator

Thank you for your submission, an automated scan of your plugin code's revealed the following issues:

Required

[1][2]:This class is only available on desktop, which means that this will throw errors on mobile (that's a problem since you have isDesktopOnly marked as false in your manifest.json file.

[1]:You should not cast this, instead use a instanceof check to make sure that it's actually the adapter you expect.

[1]:Remember to rename the sample classes to something that makes sense to your plugin. If there are any errors, Obsidian will spit out this class name, so this will be important for users to debug if they need to.

[1][2]:Using innerHTML, outerHTML or similar API's is a security risk. Instead, use the DOM API or the Obsidian helper functions: https://docs.obsidian.md/Plugins/User+interface/HTML+elements


Do NOT open a new PR for re-validation.
Once you have pushed all of the required changes to your repo, the bot will update the labels on this PR within 6 hours.
If you think some of the required changes are incorrect, please comment with /skip and the reason why you think the results are incorrect.

@ObsidianReviewBot ObsidianReviewBot added Changes requested Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made and removed Ready for review labels Feb 19, 2025
@Kovah
Copy link
Author

Kovah commented Feb 19, 2025

All issues except innerHTML were resolved. The usage of innerHTML is not a security risk in this case, as it sets static html for an element. Using the DOM API would require 15+ lines of code and would have no benefit over innerHTML.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made Changes requested plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants