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: Media Viewer #5100

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

Add plugin: Media Viewer #5100

wants to merge 2 commits into from

Conversation

Devon22
Copy link

@Devon22 Devon22 commented Jan 8, 2025

I am submitting a new Community Plugin

Repo URL

Link to my plugin: https://github.com/Devon22/obsidian-mediaviewer

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 Jan 8, 2025

Hello!

I found the following issues in your plugin submission

Errors:

❌ Please don't use the word obsidian in the plugin ID. The ID is used for your plugin's folder so keeping it short and simple avoids clutter and helps with sorting.
❌ Please don't include Obsidian in the plugin description


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


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

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

@joethei
Copy link
Collaborator

joethei commented Jan 22, 2025

"description": "A media viewer plugin, allowing you to view and manage media files within your notes.",
Avoid including sentences like "This is a plugin that does ..." in your description, it should be a given since this is only shown when browsing plugins through the app or on our website.
We have published a guide for plugin descriptions to follow here: https://docs.obsidian.md/Plugins/Releasing/Submission+requirements+for+plugins#Keep+plugin+descriptions+short+and+simple.

'ALLOW_MEDIA_DELETION': 'Allow Media Deletion',, 'AUTO_OPEN_FIRST_IMAGE': 'Auto Open First Image',, 'CLICK_TO_OPEN_MEDIA': 'Click Image to Open Media Browser',, 'MUTE_VIDEO_ON_OPEN': 'Mute Video on Open',, 'GALLERY_GRID_WIDTH': 'Gallery Grid Width',, 'OPEN_MEDIA_VIEWER': 'Open Media Viewer',
Use sentence case in UI

videoIcon.innerHTML = '';, videoIcon.innerHTML = '';, noteIcon.innerHTML = ](https://github.com/Devon22/obsidian-mediaviewer/blob/87300f26dd64aab533c8e486c4d3629f07b6ee23/main_src.js#L1755-L1759), [noteIcon.innerHTML = , videoIcon.innerHTML = '';, [videoIcon.innerHTML = ](https://github.com/Devon22/obsidian-mediaviewer/blob/87300f26dd64aab533c8e486c4d3629f07b6ee23/main_src.js#L1824-L1828) Don't use innerHTML` for this, see the docs for what to do instead: https://docs.obsidian.md/Plugins/User+interface/Icons

const style = document.createElement('style');, const styleEl = document.createElement('style');
All the hardcoded stuff in here should be in the styles.css file.

You have this system for supporting different languages, but a lot of strings are only in chinese, please enable translation for thiese.

@joethei joethei self-assigned this Jan 22, 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 Jan 22, 2025
@Devon22
Copy link
Author

Devon22 commented Jan 23, 2025

"description": "A media viewer plugin, allowing you to view and manage media files within your notes.", Avoid including sentences like "This is a plugin that does ..." in your description, it should be a given since this is only shown when browsing plugins through the app or on our website. We have published a guide for plugin descriptions to follow here: https://docs.obsidian.md/Plugins/Releasing/Submission+requirements+for+plugins#Keep+plugin+descriptions+short+and+simple.

Fixed.

'ALLOW_MEDIA_DELETION': 'Allow Media Deletion',, 'AUTO_OPEN_FIRST_IMAGE': 'Auto Open First Image',, 'CLICK_TO_OPEN_MEDIA': 'Click Image to Open Media Browser',, 'MUTE_VIDEO_ON_OPEN': 'Mute Video on Open',, 'GALLERY_GRID_WIDTH': 'Gallery Grid Width',, 'OPEN_MEDIA_VIEWER': 'Open Media Viewer', Use sentence case in UI

'GALLERY_GRID_WIDTH': 'Gallery Grid Width'
the latter part is what's displayed on the UI.

videoIcon.innerHTML = '';, videoIcon.innerHTML = '';, noteIcon.innerHTML = ](https://github.com/Devon22/obsidian-mediaviewer/blob/87300f26dd64aab533c8e486c4d3629f07b6ee23/main_src.js#L1755-L1759), [noteIcon.innerHTML = , videoIcon.innerHTML = '';, [videoIcon.innerHTML = ](https://github.com/Devon22/obsidian-mediaviewer/blob/87300f26dd64aab533c8e486c4d3629f07b6ee23/main_src.js#L1824-L1828) Don't use innerHTML` for this, see the docs for what to do instead: https://docs.obsidian.md/Plugins/User+interface/Icons

const style = document.createElement('style');, const styleEl = document.createElement('style'); All the hardcoded stuff in here should be in the styles.css file.

Fixed.

You have this system for supporting different languages, but a lot of strings are only in chinese, please enable translation for thiese.

Fixed, only comments remain.

@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 Jan 23, 2025
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