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: WeRead Formatter #5320

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

Conversation

SheldonLiu0412
Copy link

I am submitting a new Community Plugin

Repo URL

Link to my plugin:

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.

Copy link

github-actions bot commented Feb 6, 2025

Hello!

I found the following issues in your plugin submission

Errors:

❌ Please don't include Obsidian in the plugin description
❌ Unable to find a release with the tag 1.0.0. Make sure that the version in your manifest.json file in your repo points to the correct Github Release.


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.

Copy link

github-actions bot commented Feb 6, 2025

Hello!

I found the following issues in your plugin submission

Errors:

❌ Unable to find a release with the tag 1.0.0. Make sure that the version in your manifest.json file in your repo points to the correct Github Release.


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.

Copy link

github-actions bot commented Feb 6, 2025

Hello!

I found the following issues in your plugin submission

Errors:

❌ 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.

@github-actions github-actions bot changed the title Add plugin:WeRead Formatter Add plugin: WeRead Formatter Feb 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]:Please remove the main.js file from the repo and add it to your .gitignore. Compiled release files shouldn't get mixed with source code in your commits and should go to the releases files instead.

[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

[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.

[1]:Do not detach leaves with your custom view in onunload, this is an antipattern, see: https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines#Don't+detach+leaves+in+%60onunload%60


Optional

[1][2]: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 Ready for review and removed Ready for review Changes requested Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made labels Feb 7, 2025
@ObsidianReviewBot ObsidianReviewBot removed their assignment Feb 7, 2025
@ObsidianReviewBot
Copy link
Collaborator

Changes requested by bot have been made, ready for additional review by human.

@SheldonLiu0412
Copy link
Author

How long will it take for the plugin to pass the review?

@joethei
Copy link
Collaborator

joethei commented Feb 26, 2025

"repo": "SheldonLiu0412/weread-formatter",
These are not valid parts in the manifest.

containerEl.createEl('h2', {text: '微信读书格式化设置'});
Don't add a top-level heading in the settings tab, such as "General", "Settings", or the name of your plugin.

if (this.app.workspace.layoutReady) {
This code should be simplified to only: this.app.workspace.onLayoutReady(() => this.initLeaf());
The callback is automatically called when the layout is already ready.

private loadStyles() {
Obsidian already does this, remove this code.

@joethei joethei self-assigned this Feb 26, 2025
@joethei joethei added Changes requested Minor changes requested PR can be merged after some final changes have been requested and removed Ready for review labels Feb 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changes requested Minor changes requested PR can be merged after some final changes have been requested plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants