7.9 KiB

Raw Blame History

eslint-plugin-node

Additional ESLint's rules for Node.js

💿 Install & Usage

$ npm install --save-dev eslint eslint-plugin-node

Requires Node.js >=6.0.0
Requires ESLint >=4.19.1 (plugin:node/recommended preset requires >=5.0.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"],
    "rules": {
        "node/exports-style": ["error", "module.exports"],
        "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"]
    }
}

package.json (An example)

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

📖 Rules

⭐️ - the mark of recommended rules.
✒️ - the mark of fixable rules.

Possible Errors

Rule ID	Description
node/no-extraneous-import	disallow `import` declarations of extraneous packages
node/no-extraneous-require	disallow `require()` expressions of extraneous packages	⭐️
node/no-missing-import	disallow `import` declarations of missing files
node/no-missing-require	disallow `require()` expressions of missing files	⭐️
node/no-unpublished-bin	disallow 'bin' files which are ignored by npm	⭐️
node/no-unpublished-import	disallow `import` declarations of private things
node/no-unpublished-require	disallow `require()` expressions of private things	⭐️
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 `process.exit()` expressions the same code path as `throw`	⭐️
node/shebang	enforce the correct usage of shebang	⭐️✒️

Best Practices

Rule ID	Description
node/no-deprecated-api	disallow deprecated APIs	⭐️

Stylistic Issues

Rule ID	Description
node/exports-style	enforce either `module.exports` or `exports`
node/prefer-global/buffer	enforce either `Buffer` or `require("buffer").Buffer`
node/prefer-global/console	enforce either `console` or `require("console")`
node/prefer-global/process	enforce either `process` or `require("process")`
node/prefer-global/text-decoder	enforce either `TextDecoder` or `require("util").TextDecoder`
node/prefer-global/text-encoder	enforce either `TextEncoder` or `require("util").TextEncoder`
node/prefer-global/url-search-params	enforce either `URLSearchParams` or `require("url").URLSearchParams`
node/prefer-global/url	enforce either `URL` or `require("url").URL`

Deprecated rules

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

🔧 Configs

This plugin provides plugin:node/recommended preset config. This preset config:

enables the environment of ES2015 (ES6) and Node.js.
enables rules which are given ⭐ in the above table.
enables no-process-exit rule because the official document does not recommend a use of process.exit().
adds {ecmaVersion: 2019} into parserOptions.
adds Atomics and SharedArrayBuffer into globals.
adds 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

GitHub Releases

💎 Contributing

Welcome contributing!

Please use GitHub's Issues/PRs.

Development Tools

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.

7.9 KiB Raw Blame History Unescape Escape