Add plugin: Varinote

[gsarig]

I am submitting a new Community Plugin

Repo URL

Link to my plugin:

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.

[github-actions]

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.

---

^{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]

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

Required

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

---

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]

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

[Zachatoo]

Remade this comment below.

[Zachatoo]

While fixing the Modal display when switching notes was easy, I am not sure what's the best way to do it to prevent it when the vault opens.

You can use Workspace.onLayoutReady(). For example:

this.app.workspace.onLayoutReady(() => {
  this.registerEvent(this.app.vault.on('create', (file: TAbstractFile) => {
    this.handleFileCreate(file);
  }));
});

The process change you've made is correct, nice job!

[gsarig]

While fixing the Modal display when switching notes was easy, I am not sure what's the best way to do it to prevent it when the vault opens.

You can use Workspace.onLayoutReady(). For example:

this.app.workspace.onLayoutReady(() => {
  this.registerEvent(this.app.vault.on('create', (file: TAbstractFile) => {
    this.handleFileCreate(file);
  }));
});

Thanks @Zachatoo I've applied your suggested and now it is ready for a re-check.

[ObsidianReviewBot]

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

Required

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

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

[ObsidianReviewBot]

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

[ObsidianReviewBot]

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

---

Optional

[1]:Casting to any should be avoided as much as possible.

---

Do NOT open a new PR for re-validation.

[joethei]

Copyright (c) 2023 xRyul
Update this.

"description": "Add variables in Templates and set their values on-the-fly during the Note creation.",
Use sentence case in UI

export function createTooltip(container: HTMLElement, initialValue: number): HTMLElement {
The Obsidian API exports the setTooltip function for this purpose.

this.addSettingTab(new VarinoteSettings(this.app, this));
Your settings tab contains no actual settings, so it should not be added.

containerEl.createEl('p', {
For when you have settings:
Don't add a top-level heading / text in the settings tab, such as "General", "Settings", or the name of your plugin.

[gsarig]

Hi @joethei Thanks for the feedback. I've addressed the issues that you flagged, except for that one:

export function createTooltip(container: HTMLElement, initialValue: number): HTMLElement { The Obsidian API exports the setTooltip function for this purpose.

For that one, I already tried to use setDynamicTooltip a few weeks ago, but the problem was that I wanted to have the value always visible on a fixed position:

When I tried it, I noticed 2 problems for what I wanted to do:

1. setDynamicTooltip would append the tooltip on mouseover but would remove it on mouseout, so I couldn't keep it on a fixed position with CSS.
2. If I remember correctly (it's been a while since I tried it), even on mouseover, it wouldn't follow the slider, which would make more sense for the way that it was supposed to work.

The most important reason that I didn't go with it, though, was the first, as I wanted to show the value all the time.

Is this OK with you or should I try a different approach?