@endemolshinegroup/git-author-check
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

@endemolshinegroup/git-author-check

MIT Licensed NPM Version Build Status Greenkeeper Status

Code Issues Codebase Maintainability Test Coverage Jest

Commitizen Semantic Release Prettier

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

Readme

Keywords

none

Package Sidebar

Install

npm i @endemolshinegroup/git-author-check

Weekly Downloads

0

Version

1.0.1

License

MIT

Unpacked Size

256 kB

Total Files

38

Last publish

Collaborators

  • hassankhan
  • endemolshinegroupbot