Additional ESLint's rules for Node.js
npm install eslint-plugin-node
Additional ESLint's rules for Node.js
``
$ npm install --save-dev eslint eslint-plugin-node
- Requires Node.js >=8.10.0
- Requires ESLint
Note: It recommends a use of the "engines" field of package.json. The "engines" field is used by node/no-unsupported-features/* rules.
.eslintrc.json (An example)
`jsonc`
{
"extends": [
"eslint:recommended",
"plugin:node/recommended"
],
"parserOptions": {
// Only ESLint 6.2.0 and later support ES2020.
"ecmaVersion": 2020
},
"rules": {
"node/exports-style": ["error", "module.exports"],
"node/file-extension-in-import": ["error", "always"],
"node/prefer-global/buffer": ["error", "always"],
"node/prefer-global/console": ["error", "always"],
"node/prefer-global/process": ["error", "always"],
"node/prefer-global/url-search-params": ["error", "always"],
"node/prefer-global/url": ["error", "always"],
"node/prefer-promises/dns": "error",
"node/prefer-promises/fs": "error"
}
}
package.json (An example)
`json`
{
"name": "your-module",
"version": "1.0.0",
"type": "commonjs",
"engines": {
"node": ">=8.10.0"
}
}
- ⭐️ - the mark of recommended rules.
- ✒️ - the mark of fixable rules.
| Rule ID | Description | |
|:--------|:------------|:--:|
| node/no-callback-literal | ensure Node.js-style error-first callback pattern is followed | |
| node/no-exports-assign | disallow the assignment to exports | ⭐️ |import
| node/no-extraneous-import | disallow declarations which import extraneous modules | ⭐️ |require()
| node/no-extraneous-require | disallow expressions which import extraneous modules | ⭐️ |import
| node/no-missing-import | disallow declarations which import non-existence modules | ⭐️ |require()
| node/no-missing-require | disallow expressions which import non-existence modules | ⭐️ |bin
| node/no-unpublished-bin | disallow files that npm ignores | ⭐️ |import
| node/no-unpublished-import | disallow declarations which import private modules | ⭐️ |require()
| node/no-unpublished-require | disallow expressions which import private modules | ⭐️ |process.exit()
| node/no-unsupported-features/es-builtins | disallow unsupported ECMAScript built-ins on the specified version | ⭐️ |
| node/no-unsupported-features/es-syntax | disallow unsupported ECMAScript syntax on the specified version | ⭐️ |
| node/no-unsupported-features/node-builtins | disallow unsupported Node.js built-in APIs on the specified version | ⭐️ |
| node/process-exit-as-throw | make expressions the same code path as throw | ⭐️ |
| node/shebang | suggest correct usage of shebang | ⭐️✒️ |
| Rule ID | Description | |
|:--------|:------------|:--:|
| node/no-deprecated-api | disallow deprecated APIs | ⭐️ |
| Rule ID | Description | |
|:--------|:------------|:--:|
| node/exports-style | enforce either module.exports or exports | |import
| node/file-extension-in-import | enforce the style of file extensions in declarations | ✒️ |Buffer
| node/prefer-global/buffer | enforce either or require("buffer").Buffer | |console
| node/prefer-global/console | enforce either or require("console") | |process
| node/prefer-global/process | enforce either or require("process") | |TextDecoder
| node/prefer-global/text-decoder | enforce either or require("util").TextDecoder | |TextEncoder
| node/prefer-global/text-encoder | enforce either or require("util").TextEncoder | |URLSearchParams
| node/prefer-global/url-search-params | enforce either or require("url").URLSearchParams | |URL
| node/prefer-global/url | enforce either or require("url").URL | |require("dns").promises
| node/prefer-promises/dns | enforce | |require("fs").promises
| node/prefer-promises/fs | enforce | |
These rules have been deprecated in accordance with the deprecation policy, and replaced by newer rules:
| Rule ID | Replaced by |
|:--------|:------------|
| node/no-hide-core-modules | (nothing) |
| node/no-unsupported-features | node/no-unsupported-features/es-syntax and node/no-unsupported-features/es-builtins |
This plugin provides three configs:
- plugin:node/recommended condiders 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.plugin:node/recommended-module
- considers all files as ES Modules.plugin:node/recommended-script
- considers all files as CommonJS.
Those preset config:
- enable no-process-exit rule because the official document does not recommend a use of process.exit().{ecmaVersion: 2019}
- enable plugin rules which are given :star: in the above 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.
eslint-plugin-node 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.
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.