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.

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

"Example configuration" in README includes redundant plugin fields #157

Closed
ZYinMD opened this issue Sep 5, 2020 · 2 comments
Closed

"Example configuration" in README includes redundant plugin fields #157

ZYinMD opened this issue Sep 5, 2020 · 2 comments

Comments

@ZYinMD
Copy link

ZYinMD commented Sep 5, 2020

In the example configuration part of the README, I think most of the plugins are unnecessary. For instance, the "plugin:react/recommended" config file already contains plugin: ["react"], and the the "plugin:@typescript-eslint/recommended" config file already contains plugin: [ "@typescript-eslint"]. Generally speaking, if you extend a config file that is exported by a plugin, then you won't need to manually add that plugin in your plugin: [].

It'd also be nice if the README could explain about this fact a little bit. Lots of developers actually don't understand eslint config to this extent, they usually just copy paste.

I'm not an eslint expert either, so please correct me if I'm wrong.

@lydell
Copy link
Member

lydell commented Sep 5, 2020

You’re right, we should remove the unnecessary parts. Bad examples are bad.

@lydell lydell closed this as completed in e73484d Sep 25, 2020
@lydell
Copy link
Member

lydell commented Sep 25, 2020

I removed the entire "Example configuration" section since it provides nothing in addition to the previous sections and is a bad example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants