docs: Create a shared settings document (mysticatea#115)

ota-meshi · Sep 25, 2023 · 7d855e6 · 7d855e6
1 parent 150b34f
commit 7d855e6
Show file tree

Hide file tree

Showing 11 changed files with 298 additions and 621 deletions.
diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js
@@ -10,6 +10,7 @@ const config = {
         ["flat/recommended", "☑️"],
         ["flat/mixed-esm-and-cjs", "🟠"],
     ],
+    ruleDocSectionOptions: false,
 }
 
 module.exports = config
diff --git a/docs/rules/file-extension-in-import.md b/docs/rules/file-extension-in-import.md
@@ -92,39 +92,15 @@ import logo from "./logo.png"
 
 ### Shared Settings
 
-The following options can be set by [shared settings](http://eslint.org/docs/user-guide/configuring.html#adding-shared-settings).
-Several rules have the same option, but we can set this option at once.
+#### tsconfigPath
 
-#### typescriptExtensionMap
-
-Adds the ability to change the extension mapping when converting between typescript and javascript
-
-You can also use the [typescript compiler jsx options](https://www.typescriptlang.org/tsconfig#jsx) to automatically use the correct mapping.
+This can be configured in the shared settings [`settings.tsconfigPath`](../shared-settings.md#tsconfigpath).
+Please see the shared settings documentation for more information.
 
-If this option is left undefined we:
-
-1. Check your `tsconfig.json` `compilerOptions.jsx`
-2. Return the default mapping (jsx = `preserve`)
+#### typescriptExtensionMap
 
-```js
-// .eslintrc.js
-module.exports = {
-    "settings": {
-        "node": {
-            "typescriptExtensionMap": [
-                [ "", ".js" ],
-                [ ".ts", ".js" ],
-                [ ".cts", ".cjs" ],
-                [ ".mts", ".mjs" ],
-                [ ".tsx", ".jsx" ],
-            ]
-        }
-    },
-    "rules": {
-        "n/file-extension-in-import": "error"
-    }
-}
-```
+This can be configured in the shared settings [`settings.typescriptExtensionMap`](../shared-settings.md#typescriptextensionmap).
+Please see the shared settings documentation for more information.
 
 ## 🔎 Implementation
 

diff --git a/docs/rules/no-extraneous-import.md b/docs/rules/no-extraneous-import.md
@@ -26,57 +26,18 @@ This rule warns `import` declarations of extraneous modules.
 
 #### allowModules
 
-Some platforms have additional embedded modules.
-For example, Electron has `electron` module.
-
-We can specify additional embedded modules with this option.
-This option is an array of strings as module names.
-
-```json
-{
-    "rules": {
-        "n/no-extraneous-import": ["error", {
-            "allowModules": ["electron"]
-        }]
-    }
-}
-```
+This can be configured in the rule options or as a shared setting [`settings.allowModules`](../shared-settings.md#allowmodules).
+Please see the shared settings documentation for more information.
 
 #### resolvePaths
 
-Adds additional paths to try for when resolving imports.
-If a path is relative, it will be resolved from CWD.
-
-Default is `[]`
+This can be configured in the rule options or as a shared setting [`settings.resolvePaths`](../shared-settings.md#resolvepaths).
+Please see the shared settings documentation for more information.
 
 #### convertPath
 
-- `exclude`: TODO
-- `include`: TODO
-- `replace`: TODO
-
-### Shared Settings
-
-The following options can be set by [shared settings](http://eslint.org/docs/user-guide/configuring.html#adding-shared-settings).
-Several rules have the same option, but we can set this option at once.
-
-- `allowModules`
-- `resolvePaths`
-
-```js
-// .eslintrc.js
-module.exports = {
-    "settings": {
-        "node": {
-            "allowModules": ["electron"],
-            "resolvePaths": [__dirname],
-        }
-    },
-    "rules": {
-        "n/no-extraneous-import": "error"
-    }
-}
-```
+This can be configured in the rule options or as a shared setting [`settings.convertPath`](../shared-settings.md#convertpath).
+Please see the shared settings documentation for more information.
 
 ## 🔎 Implementation
 

diff --git a/docs/rules/no-extraneous-require.md b/docs/rules/no-extraneous-require.md
@@ -27,66 +27,23 @@ This rule warns `require()` of extraneous modules.
 
 #### allowModules
 
-Some platforms have additional embedded modules.
-For example, Electron has `electron` module.
-
-We can specify additional embedded modules with this option.
-This option is an array of strings as module names.
-
-```json
-{
-    "rules": {
-        "n/no-extraneous-require": ["error", {
-            "allowModules": ["electron"]
-        }]
-    }
-}
-```
+This can be configured in the rule options or as a shared setting [`settings.allowModules`](../shared-settings.md#allowmodules).
+Please see the shared settings documentation for more information.
 
 #### resolvePaths
 
-Adds additional paths to try for when resolving imports.
-If a path is relative, it will be resolved from CWD.
+This can be configured in the rule options or as a shared setting [`settings.resolvePaths`](../shared-settings.md#resolvepaths).
+Please see the shared settings documentation for more information.
 
-Default is `[]`
-
-#### tryExtensions
-
-When an import path does not exist, this rule checks whether or not any of `path.js`, `path.json`, and `path.node` exists.
-`tryExtensions` option is the extension list this rule uses at the time.
+#### convertPath
 
-Default is `[".js", ".json", ".node"]`.
+This can be configured in the rule options or as a shared setting [`settings.convertPath`](../shared-settings.md#convertpath).
+Please see the shared settings documentation for more information.
 
-#### convertPath
+#### tryExtensions
 
-- `exclude`: TODO
-- `include`: TODO
-- `replace`: TODO
-
-### Shared Settings
-
-The following options can be set by [shared settings](http://eslint.org/docs/user-guide/configuring.html#adding-shared-settings).
-Several rules have the same option, but we can set this option at once.
-
-- `allowModules`
-- `resolvePaths`
-- `tryExtensions`
-
-```js
-// .eslintrc.js
-module.exports = {
-    "settings": {
-        "node": {
-            "allowModules": ["electron"],
-            "resolvePaths": [__dirname],
-            "tryExtensions": [".js", ".json", ".node"]
-        }
-    },
-    "rules": {
-        "n/no-extraneous-require": "error"
-    }
-}
-```
+This can be configured in the rule options or as a shared setting [`settings.tryExtensions`](../shared-settings.md#tryextensions).
+Please see the shared settings documentation for more information.
 
 ## 🔎 Implementation
 

diff --git a/docs/rules/no-missing-import.md b/docs/rules/no-missing-import.md
@@ -46,87 +46,23 @@ import existingModule from "existing-module";
 
 #### allowModules
 
-Some platforms have additional embedded modules.
-For example, Electron has `electron` module.
-
-We can specify additional embedded modules with this option.
-This option is an array of strings as module names.
-
-```json
-{
-    "rules": {
-        "n/no-missing-import": ["error", {
-            "allowModules": ["electron"]
-        }]
-    }
-}
-```
+This can be configured in the rule options or as a shared setting [`settings.allowModules`](../shared-settings.md#allowmodules).
+Please see the shared settings documentation for more information.
 
 #### resolvePaths
 
-Adds additional paths to try for when resolving imports.
-If a path is relative, it will be resolved from CWD.
-
-Default is `[]`
-
-#### typescriptExtensionMap
-
-Adds the ability to change the extension mapping when converting between typescript and javascript
-
-You can also use the [typescript compiler jsx options](https://www.typescriptlang.org/tsconfig#jsx) to automatically use the correct mapping.
-
-If this option is left undefined we:
-
-1. Check the Shared Settings
-2. Check your `tsconfig.json` `compilerOptions.jsx`
-3. Return the default mapping (jsx = `preserve`)
-
-Default is:
-
-```json
-[
-    [ "", ".js" ],
-    [ ".ts", ".js" ],
-    [ ".cts", ".cjs" ],
-    [ ".mts", ".mjs" ],
-    [ ".tsx", ".jsx" ],
-]
-```
+This can be configured in the rule options or as a shared setting [`settings.resolvePaths`](../shared-settings.md#resolvepaths).
+Please see the shared settings documentation for more information.
 
 #### tsconfigPath
 
-Adds the ability to specify the tsconfig used by the typescriptExtensionMap tool.
-
-### Shared Settings
+This can be configured in the rule options or as a shared setting [`settings.tsconfigPath`](../shared-settings.md#tsconfigpath).
+Please see the shared settings documentation for more information.
 
-The following options can be set by [shared settings](http://eslint.org/docs/user-guide/configuring.html#adding-shared-settings).
-Several rules have the same option, but we can set this option at once.
-
-- `allowModules`
-- `resolvePaths`
-- `typescriptExtensionMap`
+#### typescriptExtensionMap
 
-```js
-// .eslintrc.js
-module.exports = {
-    "settings": {
-        "node": {
-            "allowModules": ["electron"],
-            "resolvePaths": [__dirname],
-            "typescriptExtensionMap": [
-                [ "", ".js" ],
-                [ ".ts", ".js" ],
-                [ ".cts", ".cjs" ],
-                [ ".mts", ".mjs" ],
-                [ ".tsx", ".js" ],
-            ]
-        }
-    },
-    "rules": {
-        "n/no-missing-import": "error"
-    }
-}
-```
+This can be configured in the rule options or as a shared setting [`settings.typescriptExtensionMap`](../shared-settings.md#typescriptextensionmap).
+Please see the shared settings documentation for more information.
 
 ## 🔎 Implementation
 

diff --git a/docs/rules/no-missing-require.md b/docs/rules/no-missing-require.md
@@ -52,96 +52,28 @@ var foo = require(FOO_NAME);
 
 #### allowModules
 
-Some platforms have additional embedded modules.
-For example, Electron has `electron` module.
-
-We can specify additional embedded modules with this option.
-This option is an array of strings as module names.
-
-```json
-{
-    "rules": {
-        "n/no-missing-require": ["error", {
-            "allowModules": ["electron"]
-        }]
-    }
-}
-```
+This can be configured in the rule options or as a shared setting [`settings.allowModules`](../shared-settings.md#allowmodules).
+Please see the shared settings documentation for more information.
 
 #### resolvePaths
 
-Adds additional paths to try for when resolving a require.
-If a path is relative, it will be resolved from CWD.
-
-Default is `[]`
+This can be configured in the rule options or as a shared setting [`settings.resolvePaths`](../shared-settings.md#resolvepaths).
+Please see the shared settings documentation for more information.
 
 #### tryExtensions
 
-When an import path does not exist, this rule checks whether or not any of `path.js`, `path.json`, and `path.node` exists.
-`tryExtensions` option is the extension list this rule uses at the time.
-
-Default is `[".js", ".json", ".node"]`.
-
-#### typescriptExtensionMap
-
-Adds the ability to change the extension mapping when converting between typescript and javascript
-
-You can also use the [typescript compiler jsx options](https://www.typescriptlang.org/tsconfig#jsx) to automatically use the correct mapping.
-
-If this option is left undefined we:
-
-1. Check the Shared Settings
-2. Check your `tsconfig.json` `compilerOptions.jsx`
-3. Return the default mapping (jsx = `preserve`)
-
-Default is:
-
-```json
-[
-    [ "", ".js" ],
-    [ ".ts", ".js" ],
-    [ ".cts", ".cjs" ],
-    [ ".mts", ".mjs" ],
-    [ ".tsx", ".jsx" ],
-]
-```
+This can be configured in the rule options or as a shared setting [`settings.tryExtensions`](../shared-settings.md#tryextensions).
+Please see the shared settings documentation for more information.
 
 #### tsconfigPath
 
-Adds the ability to specify the tsconfig used by the typescriptExtensionMap tool.
-
-### Shared Settings
+This can be configured in the rule options or as a shared setting [`settings.tsconfigPath`](../shared-settings.md#tsconfigpath).
+Please see the shared settings documentation for more information.
 
-The following options can be set by [shared settings](http://eslint.org/docs/user-guide/configuring.html#adding-shared-settings).
-Several rules have the same option, but we can set this option at once.
-
-- `allowModules`
-- `resolvePaths`
-- `tryExtensions`
-- `typescriptExtensionMap`
+#### typescriptExtensionMap
 
-```js
-// .eslintrc.js
-module.exports = {
-    "settings": {
-        "node": {
-            "allowModules": ["electron"],
-            "resolvePaths": [__dirname],
-            "tryExtensions": [".js", ".json", ".node"],
-            "typescriptExtensionMap": [
-                [ "", ".js" ],
-                [ ".ts", ".js" ],
-                [ ".cts", ".cjs" ],
-                [ ".mts", ".mjs" ],
-                [ ".tsx", ".js" ],
-            ]
-        }
-    },
-    "rules": {
-        "n/no-missing-require": "error"
-    }
-}
-```
+This can be configured in the rule options or as a shared setting [`settings.typescriptExtensionMap`](../shared-settings.md#typescriptextensionmap).
+Please see the shared settings documentation for more information.
 
 ## 🔎 Implementation