Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: add 'stricter rule config validating' in migrating docs #11905

Merged
merged 2 commits into from Jun 26, 2019
Merged

Docs: add 'stricter rule config validating' in migrating docs #11905

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
df2421f
Docs: add 'stricter rule config validating' in migrating docs
aladdin-add Jun 25, 2019
82303b0
Docs: fix typo
aladdin-add Jun 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/user-guide/migrating-to-6.0.0.md
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@ The lists below are ordered roughly by the number of users each change is expect
1. [`eslint:recommended` has been updated](#eslint-recommended-changes)
1. [Plugins and shareable configs are no longer affected by ESLint's location](#package-loading-simplification)
1. [The default parser now validates options more strictly](#espree-validation)
1. [Rule configuration are validated more strictly](#rule-config-validating)
1. [The `no-redeclare` rule is now more strict by default](#no-redeclare-updates)
1. [The `comma-dangle` rule is now more strict by default](#comma-dangle-updates)
1. [The `no-confusing-arrow` rule is now more lenient by default](#no-confusing-arrow-updates)
Expand Down Expand Up @@ -111,6 +112,22 @@ If you use a config file located outside of a local project (with the `--config`

**Related issue(s):** [eslint/eslint#9687](https://github.com/eslint/eslint/issues/9687), [eslint/espree#384](https://github.com/eslint/espree/issues/384)

## <a name="rule-config-validating"></a> Rule configuration are validated more strictly

To catch config errors earlier, ESLint v6 will report a linting error if you are trying to configure a non-existent rule.
g-plane marked this conversation as resolved.
Show resolved Hide resolved

config | ESLint v5 | ESLint v6
------------- | ------------- | -------------
`/*eslint-enable foo*/` | no error | linting error
`/*eslint-disable(-line) foo*/` | no error | linting error
`/*eslint foo: 0*/` | no error | linting error
`{rules: {foo: 0}}` | no error | no error
`{rules: {foo: 1}` | linting warning | linting error

**To address:** You can remove the non-existent rule in your (inline) config.

**Related issue(s):** [eslint/eslint#9505](https://github.com/eslint/eslint/issues/9505)

## <a name="no-redeclare-updates"></a> The `no-redeclare` rule is now more strict by default

The default options for the [`no-redeclare`](https://eslint.org/docs/rules/no-redeclare) rule have changed from `{ builtinGlobals: false }` to `{ builtinGlobals: true }`. Additionally, the `no-redeclare` rule will now report an error for globals enabled by comments like `/* global foo */` if those globals were already enabled through configuration anyway.
Expand Down