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: AudioPen Sync #3573

Merged
merged 4 commits into from
Jun 11, 2024
Merged

Add plugin: AudioPen Sync #3573

merged 4 commits into from
Jun 11, 2024

Conversation

jonashaefele
Copy link
Contributor

@jonashaefele jonashaefele commented May 23, 2024

I am submitting a new Community Plugin

Repo URL

Link to my plugin:
https://github.com/jonashaefele/audiopen-obsidian/

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.

Copy link

Hello!

I found the following issues in your plugin submission

Errors:

❌ Please don't use the word Obsidian in your plugin name since it's redundant and adds clutter to the plugin list.


Warnings:

⚠️ Your repository does not have issues enabled. Users will not be able to report bugs and request features.


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

Hello!

I found the following issues in your plugin submission

Errors:

❌ Plugin name mismatch, the name in this PR (AudioPen Sync) is not the same as the one in your repo (AudioPen-Obsidian Sync). If you just changed your plugin name, remember to change it in the manifest.json in your repo and your latest GitHub release.


Warnings:

⚠️ Your repository does not have issues enabled. Users will not be able to report bugs and request features.


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

Hello!

I found the following issues in your plugin submission

Warnings:

⚠️ Your repository does not have issues enabled. Users will not be able to report bugs and request features.


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 AudioPen-Obsidian Sync Plugin Add plugin: AudioPen Sync May 23, 2024
@jonashaefele jonashaefele reopened this May 23, 2024
@ObsidianReviewBot
Copy link
Collaborator

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

Required

[1]:Remember to rename the sample classes to something that makes sense to your plugin. If there are any errors, Obsidian will spit out this class name, so this will be important for users to debug if they need to.

[1][2][3]: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]: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 May 24, 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 May 24, 2024
@jonashaefele
Copy link
Contributor Author

jonashaefele commented May 24, 2024

Updated the repo with a new release, fixing all required issues.

I can't fix the optional issue, because type definitions of this.app aren't correct.

Without casting this.app as any, I get TS error:

Property 'setting' does not exist on type 'App'.

This has been documented here: https://forum.obsidian.md/t/open-settings-for-my-plugin-community-plugin-settings-deeplink/61563/3

Edit: I changed it to @ts-ignore the lines where this.app.setting and this.app.plugin are used. That should make the bot happy. Type definitions on those two properties would make this redundant.

@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 May 24, 2024
@ObsidianReviewBot ObsidianReviewBot removed their assignment May 24, 2024
@ObsidianReviewBot
Copy link
Collaborator

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

@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 May 24, 2024
@jonashaefele
Copy link
Contributor Author

Thanks for the super quick and thorough review @joethei

And here was me thinking I got the sentence case right everywhere. My bad.
I learned a lot from this little PR. Guess I was very confused because a lot of the plugins I use don't follow the guidelines, so I made my plugin "look like the ones I use". But it does look way nicer now that I followed the guidelines properly.

And thanks for the note on setting headings. Same here, looks way nicer.

I think all should be well now. Let me know if any other changes are needed.

Copy link

github-actions bot commented Jun 5, 2024

Hello!

I found the following issues in your plugin submission

Errors:

❌ The newly added entry is not at the end, or you are submitting on someone else's behalf. The last plugin in the list is: aygjiay/obsidian-link-to-verse. If you are submitting from a GitHub org, you need to be a public member of the org.


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 Jun 5, 2024

Hello!

I found the following issues in your plugin submission

Errors:

❌ Could not parse community-plugins.json, invalid JSON. Unexpected token ] in JSON at position 434469


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.

@jonashaefele
Copy link
Contributor Author

I updated the PR by merging master and then moving my plugin down to the very end of the list again. I hope that helps.

Let me know if there's anything else you need from me.

@ObsidianReviewBot ObsidianReviewBot added Ready for review Changes made and removed Changes requested Minor changes requested PR can be merged after some final changes have been requested labels Jun 10, 2024
Copy link

Hello!

I found the following issues in your plugin submission

Errors:

❌ Could not parse community-plugins.json, invalid JSON. Unexpected token } in JSON at position 437481


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.

@joethei joethei merged commit 5039207 into obsidianmd:master Jun 11, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants