Skip to content

Commit

Permalink
docs: update docs to reflect the new default version
Browse files Browse the repository at this point in the history
  • Loading branch information
aladdin-add committed Mar 29, 2023
1 parent ce7a3cc commit 7935ae5
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 18 deletions.
6 changes: 3 additions & 3 deletions docs/rules/no-deprecated-api.md
Expand Up @@ -151,12 +151,12 @@ For example of `package.json`:
"name": "your-module",
"version": "1.0.0",
"engines": {
"node": ">=8.0.0"
"node": ">=16.0.0"
}
}
```

If you omit the [engines] field, this rule chooses `>=8.0.0` as the configured Node.js version since `8` is the minimum version the community is maintaining (see also [Node.js Release Working Group](https://github.com/nodejs/Release#readme)).
If you omit the [engines] field, this rule chooses `>=16.0.0` as the configured Node.js version since `16` is the active lts (see also [Node.js Release Working Group](https://github.com/nodejs/Release#readme)).

### Options

Expand All @@ -166,7 +166,7 @@ This rule has 4 options.
{
"rules": {
"n/no-deprecated-api": ["error", {
"version": ">=8.0.0",
"version": ">=16.0.0",
"ignoreModuleItems": [],
"ignoreGlobalItems": []
"ignoreIndirectDependencies": true
Expand Down
10 changes: 5 additions & 5 deletions docs/rules/no-unsupported-features/es-builtins.md
Expand Up @@ -24,9 +24,9 @@ This rule gets the supported Node.js version range from the following, falling b
1. Rule configuration `version`
2. ESLint [shared setting](http://eslint.org/docs/user-guide/configuring.html#adding-shared-settings) `node.version`
3. `package.json` [`engines`] field
4. `>=8.0.0`
4. `>=16.0.0`

The default version is `8.0.0` because it's the minimum version the community is maintaining (see also [Node.js Release Working Group](https://github.com/nodejs/Release#readme)).
If you omit the [engines] field, this rule chooses `>=16.0.0` as the configured Node.js version since `16` is the active lts (see also [Node.js Release Working Group](https://github.com/nodejs/Release#readme)).

For Node.js packages, using the [`engines`] field is recommended because it's the official way to indicate support:

Expand All @@ -35,7 +35,7 @@ For Node.js packages, using the [`engines`] field is recommended because it's th
"name": "your-module",
"version": "1.0.0",
"engines": {
"node": ">=8.0.0"
"node": ">=16.0.0"
}
}
```
Expand All @@ -47,7 +47,7 @@ For [Shareable Configs](https://eslint.org/docs/latest/developer-guide/shareable
```json
{
"n/no-unsupported-features/es-builtins": ["error", {
"version": ">=8.0.0",
"version": ">=16.0.0",
"ignores": []
}]
}
Expand Down Expand Up @@ -159,7 +159,7 @@ For Example:
{
"settings": {
"node": {
"version": ">=8.0.0",
"version": ">=16.0.0",
}
},
"rules": {
Expand Down
10 changes: 5 additions & 5 deletions docs/rules/no-unsupported-features/es-syntax.md
Expand Up @@ -27,9 +27,9 @@ This rule gets the supported Node.js version range from the following, falling b
1. Rule configuration `version`
2. ESLint [shared setting](http://eslint.org/docs/user-guide/configuring.html#adding-shared-settings) `node.version`
3. `package.json` [`engines`] field
4. `>=8.0.0`
4. `>=16.0.0`

The default version is `8.0.0` because it's the minimum version the community is maintaining (see also [Node.js Release Working Group](https://github.com/nodejs/Release#readme)).
If you omit the [engines] field, this rule chooses `>=16.0.0` as the configured Node.js version since `16` is the active lts (see also [Node.js Release Working Group](https://github.com/nodejs/Release#readme)).

For Node.js packages, using the [`engines`] field is recommended because it's the official way to indicate support:

Expand All @@ -38,7 +38,7 @@ For Node.js packages, using the [`engines`] field is recommended because it's th
"name": "your-module",
"version": "1.0.0",
"engines": {
"node": ">=8.0.0"
"node": ">=16.0.0"
}
}
```
Expand All @@ -50,7 +50,7 @@ For [Shareable Configs](https://eslint.org/docs/latest/developer-guide/shareable
```json
{
"n/no-unsupported-features/es-syntax": ["error", {
"version": ">=8.0.0",
"version": ">=16.0.0",
"ignores": []
}]
}
Expand Down Expand Up @@ -144,7 +144,7 @@ For Example:
{
"settings": {
"node": {
"version": ">=8.0.0",
"version": ">=16.0.0",
}
},
"rules": {
Expand Down
10 changes: 5 additions & 5 deletions docs/rules/no-unsupported-features/node-builtins.md
Expand Up @@ -21,9 +21,9 @@ This rule gets the supported Node.js version range from the following, falling b
1. Rule configuration `version`
2. ESLint [shared setting](http://eslint.org/docs/user-guide/configuring.html#adding-shared-settings) `node.version`
3. `package.json` [`engines`] field
4. `>=8.0.0`
4. `>=16.0.0`

The default version is `8.0.0` because it's the minimum version the community is maintaining (see also [Node.js Release Working Group](https://github.com/nodejs/Release#readme)).
If you omit the [engines] field, this rule chooses `>=16.0.0` as the configured Node.js version since `16` is the active lts (see also [Node.js Release Working Group](https://github.com/nodejs/Release#readme)).

For Node.js packages, using the [`engines`] field is recommended because it's the official way to indicate support:

Expand All @@ -32,7 +32,7 @@ For Node.js packages, using the [`engines`] field is recommended because it's th
"name": "your-module",
"version": "1.0.0",
"engines": {
"node": ">=8.0.0"
"node": ">=16.0.0"
}
}
```
Expand All @@ -44,7 +44,7 @@ For [Shareable Configs](https://eslint.org/docs/latest/developer-guide/shareable
```json
{
"n/no-unsupported-features/node-builtins": ["error", {
"version": ">=8.0.0",
"version": ">=16.0.0",
"ignores": []
}]
}
Expand Down Expand Up @@ -343,7 +343,7 @@ For Example:
{
"settings": {
"node": {
"version": ">=8.0.0",
"version": ">=16.0.0",
}
},
"rules": {
Expand Down

0 comments on commit 7935ae5

Please sign in to comment.