eslint-config-prettier icon indicating copy to clipboard operation
eslint-config-prettier copied to clipboard

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

Open JoshuaKGoldberg opened this issue 1 year ago • 3 comments

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?

  • In general: as a docs resource / quick checker for rule enablement
  • For configs: only when you're using a legacy plugin that enables formatting rules?

JoshuaKGoldberg avatar Dec 22 '23 21:12 JoshuaKGoldberg

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.

JounQin avatar Dec 22 '23 22:12 JounQin

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 😅

osnoser1 avatar Feb 11 '24 16:02 osnoser1

@osnoser1

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

JounQin avatar Feb 11 '24 17:02 JounQin