Skip to content

Commit

Permalink
Breaking: update plugin:node/recommended
Browse files Browse the repository at this point in the history
  • Loading branch information
mysticatea committed Oct 31, 2016
1 parent 95b8164 commit 13c61b1
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 15 deletions.
33 changes: 18 additions & 15 deletions README.md
Expand Up @@ -17,14 +17,6 @@ Additional ESLint's rules for Node.js
- Requires Node.js `^0.10.0 || ^0.12.0 || ^4.0.0 || >=6.0.0`
- Requires ESLint `>=2.0.0`

## :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 following table.

**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)
Expand All @@ -35,8 +27,6 @@ This preset config:
"extends": ["eslint:recommended", "plugin:node/recommended"],
"rules": {
"node/exports-style": ["error", "module.exports"],
"node/no-unpublished-bin": "error",
"node/process-exit-as-throw": "error"
}
}
```
Expand All @@ -45,8 +35,10 @@ This preset config:

```json
{
"name": "your-module",
"version": "1.0.0",
"engines": {
"node": ">=4"
"node": ">=4.0.0"
}
}
```
Expand All @@ -59,16 +51,26 @@ This preset config:
| :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.
| | | [no-unpublished-bin](docs/rules/no-unpublished-bin.md) | Disallow `bin` files that npm ignores.
| :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.
| | | [process-exit-as-throw](docs/rules/process-exit-as-throw.md) | Make the same code path as throw at `process.exit()`.
| :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
Expand All @@ -79,18 +81,19 @@ This preset config:
`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 `eslint-plugin-node` reporting fewer errors.
- 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 `eslint-plugin-node` reporting more errors.
- 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.
Expand Down
5 changes: 5 additions & 0 deletions conf/recommended.json
@@ -1,4 +1,7 @@
{
"parserOptions": {
"ecmaVersion": 8
},
"env": {
"es6": true,
"node": true
Expand All @@ -7,8 +10,10 @@
"no-process-exit": "error",
"node/no-deprecated-api": "error",
"node/no-missing-require": "error",
"node/no-unpublished-bin": "error",
"node/no-unpublished-require": "error",
"node/no-unsupported-features": "error",
"node/process-exit-as-throw": "error",
"node/shebang": "error"
}
}

0 comments on commit 13c61b1

Please sign in to comment.