mirror of
https://github.com/freeCodeCamp/freeCodeCamp.git
synced 2026-05-25 10:01:30 -04:00
116 lines
5.4 KiB
Markdown
116 lines
5.4 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
|
|
|
|
## :cd: Install & Usage
|
|
|
|
```
|
|
> npm install --save-dev eslint eslint-plugin-node
|
|
```
|
|
|
|
- Requires Node.js `^4.0.0 || >=6.0.0`
|
|
- Requires ESLint `>=3.1.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 [no-unsupported-features](docs/rules/no-unsupported-features.md) rule.
|
|
|
|
**.eslintrc.json** (An example)
|
|
|
|
```json
|
|
{
|
|
"plugins": ["node"],
|
|
"extends": ["eslint:recommended", "plugin:node/recommended"],
|
|
"rules": {
|
|
"node/exports-style": ["error", "module.exports"],
|
|
}
|
|
}
|
|
```
|
|
|
|
**package.json** (An example)
|
|
|
|
```json
|
|
{
|
|
"name": "your-module",
|
|
"version": "1.0.0",
|
|
"engines": {
|
|
"node": ">=4.0.0"
|
|
}
|
|
}
|
|
```
|
|
|
|
## :bulb: Rules
|
|
|
|
| | | Rule ID | Description |
|
|
|:------:|:--------:|:-----------------------------------------------------------------|:------------|
|
|
| | | [exports-style](docs/rules/exports-style.md) | Enforce either `module.exports` or `exports`.
|
|
| :star: | | [no-deprecated-api](docs/rules/no-deprecated-api.md) | Disallow deprecated API.
|
|
| | | [no-missing-import](docs/rules/no-missing-import.md) | Disallow `import` declarations for files that don't exist. :warning:
|
|
| :star: | | [no-missing-require](docs/rules/no-missing-require.md) | Disallow `require()`s for files that don't exist.
|
|
| :star: | | [no-unpublished-bin](docs/rules/no-unpublished-bin.md) | Disallow `bin` files that npm ignores.
|
|
| | | [no-unpublished-import](docs/rules/no-unpublished-import.md) | Disallow `import` declarations for files that npm ignores. :warning:
|
|
| :star: | | [no-unpublished-require](docs/rules/no-unpublished-require.md) | Disallow `require()`s for files that npm ignores.
|
|
| :star: | | [no-unsupported-features](docs/rules/no-unsupported-features.md) | Disallow unsupported ECMAScript features on the specified version.
|
|
| :star: | | [process-exit-as-throw](docs/rules/process-exit-as-throw.md) | Make the same code path as throw at `process.exit()`.
|
|
| :star: | :pencil: | [shebang](docs/rules/shebang.md) | Suggest correct usage of shebang.
|
|
|
|
- :star: - the mark of a recommended rule.
|
|
- :pencil: - the mark of a fixable rule.
|
|
|
|
## :wrench: 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: 8}` into `parserOptions`.
|
|
|
|
## :couple: 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.
|
|
|
|
## :anchor: 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.
|
|
|
|
## :newspaper: Changelog
|
|
|
|
- [GitHub Releases](https://github.com/mysticatea/eslint-plugin-node/releases)
|
|
|
|
## :muscle: 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.
|