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: Apple Style Notes #5268

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

XuQuan-nikkkki
Copy link

I am submitting a new Community Plugin

Repo URL

Link to my plugin: https://github.com/XuQuan-nikkkki/apple-style-notes-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

Hello!

I found the following issues in your plugin submission

Errors:

❌ Plugin name mismatch, the name in this PR (Apple Style Notes) is not the same as the one in your repo (Apple Style Notes Plugin). If you just changed your plugin name, remember to change it in the manifest.json in your repo and your latest 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.

@ObsidianReviewBot
Copy link
Collaborator

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

Required

[1][2]:You should not cast this, instead use a instanceof check to make sure that it's actually a file/folder.


Optional

[1][2]: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 Jan 31, 2025
@XuQuan-nikkkki
Copy link
Author

For the optional feedback, I have updated the code to use app.fileManager.trashFile(file: TAbstractFile) as suggested in XuQuan-nikkkki/apple-style-notes-plugin@bfd0416

For the required feedback regarding type checking, the isFile and isFolder method I used is a custom utility method that internally checks instanceof TFile and TFolder (https://github.com/XuQuan-nikkkki/apple-style-notes-plugin/blob/main/src/utils.ts#L4). Since it achieves the same functionality and improves readability in my implementation, I believe this should not be an issue.

/skip The required check on type casting, as isFile is a wrapper around instanceof TFile and ensures proper type checking. Let me know if any further clarification is needed.

@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 Jan 31, 2025
@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 Feb 6, 2025
@ObsidianReviewBot ObsidianReviewBot removed their assignment Feb 6, 2025
@ObsidianReviewBot
Copy link
Collaborator

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

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