fix: properly scope rules to file types

saberzero1 · saberzero1 · commit b432677ff845 · 2026-06-02T20:48:40.000+02:00
- Split rule configurations into base (JS/TS) and type-checked (TS-only)
- Separate package.json checks from main configuration
- Add stubs for react and svelte configs
- Regenerated documentation
diff --git a/README.md b/README.md
@@ -30,6 +30,7 @@ import obsidianmd from "eslint-plugin-obsidianmd";
 
 export default defineConfig([
   ...obsidianmd.configs.recommended,
+  ...obsidianmd.configs.packageJson,
   {
     files: ["**/*.ts"],
     languageOptions: {
@@ -82,8 +83,11 @@ You can also override or add rules:
 
 |      | Name                       |
 | :--- | :------------------------- |
+|      | `packageJson`              |
+| ⚛️   | `react`                    |
 | ✅    | `recommended`              |
 | 🇬🇧 | `recommendedWithLocalesEn` |
+| 🔥   | `svelte`                   |
 
 <!-- end auto-generated configs list -->
 
@@ -160,6 +164,7 @@ import obsidianmd from "eslint-plugin-obsidianmd";
 
 export default defineConfig([
   ...obsidianmd.configs.recommended,
+  ...obsidianmd.configs.packageJson,
   // Or include English locale files (JSON and TS/JS modules)
   // ...obsidianmd.configs.recommendedWithLocalesEn,
 
diff --git a/docs/rules/commands/no-command-in-command-id.md b/docs/rules/commands/no-command-in-command-id.md
@@ -2,6 +2,6 @@
 
 📝 Disallow using the word 'command' in a command ID.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/commands/no-command-in-command-name.md b/docs/rules/commands/no-command-in-command-name.md
@@ -2,6 +2,6 @@
 
 📝 Disallow using the word 'command' in a command name.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/commands/no-default-hotkeys.md b/docs/rules/commands/no-default-hotkeys.md
@@ -2,6 +2,6 @@
 
 📝 Discourage providing default hotkeys for commands.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/commands/no-plugin-id-in-command-id.md b/docs/rules/commands/no-plugin-id-in-command-id.md
@@ -2,7 +2,7 @@
 
 📝 Disallow including the plugin ID in a command ID.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/commands/no-plugin-name-in-command-name.md b/docs/rules/commands/no-plugin-name-in-command-name.md
@@ -2,7 +2,7 @@
 
 📝 Disallow including the plugin name in a command name.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/detach-leaves.md b/docs/rules/detach-leaves.md
@@ -2,7 +2,7 @@
 
 📝 Don't detach leaves in onunload.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
diff --git a/docs/rules/editor-drop-paste.md b/docs/rules/editor-drop-paste.md
@@ -2,6 +2,6 @@
 
 📝 Require checking `evt.defaultPrevented` and calling `evt.preventDefault()` in editor-drop/editor-paste handlers.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/hardcoded-config-path.md b/docs/rules/hardcoded-config-path.md
@@ -2,6 +2,6 @@
 
 📝 Test.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/no-forbidden-elements.md b/docs/rules/no-forbidden-elements.md
@@ -2,6 +2,6 @@
 
 📝 Disallow attachment of forbidden elements to the DOM in Obsidian plugins.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/no-global-this.md b/docs/rules/no-global-this.md
@@ -2,8 +2,6 @@
 
 📝 Disallow `global` and `globalThis`. Use `window` or `activeWindow` for popout window compatibility.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
-
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/no-nodejs-modules.md b/docs/rules/no-nodejs-modules.md
@@ -2,6 +2,6 @@
 
 📝 Disallow importing Node.js built-in modules unless guarded by Platform.isDesktop.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/no-plugin-as-component.md b/docs/rules/no-plugin-as-component.md
@@ -2,6 +2,6 @@
 
 📝 Disallow anti-patterns when passing a component to MarkdownRenderer.render to prevent memory leaks.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/no-sample-code.md b/docs/rules/no-sample-code.md
@@ -2,7 +2,7 @@
 
 📝 Disallow sample code snippets from the Obsidian plugin template.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
diff --git a/docs/rules/no-static-styles-assignment.md b/docs/rules/no-static-styles-assignment.md
@@ -2,6 +2,6 @@
 
 📝 Disallow setting styles directly on DOM elements, favoring CSS classes instead.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/no-tfile-tfolder-cast.md b/docs/rules/no-tfile-tfolder-cast.md
@@ -2,6 +2,6 @@
 
 📝 Disallow type casting to TFile or TFolder, suggesting instanceof checks instead.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/no-unsupported-api.md b/docs/rules/no-unsupported-api.md
@@ -2,7 +2,7 @@
 
 📝 Disallow usage of Obsidian APIs not available in the plugin's minimum app version.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-view-references-in-plugin.md b/docs/rules/no-view-references-in-plugin.md
@@ -2,6 +2,6 @@
 
 📝 Disallow storing references to custom views directly in the plugin, which can cause memory leaks.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/object-assign.md b/docs/rules/object-assign.md
@@ -2,6 +2,6 @@
 
 📝 Discourage using `Object.assign` with two arguments.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/platform.md b/docs/rules/platform.md
@@ -2,6 +2,6 @@
 
 📝 Disallow use of navigator API for OS detection.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/prefer-abstract-input-suggest.md b/docs/rules/prefer-abstract-input-suggest.md
@@ -2,6 +2,6 @@
 
 📝 Disallow Liam's frequently copied `TextInputSuggest` implementation in favor of the built-in `AbstractInputSuggest`.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/prefer-active-doc.md b/docs/rules/prefer-active-doc.md
@@ -2,6 +2,6 @@
 
 📝 Prefer `activeDocument` over `document` for popout window compatibility.
 
-⚠️ This rule _warns_ in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+🚫 This rule is _disabled_ in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/prefer-create-el.md b/docs/rules/prefer-create-el.md
@@ -2,7 +2,7 @@
 
 📝 Prefer Obsidian DOM helpers (`createEl`, `createDiv`, `createSpan`, `createSvg`, `createFragment`) over native DOM methods.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
diff --git a/docs/rules/prefer-file-manager-trash-file.md b/docs/rules/prefer-file-manager-trash-file.md
@@ -2,6 +2,6 @@
 
 📝 Prefer FileManager.trashFile() over Vault.trash() or Vault.delete() to respect user settings.
 
-⚠️ This rule _warns_ in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+⚠️ This rule _warns_ in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/prefer-get-language.md b/docs/rules/prefer-get-language.md
@@ -2,6 +2,6 @@
 
 📝 Prefer Obsidian's `getLanguage()` over `localStorage.getItem('language')` and `i18next-browser-languagedetector` for detecting the user's language.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/prefer-instanceof.md b/docs/rules/prefer-instanceof.md
@@ -2,7 +2,7 @@
 
 📝 Prefer `.instanceOf(T)` over `instanceof T` for cross-window safe type checks on DOM Nodes and UIEvents.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
diff --git a/docs/rules/prefer-window-timers.md b/docs/rules/prefer-window-timers.md
@@ -2,8 +2,6 @@
 
 📝 Prefer `window.setTimeout()` and related timer functions over bare global calls for popout window compatibility.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
-
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/regex-lookbehind.md b/docs/rules/regex-lookbehind.md
@@ -2,7 +2,7 @@
 
 📝 Using lookbehinds in Regex is not supported in some iOS versions.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/rule-custom-message.md b/docs/rules/rule-custom-message.md
@@ -2,7 +2,7 @@
 
 📝 Allows redefining error messages from other ESLint rules that don't provide this functionality natively.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/sample-names.md b/docs/rules/sample-names.md
@@ -2,6 +2,6 @@
 
 📝 Rename sample plugin class names.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/settings-tab/no-manual-html-headings.md b/docs/rules/settings-tab/no-manual-html-headings.md
@@ -2,7 +2,7 @@
 
 📝 Disallow using HTML heading elements for settings headings.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
diff --git a/docs/rules/settings-tab/no-problematic-settings-headings.md b/docs/rules/settings-tab/no-problematic-settings-headings.md
@@ -2,7 +2,7 @@
 
 📝 Discourage anti-patterns in settings headings.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
diff --git a/docs/rules/ui/sentence-case.md b/docs/rules/ui/sentence-case.md
@@ -2,7 +2,7 @@
 
 📝 Enforce sentence case for UI strings.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
diff --git a/docs/rules/validate-license.md b/docs/rules/validate-license.md
@@ -2,7 +2,7 @@
 
 📝 Validate the structure of copyright notices in LICENSE files for Obsidian plugins.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/validate-manifest.md b/docs/rules/validate-manifest.md
@@ -2,6 +2,6 @@
 
 📝 Validate the structure of manifest.json for Obsidian plugins.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 <!-- end auto-generated rule header -->
diff --git a/docs/rules/vault/iterate.md b/docs/rules/vault/iterate.md
@@ -2,7 +2,7 @@
 
 📝 Avoid iterating all files to find a file by its path.
 
-💼 This rule is enabled in the following configs: ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`.
+💼 This rule is enabled in the following configs: `react`, ✅ `recommended`, 🇬🇧 `recommendedWithLocalesEn`, `svelte`.
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -1,16 +1,16 @@
 import obsidianmd from "./dist/lib/index.js";
 
 export default [
-    obsidianmd.configs.all,
-    {
-        files: ["**/*.ts"],
-        languageOptions: {
-            parser: (await import("@typescript-eslint/parser")).default,
-            ecmaVersion: 2020,
-            sourceType: "module",
-            parserOptions: {
-                project: "./tsconfig.json",
-            },
-        },
-    },
+	...obsidianmd.configs.recommended,
+	{
+		files: ["**/*.ts"],
+		languageOptions: {
+			parser: (await import("@typescript-eslint/parser")).default,
+			ecmaVersion: 2020,
+			sourceType: "module",
+			parserOptions: {
+				project: "./tsconfig.json",
+			},
+		},
+	},
 ];
diff --git a/index.d.ts b/index.d.ts
@@ -8,6 +8,9 @@ declare module 'eslint-plugin-obsidianmd' {
     export const configs: {
         recommended: Linter.Config;
         recommendedWithLocalesEn: Linter.Config;
+        packageJson: Linter.Config;
+        react: Linter.Config;
+        svelte: Linter.Config;
     };
     export const rules: {
         [key: string]: Rule.RuleModule;
diff --git a/lib/index.ts b/lib/index.ts
diff --git a/lib/shim.d.ts b/lib/shim.d.ts
