feat: add config "flat/all" (#401)

Author: aladdin-add

.eslint-doc-generatorrc.js

@@ -8,6 +8,7 @@ const config = {
         "flat/recommended-module",
         "flat/recommended",
         "flat/mixed-esm-and-cjs",
+        "flat/all",
     ],
     urlConfigs: "https://github.com/eslint-community/eslint-plugin-n#-configs",
     configEmoji: [

README.md

@@ -194,6 +194,7 @@ About each config:
 - `recommended`: Considers both CommonJS and ES Modules. If [`"type":"module"` field](https://medium.com/@nodejs/announcing-a-new-experimental-modules-1be8d2d6c2ff#b023) existed in package.json then it considers files as ES Modules. Otherwise it considers files as CommonJS. In addition, it considers `*.mjs` files as ES Modules and `*.cjs` files as CommonJS.
 - `recommended-module`: Considers all files as ES Modules.
 - `recommended-script`: Considers all files as CommonJS.
+- `flat/all`: enables all of the rules shipped with the package. This configuration is **not recommended** for production use because it may change with every minor and major version. Use at your own risk.
 
 These preset configs:
 

lib/all-rules.js

@@ -0,0 +1,55 @@
+/**
+ * @fileoverview All rules in the plugin.
+ * @author aladdin-add<[email protected]>
+ * TODO: maybe auto-generated in the future?
+ */
+"use strict"
+
+/** @import { Rule } from 'eslint' */
+
+/** @type {Record<string, Rule.RuleModule> } */
+module.exports = {
+    "callback-return": require("./rules/callback-return"),
+    "exports-style": require("./rules/exports-style"),
+    "file-extension-in-import": require("./rules/file-extension-in-import"),
+    "global-require": require("./rules/global-require"),
+    "handle-callback-err": require("./rules/handle-callback-err"),
+    "no-callback-literal": require("./rules/no-callback-literal"),
+    "no-deprecated-api": require("./rules/no-deprecated-api"),
+    "no-exports-assign": require("./rules/no-exports-assign"),
+    "no-extraneous-import": require("./rules/no-extraneous-import"),
+    "no-extraneous-require": require("./rules/no-extraneous-require"),
+    "no-missing-import": require("./rules/no-missing-import"),
+    "no-missing-require": require("./rules/no-missing-require"),
+    "no-mixed-requires": require("./rules/no-mixed-requires"),
+    "no-new-require": require("./rules/no-new-require"),
+    "no-path-concat": require("./rules/no-path-concat"),
+    "no-process-env": require("./rules/no-process-env"),
+    "no-process-exit": require("./rules/no-process-exit"),
+    "no-restricted-import": require("./rules/no-restricted-import"),
+    "no-restricted-require": require("./rules/no-restricted-require"),
+    "no-sync": require("./rules/no-sync"),
+    "no-top-level-await": require("./rules/no-top-level-await"),
+    "no-unpublished-bin": require("./rules/no-unpublished-bin"),
+    "no-unpublished-import": require("./rules/no-unpublished-import"),
+    "no-unpublished-require": require("./rules/no-unpublished-require"),
+    "no-unsupported-features/es-builtins": require("./rules/no-unsupported-features/es-builtins"),
+    "no-unsupported-features/es-syntax": require("./rules/no-unsupported-features/es-syntax"),
+    "no-unsupported-features/node-builtins": require("./rules/no-unsupported-features/node-builtins"),
+    "prefer-global/buffer": require("./rules/prefer-global/buffer"),
+    "prefer-global/console": require("./rules/prefer-global/console"),
+    "prefer-global/process": require("./rules/prefer-global/process"),
+    "prefer-global/text-decoder": require("./rules/prefer-global/text-decoder"),
+    "prefer-global/text-encoder": require("./rules/prefer-global/text-encoder"),
+    "prefer-global/url-search-params": require("./rules/prefer-global/url-search-params"),
+    "prefer-global/url": require("./rules/prefer-global/url"),
+    "prefer-node-protocol": require("./rules/prefer-node-protocol"),
+    "prefer-promises/dns": require("./rules/prefer-promises/dns"),
+    "prefer-promises/fs": require("./rules/prefer-promises/fs"),
+    "process-exit-as-throw": require("./rules/process-exit-as-throw"),
+    hashbang: require("./rules/hashbang"),
+
+    // Deprecated rules.
+    "no-hide-core-modules": require("./rules/no-hide-core-modules"),
+    shebang: require("./rules/shebang"),
+}

lib/configs/_commons.js

@@ -1,22 +1,24 @@
 "use strict"
 
-/**
- * @type {import('eslint').Linter.RulesRecord}
- */
-module.exports.commonRules = {
-    "n/no-deprecated-api": "error",
-    "n/no-extraneous-import": "error",
-    "n/no-extraneous-require": "error",
-    "n/no-exports-assign": "error",
-    "n/no-missing-import": "error",
-    "n/no-missing-require": "error",
-    "n/no-process-exit": "error",
-    "n/no-unpublished-bin": "error",
-    "n/no-unpublished-import": "error",
-    "n/no-unpublished-require": "error",
-    "n/no-unsupported-features/es-builtins": "error",
-    "n/no-unsupported-features/es-syntax": "error",
-    "n/no-unsupported-features/node-builtins": "error",
-    "n/process-exit-as-throw": "error",
-    "n/hashbang": "error",
+const rules = require("../all-rules")
+
+/** @type {import('eslint').Linter.RulesRecord} */
+const recommendeRulesConfig = {}
+
+/** @type {import('eslint').Linter.RulesRecord} */
+const allRulesConfig = {}
+
+for (const [ruleName, rule] of Object.entries(rules)) {
+    const scopedRuleName = `n/${ruleName}`
+    // only non-deprecated rules
+    if (rule.meta?.deprecated !== true) {
+        allRulesConfig[scopedRuleName] = "error"
+
+        if (rule.meta?.docs?.recommended === true) {
+            recommendeRulesConfig[scopedRuleName] = "error"
+        }
+    }
 }
+
+exports.recommendeRulesConfig = recommendeRulesConfig
+exports.allRulesConfig = allRulesConfig

lib/configs/all.js

@@ -0,0 +1,18 @@
+/**
+ * @fileoverview config for enabling all rules in the plugin.
+ * @author aladdin-add<[email protected]>SS
+ */
+"use strict"
+
+const { allRulesConfig } = require("./_commons")
+const recommendeConfig = require("./recommended")
+
+/**
+ * https://eslint.org/docs/latest/use/configure/configuration-files-new
+ * @type {import('eslint').Linter.FlatConfig}
+ */
+exports.flat = {
+    name: "node/flat/all",
+    languageOptions: recommendeConfig.flat.languageOptions ?? {},
+    rules: allRulesConfig,
+}

lib/configs/recommended-module.js

@@ -1,7 +1,7 @@
 "use strict"
 
 const globals = require("globals")
-const { commonRules } = require("./_commons")
+const { recommendeRulesConfig } = require("./_commons")
 
 /**
  * https://eslint.org/docs/latest/use/configure/configuration-files
@@ -25,7 +25,7 @@ module.exports.eslintrc = {
         sourceType: "module",
     },
     rules: {
-        ...commonRules,
+        ...recommendeRulesConfig,
         "n/no-unsupported-features/es-syntax": [
             "error",
             { ignores: ["modules"] },

lib/configs/recommended-script.js

@@ -1,7 +1,7 @@
 "use strict"
 
 const globals = require("globals")
-const { commonRules } = require("./_commons")
+const { recommendeRulesConfig } = require("./_commons")
 
 /**
  * https://eslint.org/docs/latest/use/configure/configuration-files
@@ -25,7 +25,7 @@ module.exports.eslintrc = {
         sourceType: "script",
     },
     rules: {
-        ...commonRules,
+        ...recommendeRulesConfig,
         "n/no-unsupported-features/es-syntax": ["error", { ignores: [] }],
     },
 }

lib/index.js

@@ -4,6 +4,8 @@ const pkg = require("../package.json")
 const esmConfig = require("./configs/recommended-module")
 const cjsConfig = require("./configs/recommended-script")
 const recommendedConfig = require("./configs/recommended")
+const allRulesConfig = require("./configs/all")
+const allRules = require("./all-rules")
 
 /** @import { ESLint, Linter } from 'eslint' */
 
@@ -13,51 +15,7 @@ const base = {
         name: pkg.name,
         version: pkg.version,
     },
-    rules: {
-        "callback-return": require("./rules/callback-return"),
-        "exports-style": require("./rules/exports-style"),
-        "file-extension-in-import": require("./rules/file-extension-in-import"),
-        "global-require": require("./rules/global-require"),
-        "handle-callback-err": require("./rules/handle-callback-err"),
-        "no-callback-literal": require("./rules/no-callback-literal"),
-        "no-deprecated-api": require("./rules/no-deprecated-api"),
-        "no-exports-assign": require("./rules/no-exports-assign"),
-        "no-extraneous-import": require("./rules/no-extraneous-import"),
-        "no-extraneous-require": require("./rules/no-extraneous-require"),
-        "no-missing-import": require("./rules/no-missing-import"),
-        "no-missing-require": require("./rules/no-missing-require"),
-        "no-mixed-requires": require("./rules/no-mixed-requires"),
-        "no-new-require": require("./rules/no-new-require"),
-        "no-path-concat": require("./rules/no-path-concat"),
-        "no-process-env": require("./rules/no-process-env"),
-        "no-process-exit": require("./rules/no-process-exit"),
-        "no-restricted-import": require("./rules/no-restricted-import"),
-        "no-restricted-require": require("./rules/no-restricted-require"),
-        "no-sync": require("./rules/no-sync"),
-        "no-top-level-await": require("./rules/no-top-level-await"),
-        "no-unpublished-bin": require("./rules/no-unpublished-bin"),
-        "no-unpublished-import": require("./rules/no-unpublished-import"),
-        "no-unpublished-require": require("./rules/no-unpublished-require"),
-        "no-unsupported-features/es-builtins": require("./rules/no-unsupported-features/es-builtins"),
-        "no-unsupported-features/es-syntax": require("./rules/no-unsupported-features/es-syntax"),
-        "no-unsupported-features/node-builtins": require("./rules/no-unsupported-features/node-builtins"),
-        "prefer-global/buffer": require("./rules/prefer-global/buffer"),
-        "prefer-global/console": require("./rules/prefer-global/console"),
-        "prefer-global/process": require("./rules/prefer-global/process"),
-        "prefer-global/text-decoder": require("./rules/prefer-global/text-decoder"),
-        "prefer-global/text-encoder": require("./rules/prefer-global/text-encoder"),
-        "prefer-global/url-search-params": require("./rules/prefer-global/url-search-params"),
-        "prefer-global/url": require("./rules/prefer-global/url"),
-        "prefer-node-protocol": require("./rules/prefer-node-protocol"),
-        "prefer-promises/dns": require("./rules/prefer-promises/dns"),
-        "prefer-promises/fs": require("./rules/prefer-promises/fs"),
-        "process-exit-as-throw": require("./rules/process-exit-as-throw"),
-        hashbang: require("./rules/hashbang"),
-
-        // Deprecated rules.
-        "no-hide-core-modules": require("./rules/no-hide-core-modules"),
-        shebang: require("./rules/shebang"),
-    },
+    rules: allRules,
 }
 /**
  * @typedef {{
@@ -68,6 +26,7 @@ const base = {
  *     'flat/recommended-script': Linter.Config;
  *     'flat/recommended': Linter.Config;
  *     'flat/mixed-esm-and-cjs': Linter.Config[];
+ *     'flat/all': Linter.Config;
  * }} Configs
  */
 
@@ -84,6 +43,7 @@ const configs = {
         { files: ["**/*.mjs"], plugins: { n: base }, ...esmConfig.flat },
         { files: ["**/*.cjs"], plugins: { n: base }, ...cjsConfig.flat },
     ],
+    "flat/all": { plugins: { n: base }, ...allRulesConfig.flat },
 }
 
 /** @type {ESLint.Plugin & { configs: Configs }} */

lib/rules/no-process-exit.js

@@ -17,7 +17,7 @@ module.exports = {
         type: "suggestion",
         docs: {
             description: "disallow the use of `process.exit()`",
-            recommended: false,
+            recommended: true,
             url: "https://github.com/eslint-community/eslint-plugin-n/blob/HEAD/docs/rules/no-process-exit.md",
         },
         fixable: null,

tests/lib/configs/flat.js

@@ -0,0 +1,31 @@
+"use strict"
+
+const assert = require("assert")
+const pkg = require("eslint-plugin-n")
+
+describe("flat configs", () => {
+    it("should correctly export the plugin", () => {
+        assert.strictEqual(typeof pkg, "object")
+        assert.strictEqual(pkg.meta.name, "eslint-plugin-n")
+        assert(pkg.configs)
+        assert(pkg.rules)
+    })
+
+    it("should export flat/recommended-module", () => {
+        const config = pkg.configs["flat/recommended-module"]
+        assert.strictEqual(config.plugins.n, pkg)
+        assert(config.rules, "should have rules configured")
+    })
+
+    it("should export flat/recommeded-script", () => {
+        const config = pkg.configs["flat/recommended-script"]
+        assert.strictEqual(config.plugins.n, pkg)
+        assert(config.rules, "should have rules configured")
+    })
+
+    it("should export flat/all", () => {
+        const config = pkg.configs["flat/all"]
+        assert.strictEqual(config.plugins.n, pkg)
+        assert(config.rules, "should have rules configured")
+    })
+})