prettier / eslint-config-prettier

Turns off all rules that are unnecessary or might conflict with Prettier.
MIT License
5.43k stars 255 forks source link

Docs: Clarifying when this config is useful as a config? #276

Open JoshuaKGoldberg opened 9 months ago

JoshuaKGoldberg commented 9 months ago

Spinning out of https://github.com/JoshuaKGoldberg/dot-com/pull/140 and a direct conversation with @lydell: now that most ESLint recommended configs/plugins no longer enable formatting rules, it seems that eslint-config-prettier isn't necessary in most projects. Most projects can safely remove it from their "extends" listings. But I still get a lot of questions from folks who think they still need this package as a shared config.

Would it be reasonable to add a mention somewhere in the README.md about when this package is most useful?

JounQin commented 9 months ago

There is @eslint-stylistic adopting those rules, I won't clarify them as legacy, but sure, a section about current situation would still be good to have.

So, PR welcome.

osnoser1 commented 7 months ago

So far, I'm only using eslint-config-prettier without the plugin, and I am just reading all the updates about the new @eslint-stylistic, so the first question I made myself was if the config supports these new rules in case I use a static config or using the factory function https://github.com/eslint-stylistic/eslint-stylistic/blob/main/packages/eslint-plugin/configs/customize.ts explained https://github.com/eslint-stylistic/eslint-stylistic/blob/main/packages/eslint-plugin/configs/customize.ts

So, I'm a little confused right now 😅

JounQin commented 7 months ago

@osnoser1

Sorry, as a non-native English speaker, I don't quite understand what is your real question.