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: Enhanced Image #4164

Merged
merged 2 commits into from
Sep 23, 2024
Merged

Add plugin: Enhanced Image #4164

merged 2 commits into from
Sep 23, 2024

Conversation

situ2001
Copy link
Contributor

@situ2001 situ2001 commented Sep 4, 2024

I am submitting a new Community Plugin

Repo URL

Link to my plugin: https://github.com/situ2001/obsidian-enhanced-image

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 Sep 4, 2024

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.

Copy link

github-actions bot commented Sep 4, 2024

Hello!

I found the following issues in your plugin submission

Errors:

❌ Plugin ID mismatch, the ID in this PR (enhanced-image) is not the same as the one in your repo (obsidian-enhanced-image). If you just changed your plugin ID, 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.

@situ2001 situ2001 closed this Sep 4, 2024
@situ2001 situ2001 reopened this Sep 4, 2024
@github-actions github-actions bot changed the title Add plugin: Enhanced Image 🖼️ Add plugin: Enhanced Image Sep 4, 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.


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

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

@joethei
Copy link
Collaborator

joethei commented Sep 19, 2024

"fundingUrl": "",
This is meant for links to services like Buy me a coffee, GitHub sponsors and so on, if you don't have such a link remove this line.

item.setTitle("Copy Link");, new Notice("No Image Selected");, new Notice("Copy Link Successfully");, item.setTitle("Show in Folder");, title: "Delete Image",, item.setTitle("Copy Image");, item.setTitle("Copy Link");, item.setTitle("Download & Replace");, this.titleEl.setText("Rename Image");
Use sentence case in UI

console.warn("onContextMenu", event);, console.warn("mdLink", mdLink);, console.log("newContent", newContent);, console.warn("window-open", window);
Remove this, and please avoid unnecessary logging. If you need it for debugging purposes, add a check to only log during development.

import path from "path";
This import is only available from a Node.js runtime, which means that this will throw errors on Mobile (that's a problem since you have isDesktopOnly marked as false in your manifest.json file.

const pathWithNewName = path.join(parentPath, this.newName + "." + this.file.extension);
Just join it with a slash /, Obsidian always uses that.

@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 Sep 19, 2024
@situ2001
Copy link
Contributor Author

"fundingUrl": "", This is meant for links to services like Buy me a coffee, GitHub sponsors and so on, if you don't have such a link remove this line.

item.setTitle("Copy Link");, new Notice("No Image Selected");, new Notice("Copy Link Successfully");, item.setTitle("Show in Folder");, title: "Delete Image",, item.setTitle("Copy Image");, item.setTitle("Copy Link");, item.setTitle("Download & Replace");, this.titleEl.setText("Rename Image"); Use sentence case in UI

console.warn("onContextMenu", event);, console.warn("mdLink", mdLink);, console.log("newContent", newContent);, console.warn("window-open", window); Remove this, and please avoid unnecessary logging. If you need it for debugging purposes, add a check to only log during development.

import path from "path"; This import is only available from a Node.js runtime, which means that this will throw errors on Mobile (that's a problem since you have isDesktopOnly marked as false in your manifest.json file.

const pathWithNewName = path.join(parentPath, this.newName + "." + this.file.extension); Just join it with a slash /, Obsidian always uses that.

Thanks for your review! I have applied your suggestion to my codebase.

Here is the comparison: situ2001/obsidian-enhanced-image@0fa3099...586cd8a

@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 Sep 22, 2024
@joethei joethei force-pushed the patch-1 branch 2 times, most recently from db456f3 to d351df0 Compare September 23, 2024 10:32
@joethei joethei merged commit c31aa6f into obsidianmd:master Sep 23, 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
Development

Successfully merging this pull request may close these issues.

3 participants