chore: Update documentation

Obsidian Bot · Obsidian Bot · commit 8b0524f7de6e · 2025-10-23T07:25:53.000Z
diff --git a/README.md b/README.md
diff --git a/docs/rules/commands/no-command-in-command-id.md b/docs/rules/commands/no-command-in-command-id.md
@@ -0,0 +1,5 @@
+# Disallow using the word 'command' in a command ID (`obsidianmd/commands/no-command-in-command-id`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- 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
@@ -0,0 +1,5 @@
+# Disallow using the word 'command' in a command name (`obsidianmd/commands/no-command-in-command-name`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- end auto-generated rule header -->
diff --git a/docs/rules/commands/no-default-hotkeys.md b/docs/rules/commands/no-default-hotkeys.md
@@ -0,0 +1,5 @@
+# Discourage providing default hotkeys for commands (`obsidianmd/commands/no-default-hotkeys`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- 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
@@ -0,0 +1,5 @@
+# Disallow including the plugin ID in a command ID (`obsidianmd/commands/no-plugin-id-in-command-id`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- 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
@@ -0,0 +1,5 @@
+# Disallow including the plugin name in a command name (`obsidianmd/commands/no-plugin-name-in-command-name`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- end auto-generated rule header -->
diff --git a/docs/rules/detach-leaves.md b/docs/rules/detach-leaves.md
@@ -0,0 +1,7 @@
+# Don't detach leaves in onunload (`obsidianmd/detach-leaves`)
+
+💼 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/hardcoded-config-path.md b/docs/rules/hardcoded-config-path.md
@@ -0,0 +1,5 @@
+# Test (`obsidianmd/hardcoded-config-path`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- end auto-generated rule header -->
diff --git a/docs/rules/no-forbidden-elements.md b/docs/rules/no-forbidden-elements.md
@@ -0,0 +1,5 @@
+# Disallow attachment of forbidden elements to the DOM in Obsidian plugins (`obsidianmd/no-forbidden-elements`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- end auto-generated rule header -->
diff --git a/docs/rules/no-plugin-as-component.md b/docs/rules/no-plugin-as-component.md
@@ -0,0 +1,5 @@
+# Disallow anti-patterns when passing a component to MarkdownRenderer.render to prevent memory leaks (`obsidianmd/no-plugin-as-component`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- end auto-generated rule header -->
diff --git a/docs/rules/no-sample-code.md b/docs/rules/no-sample-code.md
@@ -0,0 +1,7 @@
+# Disallow sample code snippets from the Obsidian plugin template (`obsidianmd/no-sample-code`)
+
+💼 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-static-styles-assignment.md b/docs/rules/no-static-styles-assignment.md
@@ -0,0 +1,5 @@
+# Disallow setting styles directly on DOM elements, favoring CSS classes instead (`obsidianmd/no-static-styles-assignment`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- end auto-generated rule header -->
diff --git a/docs/rules/no-tfile-tfolder-cast.md b/docs/rules/no-tfile-tfolder-cast.md
@@ -0,0 +1,5 @@
+# Disallow type casting to TFile or TFolder, suggesting instanceof checks instead (`obsidianmd/no-tfile-tfolder-cast`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- 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
@@ -0,0 +1,5 @@
+# Disallow storing references to custom views directly in the plugin, which can cause memory leaks (`obsidianmd/no-view-references-in-plugin`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- end auto-generated rule header -->
diff --git a/docs/rules/object-assign.md b/docs/rules/object-assign.md
@@ -0,0 +1,5 @@
+# Object.assign with two parameters instead of 3 (`obsidianmd/object-assign`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- end auto-generated rule header -->
diff --git a/docs/rules/platform.md b/docs/rules/platform.md
@@ -0,0 +1,5 @@
+# Disallow use of navigator API for OS detection (`obsidianmd/platform`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- end auto-generated rule header -->
diff --git a/docs/rules/prefer-abstract-input-suggest.md b/docs/rules/prefer-abstract-input-suggest.md
@@ -0,0 +1,5 @@
+# Disallow Liam's frequently copied `TextInputSuggest` implementation in favor of the built-in `AbstractInputSuggest` (`obsidianmd/prefer-abstract-input-suggest`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- end auto-generated rule header -->
diff --git a/docs/rules/prefer-file-manager-trash-file.md b/docs/rules/prefer-file-manager-trash-file.md
@@ -0,0 +1,5 @@
+# Prefer FileManager.trashFile() over Vault.trash() or Vault.delete() to respect user settings (`obsidianmd/prefer-file-manager-trash-file`)
+
+⚠️ This rule _warns_ in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- end auto-generated rule header -->
diff --git a/docs/rules/regex-lookbehind.md b/docs/rules/regex-lookbehind.md
@@ -0,0 +1,5 @@
+# Using lookbehinds in Regex is not supported in some iOS versions (`obsidianmd/regex-lookbehind`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- end auto-generated rule header -->
diff --git a/docs/rules/sample-names.md b/docs/rules/sample-names.md
@@ -0,0 +1,5 @@
+# Rename sample plugin class names (`obsidianmd/sample-names`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- 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
@@ -0,0 +1,7 @@
+# Disallow using HTML heading elements for settings headings (`obsidianmd/settings-tab/no-manual-html-headings`)
+
+💼 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/settings-tab/no-problematic-settings-headings.md b/docs/rules/settings-tab/no-problematic-settings-headings.md
@@ -0,0 +1,7 @@
+# Discourage anti-patterns in settings headings (`obsidianmd/settings-tab/no-problematic-settings-headings`)
+
+💼 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/ui/sentence-case-json.md b/docs/rules/ui/sentence-case-json.md
@@ -0,0 +1,21 @@
+# Enforce sentence case for English JSON locale strings (`obsidianmd/ui/sentence-case-json`)
+
+🔧 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 -->
+
+## Options
+
+<!-- begin auto-generated rule options list -->
+
+| Name                    | Type     | Choices           |
+| :---------------------- | :------- | :---------------- |
+| `acronyms`              | String[] |                   |
+| `allowAutoFix`          | Boolean  |                   |
+| `brands`                | String[] |                   |
+| `enforceCamelCaseLower` | Boolean  |                   |
+| `ignoreRegex`           | String[] |                   |
+| `ignoreWords`           | String[] |                   |
+| `mode`                  | String   | `loose`, `strict` |
+
+<!-- end auto-generated rule options list -->
diff --git a/docs/rules/ui/sentence-case-locale-module.md b/docs/rules/ui/sentence-case-locale-module.md
@@ -0,0 +1,21 @@
+# Enforce sentence case for English TS/JS locale module strings (`obsidianmd/ui/sentence-case-locale-module`)
+
+🔧 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 -->
+
+## Options
+
+<!-- begin auto-generated rule options list -->
+
+| Name                    | Type     | Choices           |
+| :---------------------- | :------- | :---------------- |
+| `acronyms`              | String[] |                   |
+| `allowAutoFix`          | Boolean  |                   |
+| `brands`                | String[] |                   |
+| `enforceCamelCaseLower` | Boolean  |                   |
+| `ignoreRegex`           | String[] |                   |
+| `ignoreWords`           | String[] |                   |
+| `mode`                  | String   | `loose`, `strict` |
+
+<!-- end auto-generated rule options list -->
diff --git a/docs/rules/ui/sentence-case.md b/docs/rules/ui/sentence-case.md
@@ -0,0 +1,23 @@
+# Enforce sentence case for UI strings (`obsidianmd/ui/sentence-case`)
+
+⚠️ This rule _warns_ 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 -->
+
+## Options
+
+<!-- begin auto-generated rule options list -->
+
+| Name                    | Type     | Choices           |
+| :---------------------- | :------- | :---------------- |
+| `acronyms`              | String[] |                   |
+| `allowAutoFix`          | Boolean  |                   |
+| `brands`                | String[] |                   |
+| `enforceCamelCaseLower` | Boolean  |                   |
+| `ignoreRegex`           | String[] |                   |
+| `ignoreWords`           | String[] |                   |
+| `mode`                  | String   | `loose`, `strict` |
+
+<!-- end auto-generated rule options list -->
diff --git a/docs/rules/validate-license.md b/docs/rules/validate-license.md
@@ -0,0 +1,14 @@
+# Validate the structure of copyright notices in LICENSE files for Obsidian plugins (`obsidianmd/validate-license`)
+
+<!-- end auto-generated rule header -->
+
+## Options
+
+<!-- begin auto-generated rule options list -->
+
+| Name                   | Description                                        | Type    | Default |
+| :--------------------- | :------------------------------------------------- | :------ | :------ |
+| `currentYear`          | The current year to validate against.              | Number  |         |
+| `disableUnchangedYear` | If true, do not report errors for unchanged years. | Boolean | `false` |
+
+<!-- end auto-generated rule options list -->
diff --git a/docs/rules/validate-manifest.md b/docs/rules/validate-manifest.md
@@ -0,0 +1,5 @@
+# Validate the structure of manifest.json for Obsidian plugins (`obsidianmd/validate-manifest`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommendedWithLocalesEn`.
+
+<!-- end auto-generated rule header -->
diff --git a/docs/rules/vault/iterate.md b/docs/rules/vault/iterate.md
@@ -0,0 +1,8 @@
+# Avoid iterating all files to find a file by its path
+ (`obsidianmd/vault/iterate`)
+
+💼 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 -->
