eslint-plugin-n 17.23.2 → 18.0.0

package/README.md

@@ -20,68 +20,37 @@ npm install --save-dev eslint eslint-plugin-n
 
 | Version | Supported Node.js | Supported ESLint Version | Status |
 |---------|-------------------|---------------------------|--------|
+| 18.x   | `^20.19.0 \|\| ^22.13.0 \|\| >=24.0.0`  | `>=8.57.1`          | 🏃‍♂️actively maintained |
 | 17.x   | `^18.18.0 \|\| ^20.9.0 \|\| >=21.1.0`  | `>=8.23.0`          | 🏃‍♂️actively maintained |
 | 16.x   | `>=16.0.0`   | `>=7.0.0`          | ⚠️EOL |
 | 15.x   | `>=12.22.0`  | `>=7.0.0`          | ⚠️EOL |
 
 **Note:** It recommends a use of [the "engines" field of package.json](https://docs.npmjs.com/files/package.json#engines). The "engines" field is used by `n/no-unsupported-features/*` rules.
 
-### [`eslint.config.js`](https://eslint.org/docs/latest/use/configure/configuration-files-new) (requires eslint>=v8.23.0)
+### [`eslint.config.js`](https://eslint.org/docs/latest/use/configure/configuration-files)
 
 ```js
-const nodePlugin = require("eslint-plugin-n")
-
-module.exports = [
-    nodePlugin.configs["flat/recommended-script"],
-    {
-        rules: {
-            "n/exports-style": ["error", "module.exports"]
-        }
-    }
-]
+import node from "eslint-plugin-n"
+import {defineConfig} from "eslint/config"
+
+export default defineConfig([
+    plugins: {n: node},
+    extends: ["n/recommended-module"],
+])
 ```
 
 To setup without the recommended configs, you'll need to add the plugin:
 
 ```js
-const nodePlugin = require("eslint-plugin-n")
-
-module.exports = [
-    {
-        plugins: {n: nodePlugin},
-        rules: {
-            "n/exports-style": ["error", "module.exports"]
-        }
-    }
-]
-```
-
-### **[.eslintrc.json](https://eslint.org/docs/latest/use/configure/configuration-files)** (legacy example)
-
-```jsonc
-{
-    "extends": ["eslint:recommended", "plugin:n/recommended"],
-    "parserOptions": {
-        "ecmaVersion": 2021
-    },
-    "rules": {
-        "n/exports-style": ["error", "module.exports"]
-    }
-}
-```
-
-To setup without the recommended rules you'll need to add the plugin:
+import node from "eslint-plugin-n"
+import {defineConfig} from "eslint/config"
 
-```jsonc
-{
-    "parserOptions": {
-        "ecmaVersion": 2021
+export default defineConfig([
+    plugins: {n: node},
+    rules: {
+        "n/no-unsupported-features/es-builtins": "error",
     },
-    "plugins": ["n"],
-    "rules": {
-        "n/exports-style": ["error", "module.exports"]
-    }
-}
+])
 ```
 
 **package.json** (An example)
@@ -157,7 +126,7 @@ For [Shareable Configs](https://eslint.org/docs/latest/developer-guide/shareable
 | [no-restricted-require](docs/rules/no-restricted-require.md)                                 | disallow specified modules when loaded by `require`                         |      |    |    |
 | [no-sync](docs/rules/no-sync.md)                                                             | disallow synchronous methods                                                |      |    |    |
 | [no-top-level-await](docs/rules/no-top-level-await.md)                                       | disallow top-level `await` in published modules                             |      |    |    |
-| [no-unpublished-bin](docs/rules/no-unpublished-bin.md)                                       | disallow `bin` files that npm ignores                                       | 🟢 ✅ |    |    |
+| [no-unpublished-bin](docs/rules/no-unpublished-bin.md)                                       | disallow `bin` files that npm ignores                                       |      |    |    |
 | [no-unpublished-import](docs/rules/no-unpublished-import.md)                                 | disallow `import` declarations which import private modules                 | 🟢 ✅ |    |    |
 | [no-unpublished-require](docs/rules/no-unpublished-require.md)                               | disallow `require()` expressions which import private modules               | 🟢 ✅ |    |    |
 | [no-unsupported-features/es-builtins](docs/rules/no-unsupported-features/es-builtins.md)     | disallow unsupported ECMAScript built-ins on the specified version          | 🟢 ✅ |    |    |
@@ -165,9 +134,11 @@ For [Shareable Configs](https://eslint.org/docs/latest/developer-guide/shareable
 | [no-unsupported-features/node-builtins](docs/rules/no-unsupported-features/node-builtins.md) | disallow unsupported Node.js built-in APIs on the specified version         | 🟢 ✅ |    |    |
 | [prefer-global/buffer](docs/rules/prefer-global/buffer.md)                                   | enforce either `Buffer` or `require("buffer").Buffer`                       |      |    |    |
 | [prefer-global/console](docs/rules/prefer-global/console.md)                                 | enforce either `console` or `require("console")`                            |      |    |    |
+| [prefer-global/crypto](docs/rules/prefer-global/crypto.md)                                   | enforce either `crypto` or `require("crypto").webcrypto`                    |      |    |    |
 | [prefer-global/process](docs/rules/prefer-global/process.md)                                 | enforce either `process` or `require("process")`                            |      |    |    |
 | [prefer-global/text-decoder](docs/rules/prefer-global/text-decoder.md)                       | enforce either `TextDecoder` or `require("util").TextDecoder`               |      |    |    |
 | [prefer-global/text-encoder](docs/rules/prefer-global/text-encoder.md)                       | enforce either `TextEncoder` or `require("util").TextEncoder`               |      |    |    |
+| [prefer-global/timers](docs/rules/prefer-global/timers.md)                                   | enforce either global timer functions or `require("timers")`                |      |    |    |
 | [prefer-global/url](docs/rules/prefer-global/url.md)                                         | enforce either `URL` or `require("url").URL`                                |      |    |    |
 | [prefer-global/url-search-params](docs/rules/prefer-global/url-search-params.md)             | enforce either `URLSearchParams` or `require("url").URLSearchParams`        |      |    |    |
 | [prefer-node-protocol](docs/rules/prefer-node-protocol.md)                                   | enforce using the `node:` protocol when importing Node.js builtin modules.  |      | 🔧 |    |
@@ -191,10 +162,10 @@ For [Shareable Configs](https://eslint.org/docs/latest/developer-guide/shareable
 
 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.
+- `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.
+- `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:
 
@@ -209,20 +180,17 @@ These preset configs:
 - Q: The `no-missing-import` / `no-missing-require` rules don't work with nested folders in SublimeLinter-eslint
 - A: See [context.getFilename() in rule returns relative path](https://github.com/roadhump/SublimeLinter-eslint#contextgetfilename-in-rule-returns-relative-path) in the SublimeLinter-eslint FAQ.
 
-- Q: How to use the flat eslint config with mixed commonjs and es modules?
-- A: You can use the new exported flat config `flat/mixed-esm-and-cjs`, an example:
+- Q: How to use the eslint config with mixed commonjs and es modules?
+- A: You can use the new exported flat config `mixed-esm-and-cjs`, an example:
 
 ```js
-const nodePlugin = require("eslint-plugin-n");
+import node from "eslint-plugin-n"
+import {defineConfig} from "eslint/config"
 
-module.exports = [
-  ...nodePlugin.configs["flat/mixed-esm-and-cjs"],
-  {
-    rules: {
-      "n/exports-style": ["error", "module.exports"],
-    },
-  },
-]
+export default defineConfig([
+    plugins: {n: node},
+    extends: ["n/mixed-esm-and-cjs"],
+])
 ```
 
 ## 🚥 Semantic Versioning Policy

package/configs/recommended-module.js

@@ -4,6 +4,5 @@
  * @deprecated use `flat/recommended-module` instead
  */
 
-"use strict"
-
-module.exports = require("../lib/index.js").configs["flat/recommended-module"]
+import pkg from '../lib/index.js';
+export default pkg.configs["flat/recommended-module"]

package/configs/recommended-script.js

@@ -4,6 +4,6 @@
  * @deprecated use `flat/recommended-script` instead
  */
 
-"use strict"
 
-module.exports = require("../lib/index.js").configs["flat/recommended-script"]
+import pkg from '../lib/index.js';
+export default pkg.configs["flat/recommended-script"]

package/lib/all-rules.js

@@ -3,53 +3,96 @@
  * @author aladdin-add<weiran.zsd@outlook.com>
  * TODO: maybe auto-generated in the future?
  */
-"use strict"
 
-/** @import { Rule } from 'eslint' */
+import callbackReturn from "./rules/callback-return.js"
+import exportsStyle from "./rules/exports-style.js"
+import fileExtensionInImport from "./rules/file-extension-in-import.js"
+import globalRequire from "./rules/global-require.js"
+import handleCallbackErr from "./rules/handle-callback-err.js"
+import noCallbackLiteral from "./rules/no-callback-literal.js"
+import noDeprecatedApi from "./rules/no-deprecated-api.js"
+import noExportsAssign from "./rules/no-exports-assign.js"
+import noExtraneousImport from "./rules/no-extraneous-import.js"
+import noExtraneousRequire from "./rules/no-extraneous-require.js"
+import noMissingImport from "./rules/no-missing-import.js"
+import noMissingRequire from "./rules/no-missing-require.js"
+import noMixedRequires from "./rules/no-mixed-requires.js"
+import noNewRequire from "./rules/no-new-require.js"
+import noPathConcat from "./rules/no-path-concat.js"
+import noProcessEnv from "./rules/no-process-env.js"
+import noProcessExit from "./rules/no-process-exit.js"
+import noRestrictedImport from "./rules/no-restricted-import.js"
+import noRestrictedRequire from "./rules/no-restricted-require.js"
+import noSync from "./rules/no-sync.js"
+import noTopLevelAwait from "./rules/no-top-level-await.js"
+import noUnpublishedBin from "./rules/no-unpublished-bin.js"
+import noUnpublishedImport from "./rules/no-unpublished-import.js"
+import noUnpublishedRequire from "./rules/no-unpublished-require.js"
+import noUnsupportedFeaturesEsBuiltins from "./rules/no-unsupported-features/es-builtins.js"
+import noUnsupportedFeaturesEsSyntax from "./rules/no-unsupported-features/es-syntax.js"
+import noUnsupportedFeaturesNodeBuiltins from "./rules/no-unsupported-features/node-builtins.js"
+import preferGlobalBuffer from "./rules/prefer-global/buffer.js"
+import preferGlobalConsole from "./rules/prefer-global/console.js"
+import preferGlobalCrypto from "./rules/prefer-global/crypto.js"
+import preferGlobalProcess from "./rules/prefer-global/process.js"
+import preferGlobalTextDecoder from "./rules/prefer-global/text-decoder.js"
+import preferGlobalTextEncoder from "./rules/prefer-global/text-encoder.js"
+import preferGlobalUrlSearchParams from "./rules/prefer-global/url-search-params.js"
+import preferGlobalUrl from "./rules/prefer-global/url.js"
+import preferGlobalTimers from "./rules/prefer-global/timers.js"
+import preferNodeProtocol from "./rules/prefer-node-protocol.js"
+import preferPromisesDns from "./rules/prefer-promises/dns.js"
+import preferPromisesFs from "./rules/prefer-promises/fs.js"
+import processExitAsThrow from "./rules/process-exit-as-throw.js"
+import hashbang from "./rules/hashbang.js"
+import noHideCoreModules from "./rules/no-hide-core-modules.js"
+import shebang from "./rules/shebang.js"
 
-/** @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"),
+/** @type {Record<string, import('./rules/rule-module.js').RuleModule>} */
+const allRules = {
+    "callback-return": callbackReturn,
+    "exports-style": exportsStyle,
+    "file-extension-in-import": fileExtensionInImport,
+    "global-require": globalRequire,
+    "handle-callback-err": handleCallbackErr,
+    "no-callback-literal": noCallbackLiteral,
+    "no-deprecated-api": noDeprecatedApi,
+    "no-exports-assign": noExportsAssign,
+    "no-extraneous-import": noExtraneousImport,
+    "no-extraneous-require": noExtraneousRequire,
+    "no-missing-import": noMissingImport,
+    "no-missing-require": noMissingRequire,
+    "no-mixed-requires": noMixedRequires,
+    "no-new-require": noNewRequire,
+    "no-path-concat": noPathConcat,
+    "no-process-env": noProcessEnv,
+    "no-process-exit": noProcessExit,
+    "no-restricted-import": noRestrictedImport,
+    "no-restricted-require": noRestrictedRequire,
+    "no-sync": noSync,
+    "no-top-level-await": noTopLevelAwait,
+    "no-unpublished-bin": noUnpublishedBin,
+    "no-unpublished-import": noUnpublishedImport,
+    "no-unpublished-require": noUnpublishedRequire,
+    "no-unsupported-features/es-builtins": noUnsupportedFeaturesEsBuiltins,
+    "no-unsupported-features/es-syntax": noUnsupportedFeaturesEsSyntax,
+    "no-unsupported-features/node-builtins": noUnsupportedFeaturesNodeBuiltins,
+    "prefer-global/buffer": preferGlobalBuffer,
+    "prefer-global/console": preferGlobalConsole,
+    "prefer-global/crypto": preferGlobalCrypto,
+    "prefer-global/process": preferGlobalProcess,
+    "prefer-global/text-decoder": preferGlobalTextDecoder,
+    "prefer-global/text-encoder": preferGlobalTextEncoder,
+    "prefer-global/url-search-params": preferGlobalUrlSearchParams,
+    "prefer-global/url": preferGlobalUrl,
+    "prefer-global/timers": preferGlobalTimers,
+    "prefer-node-protocol": preferNodeProtocol,
+    "prefer-promises/dns": preferPromisesDns,
+    "prefer-promises/fs": preferPromisesFs,
+    "process-exit-as-throw": processExitAsThrow,
+    hashbang: hashbang,
+    "no-hide-core-modules": noHideCoreModules,
+    shebang: shebang,
 }
+
+export default allRules

package/lib/configs/_commons.js

@@ -1,6 +1,4 @@
-"use strict"
-
-const rules = require("../all-rules")
+import rules from "../all-rules.js"
 
 /** @type {import('eslint').Linter.RulesRecord} */
 const recommendeRulesConfig = {}
@@ -20,5 +18,4 @@ for (const [ruleName, rule] of Object.entries(rules)) {
     }
 }
 
-exports.recommendeRulesConfig = recommendeRulesConfig
-exports.allRulesConfig = allRulesConfig
+export { recommendeRulesConfig, allRulesConfig }

package/lib/configs/all.js

@@ -2,16 +2,15 @@
  * @fileoverview config for enabling all rules in the plugin.
  * @author aladdin-add<weiran.zsd@outlook.com>SS
  */
-"use strict"
 
-const { allRulesConfig } = require("./_commons")
-const recommendeConfig = require("./recommended")
+import { allRulesConfig } from "./_commons.js"
+import * as recommendeConfig from "./recommended.js"
 
 /**
  * https://eslint.org/docs/latest/use/configure/configuration-files-new
  * @type {import('eslint').Linter.FlatConfig}
  */
-exports.flat = {
+export const flat = {
     name: "node/flat/all",
     languageOptions: recommendeConfig.flat.languageOptions ?? {},
     rules: allRulesConfig,

package/lib/configs/recommended-module.js

@@ -1,13 +1,11 @@
-"use strict"
-
-const globals = require("globals")
-const { recommendeRulesConfig } = require("./_commons")
+import globals from "globals"
+import { recommendeRulesConfig } from "./_commons.js"
 
 /**
  * https://eslint.org/docs/latest/use/configure/configuration-files
  * @type {import('eslint').ESLint.ConfigData}
  */
-module.exports.eslintrc = {
+export const eslintrc = {
     env: {
         node: true,
     },
@@ -37,16 +35,16 @@ module.exports.eslintrc = {
  * https://eslint.org/docs/latest/use/configure/configuration-files-new
  * @type {import('eslint').Linter.FlatConfig}
  */
-module.exports.flat = {
+export const flat = {
     name: "node/flat/recommended-module",
     languageOptions: {
         sourceType: "module",
         globals: {
             ...globals.node,
-            ...module.exports.eslintrc.globals,
+            ...eslintrc.globals,
         },
     },
     rules:
         /** @type {import('eslint').Linter.RulesRecord} */
-        (module.exports.eslintrc.rules),
+        (eslintrc.rules),
 }

package/lib/configs/recommended-script.js

@@ -1,13 +1,11 @@
-"use strict"
-
-const globals = require("globals")
-const { recommendeRulesConfig } = require("./_commons")
+import globals from "globals"
+import { recommendeRulesConfig } from "./_commons.js"
 
 /**
  * https://eslint.org/docs/latest/use/configure/configuration-files
  * @type {import('eslint').ESLint.ConfigData}
  */
-module.exports.eslintrc = {
+export const eslintrc = {
     env: {
         node: true,
     },
@@ -34,16 +32,16 @@ module.exports.eslintrc = {
  * https://eslint.org/docs/latest/use/configure/configuration-files-new
  * @type {import('eslint').Linter.FlatConfig}
  */
-module.exports.flat = {
+export const flat = {
     name: "node/flat/recommended-script",
     languageOptions: {
         sourceType: "commonjs",
         globals: {
             ...globals.node,
-            ...module.exports.eslintrc.globals,
+            ...eslintrc.globals,
         },
     },
     rules:
         /** @type {import('eslint').Linter.RulesRecord} */
-        (module.exports.eslintrc.rules),
+        (eslintrc.rules),
 }

package/lib/configs/recommended.js

@@ -1,8 +1,6 @@
-"use strict"
-
-const { getPackageJson } = require("../util/get-package-json")
-const moduleConfig = require("./recommended-module")
-const scriptConfig = require("./recommended-script")
+import { getPackageJson } from "../util/get-package-json.js"
+import * as moduleConfig from "./recommended-module.js"
+import * as scriptConfig from "./recommended-script.js"
 
 const packageJson = getPackageJson()
 
@@ -17,7 +15,7 @@ const recommendedConfig = isModule ? moduleConfig : scriptConfig
  * https://eslint.org/docs/latest/use/configure/configuration-files
  * @type {import('eslint').ESLint.ConfigData}
  */
-module.exports.eslintrc = {
+export const eslintrc = {
     ...recommendedConfig.eslintrc,
     overrides: [
         { files: ["*.cjs", ".*.cjs"], ...scriptConfig.eslintrc },
@@ -25,4 +23,4 @@ module.exports.eslintrc = {
     ],
 }
 
-module.exports.flat = recommendedConfig.flat
+export const flat = recommendedConfig.flat