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: GitHub stars #5602

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

Conversation

vovanbo
Copy link

@vovanbo vovanbo commented Mar 6, 2025

I am submitting a new Community Plugin

Repo URL

Link to my plugin: https://github.com/vovanbo/obsidian-github-stars

Release Checklist

  • I have tested the plugin on
    • Windows
    • macOS
    • Linux
    • Android (if applicable)
    • 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.

@github-actions github-actions bot changed the title Add "github-stars" to community plugin list Add plugin: GitHub stars Mar 6, 2025
@ObsidianReviewBot
Copy link
Collaborator

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

Required

[1]:Obsidian's configuration directory isn't necessarily .obsidian, it can be configured by the user. You can access the configured value from Vault#configDir

[1]: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

[1][2][3][4][5][6][7][8][9][10][11][12][13][14][15][16][17][18][19][20][21][22][23][24][25][26]:You should consider limiting the number of console.logs in your code, to not pollute the dev console.


Optional

[1]:Use app.fileManager.trashFile(file: TAbstractFile) instead, this will make sure that the file is deleted according to the users preferences.


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 Mar 7, 2025
@vovanbo
Copy link
Author

vovanbo commented Mar 8, 2025

Obsidian's configuration directory isn't necessarily .obsidian, it can be configured by the user. You can access the configured value from Vault#configDir

/skip This code placed inside build scripts, so Vault object is unavailable there.

Using innerHTML, outerHTML or similar API's is a security risk. Instead, use the DOM API or the Obsidian helper functions

Fixed in 0.5.1

You should consider limiting the number of console.logs in your code, to not pollute the dev console.

/skip Console logs removed at the build stage.

Use app.fileManager.trashFile(file: TAbstractFile) instead, this will make sure that the file is deleted according to the users preferences

Fixed in 0.5.1

@github-actions github-actions bot added the Skipped code scan Code scanning skipped because submission is not in TS/author believes result is wrong label Mar 8, 2025
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 Skipped code scan Code scanning skipped because submission is not in TS/author believes result is wrong
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants