Skip to content

Commit 11154eb

Browse files
committed
docs(husky): Explain npm prepare script
1 parent b6b0aca commit 11154eb

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

package.json.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# [package.json](https://docs.npmjs.com/cli/v7/configuring-npm/package-json)
2+
3+
> This document serves as a replacement for comments in `package.json`, since it includes a lot of configuration often
4+
> requiring explanation.
5+
6+
- [scripts](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#scripts)
7+
- `prepare` Installs git hooks with husky. If install fails, it omits npm error
8+
(i.e. when installed with `npm install --omit=dev` and husky can not be found)
9+
through husky's suggested disabled ci settings
10+
(see: [disable husky with custom script](https://typicode.github.io/husky/#/?id=with-a-custom-script)).

0 commit comments

Comments
 (0)