Skip to content

Commit 4447153

Browse files
author
Obsidian Bot
committed
chore: Update documentation
1 parent 57e37a9 commit 4447153

25 files changed

+29
-83
lines changed

‎README.md‎

Lines changed: 29 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,6 @@ You can also override or add rules:
7979
| | Name |
8080
| :--- | :------------------------- |
8181
| ✅ | `recommended` |
82-
| 🟦 | `recommendedTypeChecked` |
8382
| 🇬🇧 | `recommendedWithLocalesEn` |
8483

8584
<!-- end auto-generated configs list -->
@@ -90,42 +89,37 @@ You can also override or add rules:
9089

9190
<!-- begin auto-generated rules list -->
9291

93-
💼 Configurations enabled in.\
94-
⚠️ Configurations set to warn in.\
95-
✅ Set in the `recommended` configuration.\
96-
🟦 Set in the `recommendedTypeChecked` configuration.\
97-
🇬🇧 Set in the `recommendedWithLocalesEn` configuration.\
9892
🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
9993

100-
| Name                                          | Description | 💼 | ⚠️ | 🔧 |
101-
| :----------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------- | :-------- | :-------- | :- |
102-
| [commands/no-command-in-command-id](docs/rules/commands/no-command-in-command-id.md) | Disallow using the word 'command' in a command ID. | ✅ 🟦 🇬🇧 | | |
103-
| [commands/no-command-in-command-name](docs/rules/commands/no-command-in-command-name.md) | Disallow using the word 'command' in a command name. | ✅ 🟦 🇬🇧 | | |
104-
| [commands/no-default-hotkeys](docs/rules/commands/no-default-hotkeys.md) | Discourage providing default hotkeys for commands. | ✅ 🟦 🇬🇧 | | |
105-
| [commands/no-plugin-id-in-command-id](docs/rules/commands/no-plugin-id-in-command-id.md) | Disallow including the plugin ID in a command ID. | ✅ 🟦 🇬🇧 | | |
106-
| [commands/no-plugin-name-in-command-name](docs/rules/commands/no-plugin-name-in-command-name.md) | Disallow including the plugin name in a command name. | ✅ 🟦 🇬🇧 | | |
107-
| [detach-leaves](docs/rules/detach-leaves.md) | Don't detach leaves in onunload. | ✅ 🟦 🇬🇧 | | 🔧 |
108-
| [hardcoded-config-path](docs/rules/hardcoded-config-path.md) | test | ✅ 🟦 🇬🇧 | | |
109-
| [no-forbidden-elements](docs/rules/no-forbidden-elements.md) | Disallow attachment of forbidden elements to the DOM in Obsidian plugins. | ✅ 🟦 🇬🇧 | | |
110-
| [no-plugin-as-component](docs/rules/no-plugin-as-component.md) | Disallow anti-patterns when passing a component to MarkdownRenderer.render to prevent memory leaks. | ✅ 🟦 🇬🇧 | | |
111-
| [no-sample-code](docs/rules/no-sample-code.md) | Disallow sample code snippets from the Obsidian plugin template. | ✅ 🟦 🇬🇧 | | 🔧 |
112-
| [no-static-styles-assignment](docs/rules/no-static-styles-assignment.md) | Disallow setting styles directly on DOM elements, favoring CSS classes instead. | ✅ 🟦 🇬🇧 | | |
113-
| [no-tfile-tfolder-cast](docs/rules/no-tfile-tfolder-cast.md) | Disallow type casting to TFile or TFolder, suggesting instanceof checks instead. | ✅ 🟦 🇬🇧 | | |
114-
| [no-view-references-in-plugin](docs/rules/no-view-references-in-plugin.md) | Disallow storing references to custom views directly in the plugin, which can cause memory leaks. | ✅ 🟦 🇬🇧 | | |
115-
| [object-assign](docs/rules/object-assign.md) | Object.assign with two parameters instead of 3. | ✅ 🟦 🇬🇧 | | |
116-
| [platform](docs/rules/platform.md) | Disallow use of navigator API for OS detection | ✅ 🟦 🇬🇧 | | |
117-
| [prefer-abstract-input-suggest](docs/rules/prefer-abstract-input-suggest.md) | Disallow Liam's frequently copied `TextInputSuggest` implementation in favor of the built-in `AbstractInputSuggest`. | ✅ 🟦 🇬🇧 | | |
118-
| [prefer-file-manager-trash-file](docs/rules/prefer-file-manager-trash-file.md) | Prefer FileManager.trashFile() over Vault.trash() or Vault.delete() to respect user settings. | | ✅ 🟦 🇬🇧 | |
119-
| [regex-lookbehind](docs/rules/regex-lookbehind.md) | Using lookbehinds in Regex is not supported in some iOS versions | ✅ 🟦 🇬🇧 | | |
120-
| [sample-names](docs/rules/sample-names.md) | Rename sample plugin class names | ✅ 🟦 🇬🇧 | | |
121-
| [settings-tab/no-manual-html-headings](docs/rules/settings-tab/no-manual-html-headings.md) | Disallow using HTML heading elements for settings headings. | ✅ 🟦 🇬🇧 | | 🔧 |
122-
| [settings-tab/no-problematic-settings-headings](docs/rules/settings-tab/no-problematic-settings-headings.md) | Discourage anti-patterns in settings headings. | ✅ 🟦 🇬🇧 | | 🔧 |
123-
| [ui/sentence-case](docs/rules/ui/sentence-case.md) | Enforce sentence case for UI strings | ✅ 🟦 🇬🇧 | | 🔧 |
124-
| [ui/sentence-case-json](docs/rules/ui/sentence-case-json.md) | Enforce sentence case for English JSON locale strings | | | 🔧 |
125-
| [ui/sentence-case-locale-module](docs/rules/ui/sentence-case-locale-module.md) | Enforce sentence case for English TS/JS locale module strings | | | 🔧 |
126-
| [validate-license](docs/rules/validate-license.md) | Validate the structure of copyright notices in LICENSE files for Obsidian plugins. | | | |
127-
| [validate-manifest](docs/rules/validate-manifest.md) | Validate the structure of manifest.json for Obsidian plugins. | ✅ 🟦 🇬🇧 | | |
128-
| [vault/iterate](docs/rules/vault/iterate.md) | Avoid iterating all files to find a file by its path<br/> | ✅ 🟦 🇬🇧 | | 🔧 |
94+
| Name                                          | Description | 🔧 |
95+
| :----------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------- | :- |
96+
| [commands/no-command-in-command-id](docs/rules/commands/no-command-in-command-id.md) | Disallow using the word 'command' in a command ID. | |
97+
| [commands/no-command-in-command-name](docs/rules/commands/no-command-in-command-name.md) | Disallow using the word 'command' in a command name. | |
98+
| [commands/no-default-hotkeys](docs/rules/commands/no-default-hotkeys.md) | Discourage providing default hotkeys for commands. | |
99+
| [commands/no-plugin-id-in-command-id](docs/rules/commands/no-plugin-id-in-command-id.md) | Disallow including the plugin ID in a command ID. | |
100+
| [commands/no-plugin-name-in-command-name](docs/rules/commands/no-plugin-name-in-command-name.md) | Disallow including the plugin name in a command name. | |
101+
| [detach-leaves](docs/rules/detach-leaves.md) | Don't detach leaves in onunload. | 🔧 |
102+
| [hardcoded-config-path](docs/rules/hardcoded-config-path.md) | test | |
103+
| [no-forbidden-elements](docs/rules/no-forbidden-elements.md) | Disallow attachment of forbidden elements to the DOM in Obsidian plugins. | |
104+
| [no-plugin-as-component](docs/rules/no-plugin-as-component.md) | Disallow anti-patterns when passing a component to MarkdownRenderer.render to prevent memory leaks. | |
105+
| [no-sample-code](docs/rules/no-sample-code.md) | Disallow sample code snippets from the Obsidian plugin template. | 🔧 |
106+
| [no-static-styles-assignment](docs/rules/no-static-styles-assignment.md) | Disallow setting styles directly on DOM elements, favoring CSS classes instead. | |
107+
| [no-tfile-tfolder-cast](docs/rules/no-tfile-tfolder-cast.md) | Disallow type casting to TFile or TFolder, suggesting instanceof checks instead. | |
108+
| [no-view-references-in-plugin](docs/rules/no-view-references-in-plugin.md) | Disallow storing references to custom views directly in the plugin, which can cause memory leaks. | |
109+
| [object-assign](docs/rules/object-assign.md) | Object.assign with two parameters instead of 3. | |
110+
| [platform](docs/rules/platform.md) | Disallow use of navigator API for OS detection | |
111+
| [prefer-abstract-input-suggest](docs/rules/prefer-abstract-input-suggest.md) | Disallow Liam's frequently copied `TextInputSuggest` implementation in favor of the built-in `AbstractInputSuggest`. | |
112+
| [prefer-file-manager-trash-file](docs/rules/prefer-file-manager-trash-file.md) | Prefer FileManager.trashFile() over Vault.trash() or Vault.delete() to respect user settings. | |
113+
| [regex-lookbehind](docs/rules/regex-lookbehind.md) | Using lookbehinds in Regex is not supported in some iOS versions | |
114+
| [sample-names](docs/rules/sample-names.md) | Rename sample plugin class names | |
115+
| [settings-tab/no-manual-html-headings](docs/rules/settings-tab/no-manual-html-headings.md) | Disallow using HTML heading elements for settings headings. | 🔧 |
116+
| [settings-tab/no-problematic-settings-headings](docs/rules/settings-tab/no-problematic-settings-headings.md) | Discourage anti-patterns in settings headings. | 🔧 |
117+
| [ui/sentence-case](docs/rules/ui/sentence-case.md) | Enforce sentence case for UI strings | 🔧 |
118+
| [ui/sentence-case-json](docs/rules/ui/sentence-case-json.md) | Enforce sentence case for English JSON locale strings | 🔧 |
119+
| [ui/sentence-case-locale-module](docs/rules/ui/sentence-case-locale-module.md) | Enforce sentence case for English TS/JS locale module strings | 🔧 |
120+
| [validate-license](docs/rules/validate-license.md) | Validate the structure of copyright notices in LICENSE files for Obsidian plugins. | |
121+
| [validate-manifest](docs/rules/validate-manifest.md) | Validate the structure of manifest.json for Obsidian plugins. | |
122+
| [vault/iterate](docs/rules/vault/iterate.md) | Avoid iterating all files to find a file by its path<br/> | 🔧 |
129123

130124
<!-- end auto-generated rules list -->
131125

‎docs/rules/commands/no-command-in-command-id.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
# Disallow using the word 'command' in a command ID (`obsidianmd/commands/no-command-in-command-id`)
22

3-
💼 This rule is enabled in the following configs: ✅ `recommended`, 🟦 `recommendedTypeChecked`, 🇬🇧 `recommendedWithLocalesEn`.
4-
53
<!-- end auto-generated rule header -->

‎docs/rules/commands/no-command-in-command-name.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
# Disallow using the word 'command' in a command name (`obsidianmd/commands/no-command-in-command-name`)
22

3-
💼 This rule is enabled in the following configs: ✅ `recommended`, 🟦 `recommendedTypeChecked`, 🇬🇧 `recommendedWithLocalesEn`.
4-
53
<!-- end auto-generated rule header -->

‎docs/rules/commands/no-default-hotkeys.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
# Discourage providing default hotkeys for commands (`obsidianmd/commands/no-default-hotkeys`)
22

3-
💼 This rule is enabled in the following configs: ✅ `recommended`, 🟦 `recommendedTypeChecked`, 🇬🇧 `recommendedWithLocalesEn`.
4-
53
<!-- end auto-generated rule header -->

‎docs/rules/commands/no-plugin-id-in-command-id.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
# Disallow including the plugin ID in a command ID (`obsidianmd/commands/no-plugin-id-in-command-id`)
22

3-
💼 This rule is enabled in the following configs: ✅ `recommended`, 🟦 `recommendedTypeChecked`, 🇬🇧 `recommendedWithLocalesEn`.
4-
53
<!-- end auto-generated rule header -->

‎docs/rules/commands/no-plugin-name-in-command-name.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
# Disallow including the plugin name in a command name (`obsidianmd/commands/no-plugin-name-in-command-name`)
22

3-
💼 This rule is enabled in the following configs: ✅ `recommended`, 🟦 `recommendedTypeChecked`, 🇬🇧 `recommendedWithLocalesEn`.
4-
53
<!-- end auto-generated rule header -->

‎docs/rules/detach-leaves.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Don't detach leaves in onunload (`obsidianmd/detach-leaves`)
22

3-
💼 This rule is enabled in the following configs: ✅ `recommended`, 🟦 `recommendedTypeChecked`, 🇬🇧 `recommendedWithLocalesEn`.
4-
53
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
64

75
<!-- end auto-generated rule header -->

‎docs/rules/hardcoded-config-path.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
# Test (`obsidianmd/hardcoded-config-path`)
22

3-
💼 This rule is enabled in the following configs: ✅ `recommended`, 🟦 `recommendedTypeChecked`, 🇬🇧 `recommendedWithLocalesEn`.
4-
53
<!-- end auto-generated rule header -->

‎docs/rules/no-forbidden-elements.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
# Disallow attachment of forbidden elements to the DOM in Obsidian plugins (`obsidianmd/no-forbidden-elements`)
22

3-
💼 This rule is enabled in the following configs: ✅ `recommended`, 🟦 `recommendedTypeChecked`, 🇬🇧 `recommendedWithLocalesEn`.
4-
53
<!-- end auto-generated rule header -->

‎docs/rules/no-plugin-as-component.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
# Disallow anti-patterns when passing a component to MarkdownRenderer.render to prevent memory leaks (`obsidianmd/no-plugin-as-component`)
22

3-
💼 This rule is enabled in the following configs: ✅ `recommended`, 🟦 `recommendedTypeChecked`, 🇬🇧 `recommendedWithLocalesEn`.
4-
53
<!-- end auto-generated rule header -->

0 commit comments

Comments
 (0)