Skip to content

Commit 3414437

Browse files
Docs: suggest prettier-eslint if eslint rules disagree with prettier
1 parent b68bf12 commit 3414437

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,7 @@ You can also pass `prettier` configuration as an option:
5252
```
5353

5454
The rule will report an error if your code does not match `prettier` style. The rule is autofixable -- if you run `eslint` with the `--fix` flag, your code will be formatted according to `prettier` style.
55+
56+
---
57+
58+
This plugin works best if you disable all other ESLint rules relating to code formatting, and only enable rules that detect patterns in the AST. (If another active ESLint rule disagrees with `prettier` about how code should be formatted, it will be impossible to avoid lint errors.) If your desired formatting does not match the `prettier` output (e.g. if you don't want semicolons), you should use a different tool such as [prettier-eslint](https://github.com/kentcdodds/prettier-eslint) instead.

0 commit comments

Comments
 (0)