Skip to content

Commit 5e5da89

Browse files
committed
Update README and add config file documentation
1 parent 5a58625 commit 5e5da89

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,23 @@ or as `"pre-commit.{key}` key properties in the `package.json`:
113113
}
114114
```
115115

116+
Configuration can also be defined inside a standalone `.pre-commit.json` config file:
117+
118+
```js
119+
{
120+
"silent": true,
121+
"colors": true,
122+
"template": "./temp",
123+
"run": [
124+
"lint",
125+
"test"
126+
]
127+
}
128+
```
129+
130+
The contents of `.pre-commit.json` will be used in the place of whatever was defined in the `pre-commit`
131+
or `precommit` property inside `package.json`.
132+
116133
It's all the same. Different styles so use what matches your project. To learn
117134
more about the scripts, please read the official `npm` documentation:
118135

0 commit comments

Comments
 (0)