commit-message-validator
Advanced tools
Comparing version 0.1.3 to 0.1.4
{ | ||
"name": "commit-message-validator", | ||
"version": "0.1.3", | ||
"version": "0.1.4", | ||
"description": "Git commit-msg hook validator", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
# commit-message-validator | ||
Git commit-msg hook validator | ||
Git commit-msg validator | ||
This package provides you a binary that you can use as a git hook to validate the commit message. | ||
If you are using githook package such as [husky](https://www.npmjs.com/package/husky), add `"commitmsg": "commit-message-validator"` to your npm scripts in package.json. | ||
This package can be used with githook packages such as [husky](https://www.npmjs.com/package/husky). | ||
If you are using **husky**, add `"commitmsg": "commit-message-validator"` to your npm scripts in package.json. | ||
# Installation | ||
@@ -18,5 +20,12 @@ | ||
2. Install githook [husky](https://www.npmjs.com/package/husky) | ||
3. Custom commit-message regex pattern in package.json | ||
3. Config commit-msg hook to run commit-message-validator in package.json | ||
{ | ||
scripts: { | ||
"commitmsg": "commit-message-validator" | ||
} | ||
} | ||
4. Custom commit-message regex pattern in package.json | ||
{ | ||
"config": { | ||
@@ -29,2 +38,19 @@ "commit-message-validator": { | ||
} | ||
Or | ||
{ | ||
"config": { | ||
"commit-message-validator": { | ||
/* your config here, pattern can be an array */ | ||
"pattern": [ | ||
"pattern1", | ||
"pattern2", | ||
/* ... */ | ||
"pattern N" | ||
] | ||
} | ||
} | ||
} | ||
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
6749
54