Skip to content

Commit 1b830ae

Browse files
author
Alexander Lisianoi
committed
Specify path to commit message explicitly when being used with husky
Refs: #100
1 parent bcc33ac commit 1b830ae

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,15 +156,15 @@ When using commitplease together with [husky][3], the following will let husky m
156156
```json
157157
{
158158
"scripts": {
159-
"commitmsg": "commitplease"
159+
"commitmsg": "commitplease .git/COMMIT_EDITMSG"
160160
},
161161
"commitplease": {
162162
"nohook": true
163163
}
164164
}
165165
```
166166

167-
However, since husky does not use npm in silent mode (and there is [no easy way](https://github.com/typicode/husky/pull/47) to make it [do so](https://github.com/npm/npm/issues/5452)), there will be a lot of additional output when a message fails validation. Therefore, using commitplease alone is recommended.
167+
However, since husky does not use npm in silent mode (and there is [no easy way](https://github.com/typicode/husky/pull/47) to make it [do so](https://github.com/npm/npm/issues/5452)), there will be a lot of additional output when a message fails validation. Moreover, husky will run your `scripts` entry and nothing more, so you have to [specify everything yourself](https://github.com/jzaefferer/commitplease/issues/100) (e.g. the path to the commit message file). Therefore, using commitplease alone is recommended.
168168

169169
## API
170170

0 commit comments

Comments
 (0)