fix: re-gen docs & fix n/recommended

eslint-community · Aug 28, 2023 · 3ae5ea7 · 3ae5ea7
1 parent 1c618ba
commit 3ae5ea7
Show file tree

Hide file tree

Showing 20 changed files with 78 additions and 73 deletions.
diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js
@@ -0,0 +1,12 @@
+"use strict"
+const config = {
+    urlConfigs: "https://github.com/eslint-community/eslint-plugin-n#-configs",
+    configEmoji: [
+        ["recommended-script", "✅"],
+        ["recommended-module", "✅"],
+        ["flat/recommended-script", "✅"],
+        ["flat/recommended-module", "✅"],
+    ],
+}
+
+module.exports = config
diff --git a/README.md b/README.md
diff --git a/docs/rules/no-deprecated-api.md b/docs/rules/no-deprecated-api.md
@@ -1,6 +1,6 @@
 # Disallow deprecated APIs (`n/no-deprecated-api`)
 
-💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): `flat/recommended-module`, `flat/recommended-script`.
+💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): ✅ `flat/recommended-module`, ✅ `flat/recommended-script`, ✅ `recommended`, ✅ `recommended-module`, ✅ `recommended-script`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-exports-assign.md b/docs/rules/no-exports-assign.md
@@ -1,6 +1,6 @@
 # Disallow the assignment to `exports` (`n/no-exports-assign`)
 
-💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): `flat/recommended-module`, `flat/recommended-script`.
+💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): ✅ `flat/recommended-module`, ✅ `flat/recommended-script`, ✅ `recommended`, ✅ `recommended-module`, ✅ `recommended-script`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-extraneous-import.md b/docs/rules/no-extraneous-import.md
@@ -1,6 +1,6 @@
 # Disallow `import` declarations which import extraneous modules (`n/no-extraneous-import`)
 
-💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): `flat/recommended-module`, `flat/recommended-script`.
+💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): ✅ `flat/recommended-module`, ✅ `flat/recommended-script`, ✅ `recommended`, ✅ `recommended-module`, ✅ `recommended-script`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-extraneous-require.md b/docs/rules/no-extraneous-require.md
@@ -1,6 +1,6 @@
 # Disallow `require()` expressions which import extraneous modules (`n/no-extraneous-require`)
 
-💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): `flat/recommended-module`, `flat/recommended-script`.
+💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): ✅ `flat/recommended-module`, ✅ `flat/recommended-script`, ✅ `recommended`, ✅ `recommended-module`, ✅ `recommended-script`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-missing-import.md b/docs/rules/no-missing-import.md
@@ -1,6 +1,6 @@
 # Disallow `import` declarations which import non-existence modules (`n/no-missing-import`)
 
-💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): `flat/recommended-module`, `flat/recommended-script`.
+💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): ✅ `flat/recommended-module`, ✅ `flat/recommended-script`, ✅ `recommended`, ✅ `recommended-module`, ✅ `recommended-script`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-missing-require.md b/docs/rules/no-missing-require.md
@@ -1,6 +1,6 @@
 # Disallow `require()` expressions which import non-existence modules (`n/no-missing-require`)
 
-💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): `flat/recommended-module`, `flat/recommended-script`.
+💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): ✅ `flat/recommended-module`, ✅ `flat/recommended-script`, ✅ `recommended`, ✅ `recommended-module`, ✅ `recommended-script`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-process-exit.md b/docs/rules/no-process-exit.md
@@ -1,6 +1,6 @@
 # Disallow the use of `process.exit()` (`n/no-process-exit`)
 
-💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): `flat/recommended-module`, `flat/recommended-script`.
+💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): ✅ `flat/recommended-module`, ✅ `flat/recommended-script`, ✅ `recommended`, ✅ `recommended-module`, ✅ `recommended-script`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-unpublished-bin.md b/docs/rules/no-unpublished-bin.md
@@ -1,6 +1,6 @@
 # Disallow `bin` files that npm ignores (`n/no-unpublished-bin`)
 
-💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): `flat/recommended-module`, `flat/recommended-script`.
+💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): ✅ `flat/recommended-module`, ✅ `flat/recommended-script`, ✅ `recommended`, ✅ `recommended-module`, ✅ `recommended-script`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-unpublished-import.md b/docs/rules/no-unpublished-import.md
@@ -1,6 +1,6 @@
 # Disallow `import` declarations which import private modules (`n/no-unpublished-import`)
 
-💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): `flat/recommended-module`, `flat/recommended-script`.
+💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): ✅ `flat/recommended-module`, ✅ `flat/recommended-script`, ✅ `recommended`, ✅ `recommended-module`, ✅ `recommended-script`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-unpublished-require.md b/docs/rules/no-unpublished-require.md
@@ -1,6 +1,6 @@
 # Disallow `require()` expressions which import private modules (`n/no-unpublished-require`)
 
-💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): `flat/recommended-module`, `flat/recommended-script`.
+💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): ✅ `flat/recommended-module`, ✅ `flat/recommended-script`, ✅ `recommended`, ✅ `recommended-module`, ✅ `recommended-script`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-unsupported-features/es-builtins.md b/docs/rules/no-unsupported-features/es-builtins.md
@@ -1,6 +1,6 @@
 # Disallow unsupported ECMAScript built-ins on the specified version (`n/no-unsupported-features/es-builtins`)
 
-💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): `flat/recommended-module`, `flat/recommended-script`.
+💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): ✅ `flat/recommended-module`, ✅ `flat/recommended-script`, ✅ `recommended`, ✅ `recommended-module`, ✅ `recommended-script`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-unsupported-features/es-syntax.md b/docs/rules/no-unsupported-features/es-syntax.md
@@ -1,6 +1,6 @@
 # Disallow unsupported ECMAScript syntax on the specified version (`n/no-unsupported-features/es-syntax`)
 
-💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): `flat/recommended-module`, `flat/recommended-script`.
+💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): ✅ `flat/recommended-module`, ✅ `flat/recommended-script`, ✅ `recommended`, ✅ `recommended-module`, ✅ `recommended-script`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-unsupported-features/node-builtins.md b/docs/rules/no-unsupported-features/node-builtins.md
@@ -1,6 +1,6 @@
 # Disallow unsupported Node.js built-in APIs on the specified version (`n/no-unsupported-features/node-builtins`)
 
-💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): `flat/recommended-module`, `flat/recommended-script`.
+💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): ✅ `flat/recommended-module`, ✅ `flat/recommended-script`, ✅ `recommended`, ✅ `recommended-module`, ✅ `recommended-script`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/process-exit-as-throw.md b/docs/rules/process-exit-as-throw.md
@@ -1,6 +1,6 @@
 # Require that `process.exit()` expressions use the same code path as `throw` (`n/process-exit-as-throw`)
 
-💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): `flat/recommended-module`, `flat/recommended-script`.
+💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): ✅ `flat/recommended-module`, ✅ `flat/recommended-script`, ✅ `recommended`, ✅ `recommended-module`, ✅ `recommended-script`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/shebang.md b/docs/rules/shebang.md
@@ -1,6 +1,6 @@
 # Require correct usage of shebang (`n/shebang`)
 
-💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): `flat/recommended-module`, `flat/recommended-script`.
+💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-n#-configs): ✅ `flat/recommended-module`, ✅ `flat/recommended-script`, ✅ `recommended`, ✅ `recommended-module`, ✅ `recommended-script`.
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 

diff --git a/lib/configs/recommended.js b/lib/configs/recommended.js
@@ -9,10 +9,10 @@ module.exports = () => {
     const isModule = (packageJson && packageJson.type) === "module"
 
     return {
-        ...(isModule ? moduleConfig : scriptConfig),
+        ...(isModule ? moduleConfig.eslintrc : scriptConfig.eslintrc),
         overrides: [
-            { files: ["*.cjs", ".*.cjs"], ...scriptConfig },
-            { files: ["*.mjs", ".*.mjs"], ...moduleConfig },
+            { files: ["*.cjs", ".*.cjs"], ...scriptConfig.eslintrc },
+            { files: ["*.mjs", ".*.mjs"], ...moduleConfig.eslintrc },
         ],
     }
 }
diff --git a/lib/index.js b/lib/index.js
@@ -68,7 +68,7 @@ mod.configs = {
         cjsConfigs.eslintrc
     ),
     get recommended() {
-        return require("./configs/recommended")()
+        return { plugins: ["n"], ...require("./configs/recommended")() }
     },
     "flat/recommended-module": Object.assign(
         { plugins: { n: mod } },

diff --git a/package.json b/package.json
@@ -68,7 +68,7 @@
         "test": "nyc npm run -s test:_mocha",
         "test:_mocha": "_mocha \"tests/lib/**/*.js\" --reporter progress --timeout 4000",
         "test:ci": "nyc npm run -s test:_mocha",
-        "update:eslint-docs": "eslint-doc-generator --config-emoji recommended-module,☑️ --config-emoji recommended-script,✔️ --rule-list-split meta.docs.category --ignore-config recommended-module --ignore-config recommended-script --url-configs \"https://github.com/eslint-community/eslint-plugin-n#-configs\"",
+        "update:eslint-docs": "eslint-doc-generator",
         "version": "npm run -s build && eslint lib/rules --fix && git add .",
         "watch": "npm run test:_mocha -- --watch --growl"
     },