ce4c83ff
 wxy
初始提交
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
# 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 `^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"
}
}
```
## 📖 Rules
- ⭐️ - the mark of recommended rules.
- ✒️ - the mark of fixable rules.
<!--RULES_TABLE_START-->
### Possible Errors
| | Rule ID | Description |
|:---|:--------|:------------|
| | [no-extraneous-import](./docs/rules/no-extraneous-import.md) | disallow `import` declarations of extraneous packages |
| ⭐️ | [no-extraneous-require](./docs/rules/no-extraneous-require.md) | disallow `require()` expressions of extraneous packages |
| | [no-missing-import](./docs/rules/no-missing-import.md) | disallow `import` declarations of missing files |
| ⭐️ | [no-missing-require](./docs/rules/no-missing-require.md) | disallow `require()` expressions of missing files |
| ⭐️ | [no-unpublished-bin](./docs/rules/no-unpublished-bin.md) | disallow 'bin' files which are ignored by npm |
| | [no-unpublished-import](./docs/rules/no-unpublished-import.md) | disallow `import` declarations of private things |
| ⭐️ | [no-unpublished-require](./docs/rules/no-unpublished-require.md) | disallow `require()` expressions of private things |
| ⭐️ | [no-unsupported-features](./docs/rules/no-unsupported-features.md) | disallow unsupported ECMAScript features on the specified version |
| ⭐️ | [process-exit-as-throw](./docs/rules/process-exit-as-throw.md) | make `process.exit()` expressions the same code path as `throw` |
| ⭐️✒️ | [shebang](./docs/rules/shebang.md) | enforce the correct usage of shebang |
### Best Practices
| | Rule ID | Description |
|:---|:--------|:------------|
| ⭐️ | [no-deprecated-api](./docs/rules/no-deprecated-api.md) | disallow deprecated APIs |
### Stylistic Issues
| | Rule ID | Description |
|:---|:--------|:------------|
| | [exports-style](./docs/rules/exports-style.md) | enforce either `module.exports` or `exports` |
<!--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: 8}` into `parserOptions`.
## 👫 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.
|
