Additional ESLint's rules for Node.js
npm install 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
``sh`
npm install --save-dev eslint eslint-plugin-n
| Version | Supported Node.js | Supported ESLint Version | Status |
|---------|-------------------|---------------------------|--------|
| 17.x | ^18.18.0 \|\| ^20.9.0 \|\| >=21.1.0 | >=8.23.0 | 🏃♂️actively maintained |>=16.0.0
| 16.x | | >=7.0.0 | ⚠️EOL |>=12.22.0
| 15.x | | >=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.
`js
const nodePlugin = require("eslint-plugin-n")
module.exports = [
nodePlugin.configs["flat/recommended-script"],
{
rules: {
"n/exports-style": ["error", "module.exports"]
}
}
]
`
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"]
}
}
]
`
`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:
`jsonc`
{
"parserOptions": {
"ecmaVersion": 2021
},
"plugins": ["n"],
"rules": {
"n/exports-style": ["error", "module.exports"]
}
}
package.json (An example)
`json`
{
"name": "your-module",
"version": "1.0.0",
"type": "commonjs",
"engines": {
"node": ">=8.10.0"
}
}
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
3. [engines] field>=16.0.0
4.
If you omit the [engines] field, 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:
`json`
{
"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.
💼 Configurations enabled in.\
🟢 Set in the recommended-module configuration.\recommended-script
✅ Set in the configuration.\--fix
🔧 Automatically fixable by the CLI option.\
❌ Deprecated.
| Name | Description | 💼 | 🔧 | ❌ |
| :------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------- | :--- | :- | :- |
| callback-return | require return statements after callbacks | | | |module.exports
| exports-style | enforce either or exports | | 🔧 | |import
| file-extension-in-import | enforce the style of file extensions in declarations | | 🔧 | |require()
| global-require | require calls to be placed at top-level module scope | | | |exports
| handle-callback-err | require error handling in callbacks | | | |
| hashbang | require correct usage of hashbang | 🟢 ✅ | 🔧 | |
| no-callback-literal | enforce Node.js-style error-first callback pattern is followed | | | |
| no-deprecated-api | disallow deprecated APIs | 🟢 ✅ | | |
| no-exports-assign | disallow the assignment to | 🟢 ✅ | | |import
| no-extraneous-import | disallow declarations which import extraneous modules | 🟢 ✅ | | |require()
| no-extraneous-require | disallow expressions which import extraneous modules | 🟢 ✅ | | |import
| no-hide-core-modules | disallow third-party modules which are hiding core modules | | | ❌ |
| no-missing-import | disallow declarations which import missing modules | 🟢 ✅ | | |require()
| no-missing-require | disallow expressions which import missing modules | 🟢 ✅ | | |require
| no-mixed-requires | disallow calls to be mixed with regular variable declarations | | | |new
| no-new-require | disallow operators with calls to require | | | |__dirname
| no-path-concat | disallow string concatenation with and __filename | | | |process.env
| no-process-env | disallow the use of | | | |process.exit()
| no-process-exit | disallow the use of | 🟢 ✅ | | |import
| no-restricted-import | disallow specified modules when loaded by declarations | | | |require
| no-restricted-require | disallow specified modules when loaded by | | | |await
| no-sync | disallow synchronous methods | | | |
| no-top-level-await | disallow top-level in published modules | | | |bin
| no-unpublished-bin | disallow files that npm ignores | 🟢 ✅ | | |import
| no-unpublished-import | disallow declarations which import private modules | 🟢 ✅ | | |require()
| no-unpublished-require | disallow expressions which import private modules | 🟢 ✅ | | |Buffer
| no-unsupported-features/es-builtins | disallow unsupported ECMAScript built-ins on the specified version | 🟢 ✅ | | |
| no-unsupported-features/es-syntax | disallow unsupported ECMAScript syntax on the specified version | 🟢 ✅ | | |
| no-unsupported-features/node-builtins | disallow unsupported Node.js built-in APIs on the specified version | 🟢 ✅ | | |
| prefer-global/buffer | enforce either or require("buffer").Buffer | | | |console
| prefer-global/console | enforce either or require("console") | | | |process
| prefer-global/process | enforce either or require("process") | | | |TextDecoder
| prefer-global/text-decoder | enforce either or require("util").TextDecoder | | | |TextEncoder
| prefer-global/text-encoder | enforce either or require("util").TextEncoder | | | |URL
| prefer-global/url | enforce either or require("url").URL | | | |URLSearchParams
| prefer-global/url-search-params | enforce either or require("url").URLSearchParams | | | |node:
| prefer-node-protocol | enforce using the protocol when importing Node.js builtin modules. | | 🔧 | |require("dns").promises
| prefer-promises/dns | enforce | | | |require("fs").promises
| prefer-promises/fs | enforce | | | |process.exit()
| process-exit-as-throw | require that expressions use the same code path as throw | 🟢 ✅ | | |
| shebang | require correct usage of hashbang | | 🔧 | ❌ |
| | Name |
| :- | :------------------- |
| 🟢 | recommended-module |recommended-script
| ✅ | |
About each config:
- recommended: Considers both CommonJS and ES Modules. If "type":"module" field 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:
- enable no-process-exit rule because the official document does not recommend a use of process.exit().{ecmaVersion: 2021}
- enable plugin rules indicated by emojis in the rules table.
- add and etc into parserOptions.globals
- add proper globals into .plugins
- add this plugin into .
- 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 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:
`js
const nodePlugin = require("eslint-plugin-n");
module.exports = [
...nodePlugin.configs["flat/mixed-esm-and-cjs"],
{
rules: {
"n/exports-style": ["error", "module.exports"],
},
},
]
`
eslint-plugin-n follows semantic versioning and ESLint's Semantic Versioning Policy.
- Patch release (intended to not break your lint build)
- A bug fix in a rule that results in it reporting fewer errors.
- Improvements to documentation.
- Non-user-facing changes such as refactoring code, adding, deleting, or modifying tests, and increasing test coverage.
- Re-releasing after a failed release (i.e., publishing a release that doesn't work for anyone).
- Minor release (might break your lint build)
- A bug fix in a rule that results in it reporting more errors.
- A new rule is created.
- A new option to an existing rule is created.
- An existing rule is deprecated.
- Major release (likely to break your lint build)
- A support for old Node version is dropped.
- A support for old ESLint version is dropped.
- An existing rule is changed in it reporting more errors.
- An existing rule is removed.
- An existing option of a rule is removed.
- An existing config is updated.
Deprecated rules follow ESLint's deprecation policy.
Welcome contributing!
Please use GitHub's Issues/PRs.
- npm test runs tests and measures coverage.npm run coverage
- shows the coverage result of npm test command.npm run clean
- removes the coverage result of npm test` command.