/clubhouse-lint

A utility to check for correctly formatted commits

Primary LanguageTypeScriptMIT LicenseMIT

echo karriere clubhouse-lint

GitHub Actions Status npm

Husky hook for checking the commit message format

Table of Contents

Table of Contents

What

We use Clubhouse as our project management tool and to ensure that commit messages are consistent we made this utility to check commit messages when committing.

Usage

To use you need to have husky installed, then install this package: yarn add -D @echo-karriere/clubhouse-lint. Update the husky configuration:

"husky": {
  "hooks": {
    "commit-msg": "clubhouse-lint"
  }
},

Developing

Run yarn to install packages and then yarn dev to start developing.

To start developing simply run yarn start to start the development server.

test

To test our code run yarn test. You should also ensure that the code you've written is up to spec with yarn lint:ts and yarn lint:style.

LICENSE

MIT.