@ronnieacs/cz-conventional-commit v5.0.3

cz-conventional-commit

commitizen adapter following the conventional-changelog format, with emojis and additionnal commit types (aliases).

Install as a global utility

npm install --global commitizen @ronnieacs/cz-conventional-commit

Create a .czrc file in your home directory, with the following content:

{
  "path": "@ronnieacs/cz-conventional-commit",
  "cz-conventional-commit": {
    "maxSubjectLength": 72,
    "bodyLineLength": 100
  }
}

Now cd into any git repository and use git cz instead of git commit and you will find the commitizen prompt.

See commitizen documentation for more informations.

Making your repo Commitizen-friendly

npm install --save-dev commitizen @ronnieacs/cz-conventional-commit
./node_modules/.bin/commitizen init @ronnieacs/cz-conventional-commit --save-dev

You can customize cz-conventional-commit in package.json:

...
"config": {
  "commitizen": {
    "path": "@ronnieacs/cz-conventional-commit",
    "cz-conventional-commit": {
      "maxSubjectLength": 72,
      "bodyLineLength": 100,
      "emoji": true
    }
  }
}
...

See commitizen documentation for more informations.

Options

Commit types

Commit aliases

Aliases are additionnal commit types that will be formatted to follow AngularJS Commit Message Conventions and automatically set some fields.

For example when choosing initial, cz-conventional-commit will automatically set:

• the standard type to feat
• the scope to empty
• the subject to 'Initial commit 🎉'
• the issues to empty
• the breaking to empty

The commit message will be feat: Initial commit 🎉.

Related

• conventional-changelog-metahub - List of conventional commit types and aliases for this module