cz-cli

Deprecated

This package has been depreated because:

• commitizen now supports git commit workflow by using git hooks and the --hook command-line option.
• commitizen also allows you to configure an adapter to use in package.json, .czrc or .cz.json.

---

commitizen CLI and the adapters as local dependencies.

The commitizen adapter that is used when you commit your changes is determined based on the following steps.

1. If config.commitizen.path exists in your package.json, the config and the adapter are used.

2. If config.cz-customizable.config exists in your package.json, the config and cz-customizable are used.

3. If .cz-config.js exists in the current working directory or the ancestors, the .cz-config.js and cz-customizable are used.

4. Otherwise cz-conventional-changelog is used.

Installation

Install @whizark/cz-cli as a local dependency.

npm install @whizark/cz-cli --save-dev

Usage

Add scripts.commit to your package.json.

{
    "scripts": {
        "commit": "git cz"
    }
}

When you want to commit your changes, all you need to do is type the following command.

npm run commit

As a shortcut, you might type the following command with npm-quick-run.

nr commit

Or you can run git command with npm-run.

npm-run git cz

In this case, you need not add scripts.commit into your package.json.