22
33** @fastify/pre-commit ** is a pre-commit hook installer for ` git ` . It will ensure that
44your ` npm test ` (or other specified scripts) passes before you can commit your
5- changes. This all conveniently configured in your ` package.json ` .
5+ changes. This is all conveniently configured in your ` package.json ` .
66
77But don't worry, you can still force a commit by telling ` git ` to skip the
88` pre-commit ` hooks by simply committing using ` --no-verify ` .
@@ -38,7 +38,7 @@ could ensure that:
3838- Contribution licenses signed etc.
3939
4040The only thing you need to do is add a ` pre-commit ` array to your ` package.json `
41- that specifies which scripts you want to have ran and in which order:
41+ that specifies which scripts you want to run and in which order:
4242
4343``` js
4444{
@@ -59,8 +59,8 @@ that specifies which scripts you want to have ran and in which order:
5959}
6060```
6161
62- In the example above, it will first run: ` npm run foo ` then ` npm run bar ` and
63- finally ` npm run test ` which will make the commit fail as it returns the error
62+ In the example above, it will first run: ` npm run foo ` then ` npm run bar ` , and
63+ finally, ` npm run test ` which will make the commit fail as it returns the error
6464code ` 1 ` . If you prefer strings over arrays or ` precommit ` without a middle
6565dash, that also works:
6666
@@ -86,12 +86,12 @@ dash, that also works:
8686```
8787
8888The examples above are all the same. In addition to configuring which scripts
89- should be ran you can also configure the following options:
89+ should be run you can also configure the following options:
9090
9191- ** silent** Don't output the prefixed ` pre-commit: ` messages when things fail
9292 or when we have nothing to run. Should be a boolean.
9393- ** colors** Don't output colors when we write messages. Should be a boolean.
94- - ** template** Path to a file who's content should be used as template for the
94+ - ** template** Path to a file whose content should be used as a template for the
9595 git commit body.
9696
9797These options can either be added in the ` pre-commit ` /` precommit ` object as keys
@@ -120,10 +120,10 @@ Configuration can also be defined inside a standalone `.pre-commit.json` config
120120}
121121```
122122
123- The contents of ` .pre-commit.json ` will be used in the place of whatever was defined in the ` pre-commit `
123+ The contents of ` .pre-commit.json ` will be used in place of whatever was defined in the ` pre-commit `
124124or ` precommit ` property inside ` package.json ` .
125125
126- It's all the same. Different styles so use what matches your project. To learn
126+ It is all the same. Different styles so use what matches your project. To learn
127127more about the scripts, please read the official ` npm ` documentation:
128128
129129https://docs.npmjs.com/misc/scripts
@@ -132,9 +132,9 @@ And to learn more about git hooks read:
132132
133133http://githooks.com
134134
135- ### License
135+ ## License
136136
137- MIT
137+ Licensed under [ MIT] ( ./LICENSE ) .
138138
139139### Attribution
140140
0 commit comments