Skip to content

Add plugin: Variant Editor #6718

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

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

Conversation

kunalJa
Copy link

@kunalJa kunalJa commented Jun 13, 2025

add Variant Editor Plugin

I am submitting a new Community Plugin

Repo URL

Link to my plugin: https://github.com/kunalJa/VariantEditor

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.

add Variant Editor Plugin
Copy link

Hello!

I found the following issues in your plugin submission

Errors:

❌ The authorUrl field in your manifest should not point to the GitHub repository of the plugin.
❌ Your latest release is missing the main.js file.
❌ Your latest release is missing the manifest.json file.


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.

@ObsidianReviewBot
Copy link
Collaborator

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

Required

[1][2][3][4][5][6][7][8][9][10][11][12]:You should avoid assigning styles via JavaScript or in HTML and instead move all these styles into CSS so that they are more easily adaptable by themes and snippets.

[1][2][3][4]: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]:We recommend against providing a default hotkey when possible. The reason being that it's easy to pick a hotkey that a user already has configured and they could get confused when that key doesn't do what they expect. Also, it's hard choosing a safe default hotkey that's available for all operating systems.


Optional

[1][2][3]:Casting to any should be avoided as much as possible.


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 Jun 14, 2025
@kunalJa
Copy link
Author

kunalJa commented Jun 15, 2025

Addressed default hotkey and innerHTML and many of the avoid assigning styles via javascript

@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 Jun 15, 2025
@kunalJa
Copy link
Author

kunalJa commented Jun 15, 2025

/skip
Assigning some style elements via javascript are necessary for dynamically positioning a menu relative to the line of text and cursor position. Using CSS custom properties as well! The modal for example is draggable and can move around, so its positioning must be reset via the javascript. Those instances are here [1][2][3][4][5][6][7][8]

@kunalJa
Copy link
Author

kunalJa commented Jun 15, 2025

Maybe I should have waited for it to go to the second round before writing the /skip... Not sure. Let me know if this can be reviewed or the labels can be updated to ready to review by a human @ObsidianReviewBot @farcaller @muness @dpickett

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

kunalJa commented Jun 16, 2025

Oh nice, the labels were updated after a couple hours. Sorry for the impatience!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
plugin Ready for review 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