fix(validate-manifest): make the rule run, and stop it over-reporting

[mnaoumov]

No description provided.

[tgrosinger]

Directionally this looks good to me, but I'll defer to @saberzero1 for the actual code review.

[Copilot]

🟡 Changes recommended

lib/rules/validateManifest.ts currently passes an optional allowedWords[key] into a parameter typed as string[], which will fail TypeScript type-checking and should be coalesced to [].

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This PR fixes the validate-manifest rule so it actually runs on manifest.json (by configuring ESLint to parse it as strict JSON via @eslint/json), and tightens the rule’s behavior/options to reduce over-reporting and add targeted escape hatches.

Changes:

• Move obsidianmd/validate-manifest out of the JS/TS globbed rules and into a manifest.json-scoped flat-config block using language: "json/json".
• Refactor validateManifest to operate on @eslint/json’s Momoa AST and add rule options (allowedWords, ignore) plus expanded tests.
• Update docs and config tests to document/guard the file-scoped behavior.

File summaries

File	Description
tests/validateManifest.test.ts	Runs the rule under the JSON language and adds coverage for ignore/allowedWords and JSON-specific behavior.
tests/recommendedConfig.test.ts	Adds regression tests to ensure validate-manifest is enabled for manifest.json and not for source files.
README.md	Documents that recommended config lints non-source JSON files and requires running ESLint from project root.
lib/rules/validateManifest.ts	Reworks the rule to use @eslint/json AST, adds options/schema, and reduces false positives.
lib/index.ts	Adds a manifest.json-scoped flat-config block enabling validate-manifest under json/json.
eslint.config.mjs	Disables validate-manifest for this repo’s own manifest.json fixture.
docs/rules/validate-manifest.md	Documents new options and how to configure them in flat config.
docs/configuration.md	Documents that recommended config includes manifest.json linting and how file-scoped rules work.

Review details

Suppressed comments (1)

lib/rules/validateManifest.ts:340

• Same as above: allowedWords[key] can be undefined, which is not assignable to the string[] parameter type of hasForbiddenWords. Coalesce it to [] to satisfy the types.

                                    word: hasForbiddenWords(
                                        valueNode.value,
                                        allowedWords[key],
                                    )[1],
                                    key,

• Files reviewed: 8/8 changed files
• Comments generated: 1
• Review effort level: Lite

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[Copilot]

Copilot review overview

🔵 Needs a closer look

Address the validation gaps and documentation issues before approval.

Review effort: Lite
Findings: None

Resolved since last review (1)

• allowedWords[key] is optional (because allowedWords is a Partial<Record<...>>), so this call…

Previously missed (3)

In code that hasn't changed since last review

Reject regional-indicator and keycap emoji sequences

lib/​rules/​validateManifest.ts:37

This pattern does not reject every emoji: regional-indicator flags such as 🇺🇸 and keycap sequences such as 1️⃣ contain none of Extended_Pictographic, Cc, Cf, or Cs, so descriptions containing them pass despite the comment and tests saying emoji are forbidden. Include the regional-indicator and emoji selector characters (and keep a regression test) so the new allowlist does not let these sequences through.

Validate empty-string manifest keys

lib/​rules/​validateManifest.ts:249

The key && guard lets a valid JSON member with an empty-string key bypass the disallowed-key check. expectedType is then undefined, so { "": 1 } is silently ignored even though "" is not in the manifest schema; test Object.hasOwn unconditionally.

Import json in the plugin configuration example

docs/​configuration.md:313

This example refers to json in plugins but never imports it (the only import shown earlier is obsidianmd). Copying this configuration block therefore throws ReferenceError: json is not defined before ESLint can load it; add the required import json from "@eslint/json" to the example or explicitly document that prerequisite.

[mnaoumov]

Thanks, all three were real. Fixed in 88ad302, and the branch is rebased on master.

• Flags and keycaps: a flag is two regional indicators and a keycap is a digit plus U+FE0F and U+20E3, and none of those is Extended_Pictographic. The pattern now also matches \p{Regional_Indicator}, U+FE0F and U+20E3. I added tests for 🇺🇸 and 1️⃣, and checked that plain punctuation, accented letters and CJK text still pass.
• Empty-string key: dropped the key && guard, so "": 1 is now reported as a disallowed key. Added a test for it.
• json import: the snippet in docs/configuration.md now has import json from "@eslint/json". The snippet in docs/rules/validate-manifest.md had the same gap and imports both json and obsidianmd now.

I also ran it through ESLint itself with the documented config block, on a manifest with a flag in the description, a "" key and a constructor key. All three are reported.