eslint-plugin-n weekly downloads statistics

eslint-plugin-n

forked from eslint-plugin-node v11.1.0. as the original repository seems no longer maintained.

Additional ESLint rules for Node.js

🎨 Playground

online-playground

💿 Install & Usage

npm install --save-dev eslint eslint-plugin-n

Migrating from eslint-plugin-node? See the migration guide.

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. The "engines" field is used by n/no-unsupported-features/* rules.

eslint.config.js

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:

import node from "eslint-plugin-n"
import {defineConfig} from "eslint/config"

export default defineConfig([
    {
        plugins: {n: node},
        rules: {
            "n/no-unsupported-features/es-builtins": "error",
        },
    }
])

package.json (An example)

{
    "name": "your-module",
    "version": "1.0.0",
    "type": "commonjs",
    "engines": {
        "node": ">=8.10.0"
    }
}

Configured Node.js version range

The rules get the supported Node.js version range from the following, falling back to the next if unspecified:

1. Rule configuration version
2. ESLint shared setting node.version
3. package.json [engines] field
4. package.json devEngines.runtime field (when name is "node")
5. >=16.0.0

If you omit both the [engines] field and the devEngines.runtime field (with name set to "node"), this rule chooses >=16.0.0 as the configured Node.js version since 16 is the maintained lts (see also Node.js Release Working Group).

For Node.js packages, using the [engines] field is recommended because it's the official way to indicate support:

{
    "name": "your-module",
    "version": "1.0.0",
    "engines": {
        "node": ">=16.0.0"
    }
}

For Shareable Configs or packages with a different development environment (e.g. pre-compiled, web package, etc.), you can configure ESLint with settings.node.version to specify support.

📖 Rules

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

💼 Configurations enabled in.
🟢 Set in the recommended-module configuration.
✅ Set in the recommended-script configuration.
🔧 Automatically fixable by the --fix CLI option.
❌ Deprecated.…