Thanks to visit codestin.com
Credit goes to github.com

Skip to content

📝 Docs: Install page unnecessarily suggests eslint-config-prettier for all users #18859

@JoshuaKGoldberg

Description

@JoshuaKGoldberg

https://prettier.io/docs/install#eslint-and-other-linters says:

If you use ESLint, install eslint-config-prettier to make ESLint and Prettier play nice with each other. It turns off all ESLint rules that are unnecessary or might conflict with Prettier. There’s a similar config for Stylelint: stylelint-config-prettier

This is very good advice for folks who've enabled ESLint configs that turn on formatting lint rules. But the latest versions of ESLint, typescript-eslint, and most-to-all other prominent ESLint plugins no longer do so. So advising folks to add eslint-config-prettier is actually causing unnecessary noise.

Proposal: can the wording be tweaked? Perhaps to say that most lint configs don't conflict with Prettier anymore, but that eslint-config-prettier/stylelint-config-prettier/etc. are available if you need?

If you recent versions of ESLint or popular plugins, the recommended lint rules don't conflict with Prettier. However, if you use an older version or config that enables "formatting" lint rules, install eslint-config-prettier to turn off all ESLint rules that are unnecessary or might conflict with Prettier. There’s a similar config for Stylelint: stylelint-config-prettier

Metadata

Metadata

Assignees

No one assigned

    Labels

    type:docsIssues about adding or improving documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions