cz-convention

forked from ngryman/cz-emoji to suit my taste.

Single Line Installation

Run the following to install/update this tool:

curl -fsSL https://raw.githubusercontent.com/ShafiqIslam/cz-convention/main/install.sh | bash

Manual Installation

Install commitizen

npm install -g commitizen

Install this adapter

Global Level (to use on any project)

npm install -g @polygontech/cz-convention

Then, Reference it:

echo '{ "path": "@polygontech/cz-convention" }' > ~/.czrc

Or, Project Level (to use on only that project)

npm install @polygontech/cz-convention

Then, Reference it in your package.json of your project

  ...
  "config": {
    "commitizen": {
      "path": "node_modules/@polygontech/cz-convention/"
    }
  }
  ...

Usage

Traditionally,

# for minimal version:
git cz

# or the full version
git cz --full

With husky, in your runcom .huskyrc or .huskyrc.js:

{
  "hooks": {
    ...
    "prepare-commit-msg": "exec < /dev/tty && git cz --hook",
    ...
  }
}