Skip to content

Commit 905201b

Browse files
committed
fix(README): fix for quotes, additional config
Fix package.son configuration, to use proper double quotes. Add lineLength parameter
1 parent ebaf1d4 commit 905201b

1 file changed

Lines changed: 16 additions & 13 deletions

File tree

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,22 +27,23 @@ This will replace commit-msg in your .git/hooks folder with code, that will run
2727
Configuration is simple and is done in `package.json`, you just need to add git-commit-msg object:
2828

2929
```js
30-
"git-commit-msg": {
31-
types: [
32-
'feat',
33-
'fix',
34-
'chore',
35-
'docs',
36-
'refactor',
37-
'style',
38-
'perf',
39-
'test',
40-
'revert'
41-
]
30+
"git-commit-hook": {
31+
"types": [
32+
"feat",
33+
"fix",
34+
"chore",
35+
"docs",
36+
"refactor",
37+
"style",
38+
"perf",
39+
"test",
40+
"revert"
41+
],
42+
"lineLength": 72
4243
}
4344
```
4445

45-
This will add rules, so your git commit messages must start using those types like
46+
git-commit-hook.types (array of strings) will add rules, so your git commit messages must start using those types like
4647
```
4748
feat: <message>
4849
```
@@ -53,4 +54,6 @@ or
5354
feat(scope/filename): <message>
5455
```
5556

57+
git-commit-hook.lineLength (integer) will make sure that lines in your commit message are always less or equal to the number you set into this config
58+
5659
This package is WIP, so propose your ideas - open issue or create pull request.

0 commit comments

Comments
 (0)