@hnp/cz

Commitizen Adaptor, fully compatible with angular style.

Table of contents

• TLDR

• Installation

• Usage

  • Customization

• Changelog

• License

TLDR

Instead of git commit use git cz with @hnp/cz as the adaptor

Installation

npm install @hnp/cz --save-dev

Usage

If you havent already, install the Commitizen Cli tools:

npm install commitizen -g

Initialize your project to use the adapter by typing:

commitizen init @hnp/cz

The command will initialize the adapter and add the following to your package.json

{
    "config": {
        "commitizen": {
            "path": "@hnp/cz"
        }
    }
}

Now, can use git cz instead of git commit.

Pro TIP: set as default adapter for your projects

npm install --global @hnp/cz && echo '{ "path": "@hnp/cz" }' > ~/.czrc

Customization

You can customize the scopes on a project basis by adding a configuration section in your package.json:

{
    "config": {
        "scopes": ["home", "accounts", "ci"]
    }
}

Changelog

Find the CHANGELOG here, generated using Conventional Commits.

License

MIT © Jorge Proaño