Skip to content

Docs error. getting-started still refers to plugin:@typescript-eslint/eslint-recommended rules #2069

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
Closed
David-Else opened this issue May 22, 2020 · 1 comment · Fixed by #2070
Closed

Docs error. getting-started still refers to plugin:@typescript-eslint/eslint-recommended rules #2069

David-Else opened this issue May 22, 2020 · 1 comment · Fixed by #2070
Labels
documentation Documentation ("docs") that needs adding/updating package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin

Comments

@David-Else
Copy link

David-Else commented May 22, 2020 •
edited
Loading

I thought with v3.0.0 plugin:@typescript-eslint/eslint-recommended was gone?

729f2a2

But https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/README.md still refers to it many times. I assume this is a mistake.

I found the wording very confusing in the v3 release notes:

Both of the recommended and recommended-requiring-typechecking sets now inherit from the eslint-recommended set. We noticed that the majority of the time, users were using the sets in tandem, so this just removes one line of config for everyone.

What does 'inherit from' in this context mean? How about a quick description of how to update your config instead?
@David-Else David-Else added package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin triage Waiting for team members to take a look labels May 22, 2020
@bradzacher
Copy link
Member

bradzacher commented May 22, 2020 •
edited
Loading

It's not gone, it's just no longer explicitly required.
"inherit from" means that both recommended and recommended-requiring-type-checking both have extends: ['eslint-recommended'] in them, so using them automatically includes that set.

E.g. now if you configure

extends: [
  "recommended",
  "plugin:@typescript-eslint/eslint-recommended",
  "plugin:@typescript-eslint/recommended"
]

It's the same as

extends: [
  "recommended",
  "plugin:@typescript-eslint/recommended"
]

I'll update the docs to match.

@bradzacher bradzacher added documentation Documentation ("docs") that needs adding/updating and removed triage Waiting for team members to take a look labels May 22, 2020
@bradzacher bradzacher mentioned this issue May 22, 2020
Merged
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 22, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Documentation ("docs") that needs adding/updating package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: various updates based on v3 feedback typescript-eslint/typescript-eslint
2 participants
@bradzacher @David-Else