@endemolshinegroup/git-author-check

@endemolshinegroup/git-author-check

A pre-commit tool that validates the commit authors' email address.

Installation

yarn add -D husky @endemolshinegroup/git-author-check

Usage

This package uses Cosmiconfig to load its' configuration, so you can add a configuration file in one of the following ways:

• a gitauthorcheck property in package.json

{
  "gitauthorcheck": {
    "allowedDomains": [
      "endemolshine.com"
    ]
  },
}

• a .gitauthorcheckrc file in JSON or YAML format
• a .gitauthorcheckrc.json file
• a .gitauthorcheckrc.yaml, .gitauthorcheckrc.yml, or .gitauthorcheckrc.js file
• a gitauthorcheck.config.js or gitauthorcheck.config.ts file exporting a JS object

{
  "allowedDomains": [
    "endemolshine.com"
  ]
}

Then add the following to your Husky configuration file:

{
  "hooks": {
    "pre-commit": "git-author-check"
  }
}

Changelog

1.0.1 (2018-11-01)

Bug Fixes

• cli: execute run function in CLI script (cf8e274)
• config: use correct package name (a12d57f)

Features

• refactor and full implementation of main functionality (c82ebb6)