Skip to content

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

ESLint rule: manifest-schema

Validates the structure of a plugin’s root manifest.json - the required keys, the keys the Community directory does not allow, duplicate keys, each value’s type, and the shape of fundingUrl.

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

VariableDescription
manifestSchemaESLint rule validating the structure of a plugin’s root manifest.json.
MESSAGE_ID_DISALLOWED_KEYMessage ID reported when a key the Community directory does not allow is present.
MESSAGE_ID_DUPLICATE_KEYMessage ID reported when the same key appears more than once.
MESSAGE_ID_EMPTY_FUNDING_URLMessage ID reported when fundingUrl is an empty string, an empty object, or an object with an empty value.
MESSAGE_ID_INVALID_FUNDING_URLMessage ID reported when a fundingUrl object holds a non-string value.
MESSAGE_ID_INVALID_TYPEMessage ID reported when a value has the wrong type.
MESSAGE_ID_MISSING_KEYMessage ID reported when a required key is missing.
MESSAGE_ID_MUST_BE_ROOT_OBJECTMessage ID reported when the manifest’s top-level value is not an object.