Add plugin: Header Counter

[nancyel]

I am submitting a new Community Plugin

Repo URL

Link to my plugin: https://github.com/nancyel/header-counter

Release Checklist

• I have tested the plugin on
  • Windows
  • macOS
  • Linux
  • Android (if applicable)
  • iOS (if applicable)
• My GitHub release contains all required files
  • 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:

❌ Could not parse community-plugins.json, invalid JSON. Unexpected token } in JSON at position 426479

---

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

The automated review has not found any issues with your code, assigning human for additional review.

[github-actions]

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: rooyca/query-json. 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]

this.addRibbonIcon("dice", "Header Counter", () => {
Use a different icon: https://docs.obsidian.md/Plugins/User+interface/Icons

// If the plugin hooks up any global DOM events (on parts of the app that doesn't belong to this plugin)
Remove the sample plugin code you don't need.

name: "Count Headers",, name: "Compute Header Summary",, contentEl.createEl("h2", { text: "Enter Header Level (1-6)" });, .setName("Default Header Level")
Use sentence case in UI

if (checking) {, if (checking) {
The checks here serve no purpose, you should check the condititions instead of using using the notices here: new Notice("Active view is not a Markdown view.");, new Notice("No active leaf found.");, new Notice("No active leaf found.");, new Notice("Active view is not a Markdown view.");

const activeLeaf = this.app.workspace.getLeaf();, const activeLeaf = this.app.workspace.getLeaf();
This should be a call to this.app.workspace.getActiveViewOfType(MarkdownView) instead.

containerEl.createEl("h2", { text: "General Settings" });
Don't use a "general" heading in your settings

[github-actions]

Hello!

I found the following issues in your plugin submission

Errors:

❌ Your latest Release is missing the main.js file.
❌ Your latest Release is missing the manifest.json file.

---

^{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.}

[nancyel]

Thanks for the detailed feedback! The code has been updated

[joethei]

showRibbonIcon: boolean;, showRibbonIcon: true,, if (this.settings.showRibbonIcon) {, new Setting(this.containerEl)
As of v1.1.0 of Obsidian, the ribbon can be customized within Obsidian. So users can choose what items to include and in what order all in one place. Because of this, we're recommending that new plugins avoid introducing their own toggles for ribbon items.

if (checking) {, if (checking) {
This code is still useless, better would be:

const view = this.app.workspace.getActiveViewOfType(MarkdownView);
if (checking) {
	return !!view;
}

And then pass that view reference into the function below.

if (!(view instanceof MarkdownView)) {, if (!(view instanceof MarkdownView)) {
This also serves no purpose, it's already guaranteed to be a MarkdownView because of the line above.

new Notice(Header Summary: ${JSON.stringify(headerSummary)});
Use sentence case in UI

this.containerEl.createEl("h2", { text: "Settings" });
Please don't use a settings header line this, see the guidelines: Only use headings under settings if you have more than one section.

[nancyel]

Thanks again for the feedback with links! Changes have been made.

[joethei]

const view = this.app.workspace.getActiveViewOfType(, const view = this.app.workspace.getActiveViewOfType(
As mentioned before, you should pass in the view instance you have from the command instead of retrieving it here.

new Setting(this.containerEl).setName("Header counter").setHeading();
I also mentioned twice already that there should not be a header here.
Don't include a header with the plugin name in the settings