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: Asciidoctor editor #4286

Merged
merged 1 commit into from
Oct 29, 2024
Merged

Add plugin: Asciidoctor editor #4286

merged 1 commit into from
Oct 29, 2024

Conversation

dzruyk
Copy link
Contributor

@dzruyk dzruyk commented Sep 28, 2024

I am submitting a new Community Plugin

Repo URL

Link to my plugin: https://github.com/dzruyk/obsidian-asciidoc

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:

❌ Could not parse community-plugins.json, invalid JSON. Expected double-quoted property name in JSON at position 497594


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:

❌ Could not parse community-plugins.json, invalid JSON. Expected double-quoted property name in JSON at position 497594


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.

@dzruyk dzruyk changed the title Update community-plugins.json Add plugin: Asciidoctor editor plugin Sep 28, 2024
Copy link

Hello!

I found the following issues in your plugin submission

Errors:

❌ Please don't use the word plugin 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 use the word Plugin in the plugin name since it's redundant and adds clutter to the plugin list.
❌ 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

Hello!

I found the following issues in your plugin submission

Errors:

❌ Please don't include Obsidian in the plugin description


Warnings:

⚠️ Your repository does not include a license. It is generally recommended for open-source projects to have a license. Go to https://choosealicense.com/ to compare different open source licenses.


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:

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

@github-actions github-actions bot changed the title Add plugin: Asciidoctor editor plugin Add plugin: Asciidoctor editor Sep 30, 2024
@ObsidianReviewBot
Copy link
Collaborator

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

Required

[1][2][3]: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]: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

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


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 Oct 1, 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 Oct 1, 2024
@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 Oct 6, 2024
@ObsidianReviewBot ObsidianReviewBot removed their assignment Oct 6, 2024
@ObsidianReviewBot
Copy link
Collaborator

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

@joethei
Copy link
Collaborator

joethei commented Oct 21, 2024

"fundingUrl": "https://тыл-22.рф/",
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.

app: any;
Remove this, it serves no purpose.

interface AsciidocPluginSettings {, // This adds a status bar item to the bottom of the app. Does not work on mobile apps., class AsciidocSettingTab extends PluginSettingTab {
Remove this sample code

export function createEl(tagName: string, attrs?: any): HTMLElement {
The Obsidian API already exports a function with the same name that serves the same purpose.

declare var CodeMirror: any;
You should change all instances of var to either const or let. var has function-level scope, so it can easily lead to bugs if you're not careful. Here's a pretty good guide with examples of why not to use var: why var is obsolete

item.src = this.app.vault.getResourcePath(file);
Always do a instanceof check when you are getting a file with the getAbstractFileByPath, it could also be a folder here.
The cast is making the compiler happy, not the runtime.
Alternatively use the getFileByPath API (requires Obsidian 1.15.7)

@joethei joethei added Changes requested Minor changes requested PR can be merged after some final changes have been requested labels Oct 21, 2024
@dzruyk
Copy link
Contributor Author

dzruyk commented Oct 22, 2024

@joethei thanks for review.

I made all the requested changes.

Copy link

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: mProjectsCode/obsidian-lemons-search-plugin. 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.

@joethei joethei merged commit b460eb7 into obsidianmd:master Oct 29, 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