Skip to content

script-utils/linters/eslint-rules/manifest-id

ESLint rule: manifest-id

Enforces the Community directory’s constraints on a plugin’s manifest.json id: lowercase letters, digits and hyphens only; never containing obsidian; never ending with plugin.

A published id can never be changed, so a violation in an already-listed plugin is permanent and the only remedy is turning this rule off for that repo with the reason written beside it.

Runs on the @eslint/json json/json language; see manifest-helpers.ts for why the AST is Momoa rather than ESTree.

VariableDescription
manifestIdESLint rule enforcing the Community directory’s constraints on a plugin’s manifest.json id.
MESSAGE_ID_CONTAINS_OBSIDIANMessage ID reported when the id contains obsidian.
MESSAGE_ID_ENDS_WITH_PLUGINMessage ID reported when the id ends with plugin.
MESSAGE_ID_INVALID_CHARACTERSMessage ID reported when the id holds characters other than lowercase letters, digits and hyphens.