eslint-plugin-node
Additional ESLint's rules for Node.js
💿 Install & Usage
$ npm install --save-dev eslint eslint-plugin-node copy
Requires Node.js >=8.10.0
Requires ESLint >=5.16.0
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)
{
"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"
package.json (An example)
{
"name" : "your-module" ,
"version" : "1.0.0" ,
"type" : "commonjs" ,
"engines" : {
"node" : ">=8.10.0"
}
} copy
📖 Rules
⭐️ - the mark of recommended rules.
✒️ - the mark of fixable rules.
Possible Errors
Best Practices
Stylistic Issues
Deprecated rules
These rules have been deprecated in accordance with the deprecation policy , and replaced by newer rules:
🔧 Configs
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().
enable plugin rules which are given :star: in the above table.
add {ecmaVersion: 2019} and etc into parserOptions.
add proper globals into globals.
add this plugin into plugins.
👫 FAQ
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.
🚥 Semantic Versioning Policy
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.
📰 Changelog
❤️ Contributing
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.