Check staged contents before commiting

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.

Install

npm i --save-dev git-precommit-checks

How to setup my checking rules?

Configuration is loaded from package.json so you extend it :

"hooks": {
  "pre-commit": [
    {
      "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.

⚠️ There is no default checks configured after install, so please be aware that nothing will happend without adding your own rules!

Recommendations

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"
    }
  }