Skip to content

Commit

Permalink
Docs: suggest prettier-eslint if eslint rules disagree with prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
not-an-aardvark committed Jan 27, 2017
1 parent b68bf12 commit 3414437
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,7 @@ You can also pass `prettier` configuration as an option:
```

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.

---

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.

This comment has been minimized.

Copy link
@kentcdodds

kentcdodds Jan 29, 2017

Member

πŸ‘ thanks for the mention πŸ‘ OSS FTW!

0 comments on commit 3414437

Please sign in to comment.