Documentation also available in:
Because we love git hooks and npm, we want to share and automate code/content quality.
git-precommit-checks
has to be loaded manually or using any wrapper around git hooks.
As you can read below we highly recommend Husky.
npm install --save-dev git-precommit-checks
Configuration is loaded from package.json so you can customize it according to your needs.
Here is an example :
"git-precommit-checks": {
"rules": [
{
"filter": "\\.js$",
"nonBlocking": "true",
"message": "You’ve got leftover `console.log`",
"regex": "console\\.log"
},
{
"message": "You’ve got leftover conflict markers",
"regex": "/^[<>|=]{4,}/m"
},
{
"message": "You have unfinished devs",
"nonBlocking": "true",
"regex": "(?:FIXME|TODO)"
}
]
}
Each "pre-commit" entry is a checking rule: the pattern describes a regular expression that will be searched upon staged content. The associated message is displayed when the pattern is found.
Each rule will stop the commit when the associated pattern is found unless you set the nonBlocking
key to true
. Non blocking rules will print warning messages.
You can also filter on files patterns using the filter
key.
Only message
and regex
keys are mandatory.
You can add an optional display
entry in your config to enable some options:
"git-precommit-checks": {
"display": {
"notifications": true,
"offending-content": true,
"rules-summary": true,
"short-stats": true,
"verbose": true
},
…
notifications
: print error/warning summary using system notification.offending-content
: print offending contents right after associated file path and line number.rules-summary
: print rules as a table before parsing staged files.short-stats
: print short stats (ie.1 error, 1 warning.
).verbose
: print every performed action, files parsed, short summary/stats (errors and warnings number).
After installing locally or globally your module, add the following code (or equivalent) to your project pre-commit hook .git/hooks/pre-commit
:
#!/bin/sh
scriptName="git-precommit-checks"
scriptPath="$(npm bin)/$scriptName"
if [ -f $scriptPath ]; then
$scriptPath
else
echo "Can't find $scriptName module"
echo "You can reinstall it using 'npm install $scriptName --save-dev' or delete this hook"
fi
Husky is a great tool to manage git hooks from your package.json
.
You can use it and call git-precommit-checks
on pre-commit
:
"husky": {
"hooks": {
"pre-commit": "git-precommit-checks"
}
}
Any contribution is welcomed. Here is our contribution guideline