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: Iconic #3778

Merged
merged 1 commit into from
Jul 9, 2024
Merged

Add plugin: Iconic #3778

merged 1 commit into from
Jul 9, 2024

Conversation

gfxholo
Copy link
Contributor

@gfxholo gfxholo commented Jun 27, 2024

I am submitting a new Community Plugin

Repo URL

Link to my plugin: https://github.com/gfxholo/iconic

Release Checklist

  • I have tested the plugin on
    • Windows
    • macOS
    • Linux
    • Android (if applicable)
    • iOS (if applicable)
  • My GitHub release contains all required files
    • 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.

@ObsidianReviewBot
Copy link
Collaborator

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

Required

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


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 self-assigned this Jun 29, 2024
@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 29, 2024
@gfxholo
Copy link
Contributor Author

gfxholo commented Jun 29, 2024

/skip

Thanks bot! I was expecting these two points to come up.

  1. This plugin sets the stroke attribute on individual SVGs to support custom hex colors, which can't really be achieved using hardcoded CSS. It also sets a filter attribute on emojis for the same reason.
  2. There are 3 casts to any in the codebase:
    • 2 in IconPicker.ts to fetch a localization string using a color ID, which is guaranteed to be valid.
    • 1 in IconicSettingTab.ts to avoid some type-checking on an object full of button components, which are always assigned before their first use.

The casts can be rewritten in other ways, so let me know if they seem too egregious.

@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 29, 2024
@joethei joethei added Changes made and removed Changes requested Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made Skipped code scan Code scanning skipped because submission is not in TS/author believes result is wrong labels Jul 4, 2024
@joethei joethei merged commit 08c1ae2 into obsidianmd:master Jul 9, 2024
1 check passed
@gfxholo
Copy link
Contributor Author

gfxholo commented Jul 10, 2024

Big thanks for reviewing this, @joethei 💜

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants