157 lines
7.9 KiB
Markdown
157 lines
7.9 KiB
Markdown
# eslint-plugin-node
|
|
|
|
[](https://www.npmjs.com/package/eslint-plugin-node)
|
|
[](http://www.npmtrends.com/eslint-plugin-node)
|
|
[](https://travis-ci.org/mysticatea/eslint-plugin-node)
|
|
[](https://codecov.io/gh/mysticatea/eslint-plugin-node)
|
|
[](https://david-dm.org/mysticatea/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](https://docs.npmjs.com/files/package.json#engines). The "engines" field is used by `node/no-unsupported-features/*` rules.
|
|
|
|
**.eslintrc.json** (An example)
|
|
|
|
```json
|
|
{
|
|
"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)
|
|
|
|
```json
|
|
{
|
|
"name": "your-module",
|
|
"version": "1.0.0",
|
|
"engines": {
|
|
"node": ">=6.0.0"
|
|
}
|
|
}
|
|
```
|
|
|
|
## 📖 Rules
|
|
|
|
- ⭐️ - the mark of recommended rules.
|
|
- ✒️ - the mark of fixable rules.
|
|
|
|
<!--RULES_TABLE_START-->
|
|
### Possible Errors
|
|
|
|
| Rule ID | Description | |
|
|
|:--------|:------------|:--:|
|
|
| [node/no-extraneous-import](./docs/rules/no-extraneous-import.md) | disallow `import` declarations of extraneous packages | |
|
|
| [node/no-extraneous-require](./docs/rules/no-extraneous-require.md) | disallow `require()` expressions of extraneous packages | ⭐️ |
|
|
| [node/no-missing-import](./docs/rules/no-missing-import.md) | disallow `import` declarations of missing files | |
|
|
| [node/no-missing-require](./docs/rules/no-missing-require.md) | disallow `require()` expressions of missing files | ⭐️ |
|
|
| [node/no-unpublished-bin](./docs/rules/no-unpublished-bin.md) | disallow 'bin' files which are ignored by npm | ⭐️ |
|
|
| [node/no-unpublished-import](./docs/rules/no-unpublished-import.md) | disallow `import` declarations of private things | |
|
|
| [node/no-unpublished-require](./docs/rules/no-unpublished-require.md) | disallow `require()` expressions of private things | ⭐️ |
|
|
| [node/no-unsupported-features/es-builtins](./docs/rules/no-unsupported-features/es-builtins.md) | disallow unsupported ECMAScript built-ins on the specified version | ⭐️ |
|
|
| [node/no-unsupported-features/es-syntax](./docs/rules/no-unsupported-features/es-syntax.md) | disallow unsupported ECMAScript syntax on the specified version | ⭐️ |
|
|
| [node/no-unsupported-features/node-builtins](./docs/rules/no-unsupported-features/node-builtins.md) | disallow unsupported Node.js built-in APIs on the specified version | ⭐️ |
|
|
| [node/process-exit-as-throw](./docs/rules/process-exit-as-throw.md) | make `process.exit()` expressions the same code path as `throw` | ⭐️ |
|
|
| [node/shebang](./docs/rules/shebang.md) | enforce the correct usage of shebang | ⭐️✒️ |
|
|
|
|
### Best Practices
|
|
|
|
| Rule ID | Description | |
|
|
|:--------|:------------|:--:|
|
|
| [node/no-deprecated-api](./docs/rules/no-deprecated-api.md) | disallow deprecated APIs | ⭐️ |
|
|
|
|
### Stylistic Issues
|
|
|
|
| Rule ID | Description | |
|
|
|:--------|:------------|:--:|
|
|
| [node/exports-style](./docs/rules/exports-style.md) | enforce either `module.exports` or `exports` | |
|
|
| [node/prefer-global/buffer](./docs/rules/prefer-global/buffer.md) | enforce either `Buffer` or `require("buffer").Buffer` | |
|
|
| [node/prefer-global/console](./docs/rules/prefer-global/console.md) | enforce either `console` or `require("console")` | |
|
|
| [node/prefer-global/process](./docs/rules/prefer-global/process.md) | enforce either `process` or `require("process")` | |
|
|
| [node/prefer-global/text-decoder](./docs/rules/prefer-global/text-decoder.md) | enforce either `TextDecoder` or `require("util").TextDecoder` | |
|
|
| [node/prefer-global/text-encoder](./docs/rules/prefer-global/text-encoder.md) | enforce either `TextEncoder` or `require("util").TextEncoder` | |
|
|
| [node/prefer-global/url-search-params](./docs/rules/prefer-global/url-search-params.md) | enforce either `URLSearchParams` or `require("url").URLSearchParams` | |
|
|
| [node/prefer-global/url](./docs/rules/prefer-global/url.md) | enforce either `URL` or `require("url").URL` | |
|
|
|
|
### Deprecated rules
|
|
|
|
These rules have been deprecated in accordance with the [deprecation policy](https://eslint.org/docs/user-guide/rule-deprecation), and replaced by newer rules:
|
|
|
|
| Rule ID | Replaced by |
|
|
|:--------|:------------|
|
|
| [node/no-hide-core-modules](./docs/rules/no-hide-core-modules.md) | (nothing) |
|
|
| [node/no-unsupported-features](./docs/rules/no-unsupported-features.md) | [node/no-unsupported-features/es-syntax](./docs/rules/no-unsupported-features/es-syntax.md) and [node/no-unsupported-features/es-builtins](./docs/rules/no-unsupported-features/es-builtins.md) |
|
|
|
|
<!--RULES_TABLE_END-->
|
|
|
|
## 🔧 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 :star: in the above table.
|
|
- enables [no-process-exit](http://eslint.org/docs/rules/no-process-exit) rule because [the official document](https://nodejs.org/api/process.html#process_process_exit_code) 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](https://github.com/roadhump/SublimeLinter-eslint#contextgetfilename-in-rule-returns-relative-path) in the SublimeLinter-eslint FAQ.
|
|
|
|
## 🚥 Semantic Versioning Policy
|
|
|
|
`eslint-plugin-node` follows [semantic versioning](http://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#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](https://github.com/mysticatea/eslint-plugin-node/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.
|