Skip to content

Conversation

@ragetrip
Copy link

@ragetrip ragetrip commented Sep 8, 2025

I am submitting a new Community Plugin

  • I attest that I have done my best to deliver a high-quality plugin, am proud of the code I have written, and would recommend it to others. I commit to maintaining the plugin and being responsive to bug reports. If I am no longer able to maintain it, I will make reasonable efforts to find a successor maintainer or withdraw the plugin from the directory.

Repo URL

Link to my plugin: https://github.com/ragetrip/scoped-search

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.

Notes

  • Release tag/version: 2.0.7
  • manifest.json version: 2.0.7
  • versions.json: { "2.0.7": "1.5.0"}

@ragetrip
Copy link
Author

ragetrip commented Sep 8, 2025

Tested and verified iOS functionality.

@ObsidianReviewBot ObsidianReviewBot removed their assignment Sep 8, 2025
@ObsidianReviewBot
Copy link
Collaborator

The automated review has not found any issues with your code, ready for manual review.
Please be aware that it might take a few weeks before your plugin is reviewed due to the high volume of submissions currently.

@ragetrip
Copy link
Author

ragetrip commented Oct 1, 2025

  • Tested and verified with macOS & Android.
  • Also updated release to 2.0.7.
    • updated all required files to match.

@ObsidianReviewBot
Copy link
Collaborator

The automated review has not found any issues with your code, ready for manual review.
Please be aware that it might take a few weeks before your plugin is reviewed due to the high volume of submissions currently.

@Fevol Fevol self-assigned this Nov 9, 2025
@Fevol
Copy link
Collaborator

Fevol commented Nov 9, 2025

Required Changes

Avoid repeating the name of your plugin in the description. See the description style guide for more information.

Did you develop the plugin in TypeScript or JavaScript? If you used TypeScript, please upload the ts code, and remove the main.js from your repo. If you used JavaScript, please reformat the code so it is more readable for the review.
https://github.com/ragetrip/scoped-search/blob/eccae843d62f314c1e296d236da5868bd1e8968f/esbuild.config.mjs

Avoid "General", "Settings", or plugin name as top-level headings. Use headings only if there are multiple sections.
https://github.com/ragetrip/scoped-search/blob/eccae843d62f314c1e296d236da5868bd1e8968f/main.js#L404

Please consider moving these inline styles to separate classes for better theme compatibility.
https://github.com/ragetrip/scoped-search/blob/eccae843d62f314c1e296d236da5868bd1e8968f/main.js#L67
https://github.com/ragetrip/scoped-search/blob/eccae843d62f314c1e296d236da5868bd1e8968f/main.js#L89
https://github.com/ragetrip/scoped-search/blob/eccae843d62f314c1e296d236da5868bd1e8968f/main.js#L384
https://github.com/ragetrip/scoped-search/blob/eccae843d62f314c1e296d236da5868bd1e8968f/main.js#L437

Use setHeading() instead of createEl('h3', ...)
https://github.com/ragetrip/scoped-search/blob/eccae843d62f314c1e296d236da5868bd1e8968f/main.js#L427
https://github.com/ragetrip/scoped-search/blob/eccae843d62f314c1e296d236da5868bd1e8968f/main.js#L508

Instead of caling loadData twice, you can copy the original saved object.
https://github.com/ragetrip/scoped-search/blob/eccae843d62f314c1e296d236da5868bd1e8968f/main.js#L520C3-L520C6

Use window.setTimeout, window.clearTimeout, window.setInterval, window.clearInterval instead of their versions without window.

Regex:

setTimeout|clearTimeout|setInterval|clearInterval

Prefer to use Vault.cachedRead over Vault.read when you are only reading the content of files, and not writing to them afterwards.
https://github.com/ragetrip/scoped-search/blob/eccae843d62f314c1e296d236da5868bd1e8968f/main.js#L163
https://github.com/ragetrip/scoped-search/blob/eccae843d62f314c1e296d236da5868bd1e8968f/main.js#L354

Please do not assign to innerHTML like this, using innerHTML, outerHTML or similar API's poses a security risk. Instead, use the sanitizeHTMLToDom API or the Obsidian helper functions.
https://github.com/ragetrip/scoped-search/blob/eccae843d62f314c1e296d236da5868bd1e8968f/main.js#L98
https://github.com/ragetrip/scoped-search/blob/eccae843d62f314c1e296d236da5868bd1e8968f/main.js#L383
https://github.com/ragetrip/scoped-search/blob/eccae843d62f314c1e296d236da5868bd1e8968f/main.js#L429


Optional Feedback

Consider using a consistent prefix for all your classes, either .scoped-..., or .sfp-....
https://github.com/ragetrip/scoped-search/blob/eccae843d62f314c1e296d236da5868bd1e8968f/styles.css#L14-L28

@Fevol Fevol 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 Nov 9, 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants