obsidianmd / obsidianmd/obsidian-developer-docs

Add a page on validating a plugin locally before submission

Open Beginner friendly
#252 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
521
Forks
174
PR merge metrics
No merged PRs in 30d

Description

Problem

Many of the checks a plugin goes through during review are automated: manifest.json and submission-requirement validation, and linting with eslint-plugin-obsidianmd. Today there's no page in the docs that explains how an author can run these checks locally before submitting. Authors typically find out about mechanical issues only after a review round-trip, or (worse) after release if something later trips a policy check.

Proposal

Add a "Validate your plugin locally" page under Plugins > Releasing that walks through validating a plugin locally, using the community obsidian-plugin-validator CLI via npx. It would cover:

  • What the automated checks are (manifest/submission checks + eslint-plugin-obsidianmd)
  • Running the validator with npx, or as a dev dependency / npm script
  • The available options and exit codes (for CI use)
  • A note that passing locally speeds up review but doesn't guarantee acceptance,
    linking to [[Submission requirements for plugins]] and [[Plugin guidelines]]

Happy to open the PR (page is already drafted) if this is something you'd like added.

Would you accept this?

Wanted to check first per the contributing guidelines before submitting a PR.

Disclaimer

This is my own npm package, so it's a bit of self-promotion, so I wanted to check/ask before putting up the PR - but, this is an issue I ran into and is on the forums too

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the drafted page at en/Plugins/Releasing/Validate your plugin locally.md and verify its npx usage, options, and exit codes against the obsidian-plugin-validator CLI. Ensure it explains manifest and submission checks, eslint-plugin-obsidianmd, and CI usage, with links to Submission requirements for plugins and Plugin guidelines; done when the page is complete and accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
85/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.