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

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

Open
JoshuaKGoldberg opened this issue Dec 22, 2023 · 3 comments
Open

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

JoshuaKGoldberg opened this issue Dec 22, 2023 · 3 comments

Comments

@JoshuaKGoldberg
Copy link

Spinning out of JoshuaKGoldberg/dot-com#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?
@JounQin
Copy link
Member

JounQin commented Dec 22, 2023

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
Copy link

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
Copy link
Member

JounQin commented Feb 11, 2024

@osnoser1

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

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

3 participants