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: Symbol linking #5242

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

Conversation

Mara-Li
Copy link
Contributor

@Mara-Li Mara-Li commented Jan 27, 2025

I am submitting a new Community Plugin

Repo URL

Link to my plugin: https://github.com/Mara-Li/obsidian-symbol-linking

It is a fork of "at symbol linking" that allows per folder & per files trigger.
For example, "@" can trigger files in "References/Contact" and "+" can trigger files in the folder "City".

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:

❌ Please don't include Obsidian in the plugin description
❌ Plugin name mismatch, the name in this PR (Symbol Linking) is not the same as the one in your repo (Symbol linking). 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.

Copy link

Hello!

I found the following issues in your plugin submission

Errors:

❌ Plugin name mismatch, the name in this PR (Symbol Linking) is not the same as the one in your repo (Symbol linking). 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.

@github-actions github-actions bot changed the title Symbol linking Add plugin: Symbol linking Jan 27, 2025
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.

@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][4][5][6][7][8][9][10]: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.

[1][2][3][4]:We recommend against providing a default hotkey when possible. The reason being that it's easy to pick a hotkey that a user already has configured and they could get confused when that key doesn't do what they expect. Also, it's hard choosing a safe default hotkey that's available for all operating systems.

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

[1]:Obsidian's configuration directory isn't necessarily .obsidian, it can be configured by the user. You can access the configured value from Vault#configDir


Optional

[1][2][3][4][5][6][7][8][9][10][11][12]: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 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 29, 2025
@Mara-Li
Copy link
Contributor Author

Mara-Li commented Jan 29, 2025

/skip

  1. I don't think it's a good idea to set the style in a styles.css, as we mimic the behavior of the suggester. It could lead to some errors. More over, style are cast for positioning, and use default variable provided by obsidian for the selection.
  2. Same as above, the default hotkey is provided to mimic the Obsidian behavior.
  3. Fixed
  4. Fixed
  5. I could change the any if I know the type ? It's from the original plugin.

@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 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Additional review required PR needs to be reviewed by another person, after the currently requested changes have been made Changes requested plugin 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