vitalif-js
/
prettier
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: Add simplified installation instructions for lint-staged (#5911) 

* docs: Add simplified installation instructions for lint-staged

Currently, to install and configure lint-staged you'd need to manually install all packaged and modify the `package.json`. 
With `mrm` it's done automatically depending on what version of Prettier is installed and specified in project's dependencies.

* docs: Update according to feedback

* Update docs/precommit.md

Co-Authored-By: okonet <okonet@users.noreply.github.com>
master
Andrey Okonetchnikov 2019-03-12 17:01:13 +01:00 committed by Jed Fox
parent b38319740a
commit 8a8b88f2e6
1 changed files with 4 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/precommit.md
View File

@ -7,28 +7,15 @@ You can use Prettier with a pre-commit tool. This can re-format your files that
## Option 1. [lint-staged](https://github.com/okonet/lint-staged)
**Use Case:** Useful for when you need to use other tools on top of Prettier (e.g. ESLint)
**Use Case:** Useful for when you want to use other code quality tools along with Prettier (e.g. ESLint, Stylelint, etc.) or if you need support for partially staged files (`git add --patch`).
Install it along with [husky](https://github.com/typicode/husky):
_Make sure Prettier is installed and is in your `devDependencies` before you proceed._
```bash
yarn add lint-staged husky --dev
npx mrm lint-staged
```
and add this config to your `package.json`:
```json
{
"husky": {
"hooks": {
"pre-commit": "lint-staged"
}
},
"lint-staged": {
"*.{js,json,css,md}": ["prettier --write", "git add"]
}
}
```
This will install [husky](https://github.com/typicode/husky) and [lint-staged](https://github.com/okonet/lint-staged), then add a configuration to the project’s `package.json` that will automatically format supported files in a pre-commit hook.
See https://github.com/okonet/lint-staged#configuration for more details about how you can configure lint-staged.