Skip to content

Commit db508d7

Browse files
Docs: add 2.0.0 migration guide
1 parent d8a8992 commit db508d7

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,13 @@ The rule will report an error if your code does not match `prettier` style. The
6262
---
6363

6464
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.
65+
66+
## Migrating to 2.0.0
67+
68+
Starting in 2.0.0, `prettier` is a peerDependency of this module, rather than a dependency. This means that you can use any version of `prettier` with this plugin, but it also means that you need to install it separately and include it as a devDependency in your project.
69+
70+
To install `prettier`, use:
71+
72+
```bash
73+
npm install prettier --save-dev
74+
```

0 commit comments

Comments
 (0)