Commitizen adapter using the commitlint.config.js

@hello-litebox/commit-prompt

This is a commitizen adapter, using this adapter, commitizen works based on commitlint.config.js.

Submit by commitizen, lint by commitlint, just need maintain one configuration file, Consistent and Scalable.

The interactive process is inspired by cz-conventional-changelog.

Getting started

Configure commitizen adapter

1npm install --save-dev @hello-litebox/commit-prompt commitizen inquirer@8  # inquirer is required as peer dependency
2# or yarn
3yarn add -D @hello-litebox/commit-prompt commitizen inquirer@8             # inquirer is required as peer dependency

In package.json

1{
2  "scripts": {
3    "commit": "git-cz"
4  },
5  "config": {
6    "commitizen": {
7      "path": "@hello-litebox/commit-prompt"
8    }
9  }
10}

Configure commitlint

⚠️ Important: The required version of commitlint and shared configuration is above 12.1.2, update them if already existed in project

1# Install commitlint cli and conventional config
2npm install --save-dev @commitlint/config-conventional @commitlint/cli
3# or yarn
4yarn add @commitlint/config-conventional @commitlint/cli -D
5
6# Simple: config with conventional
7echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js

Try it out

1git add .
2npm run commit
3# or yarn
4yarn commit

Related

• Commitlint Reference Prompt - How to customize prompt information by setting commitlint.config.js