> 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

$3

``bash
npm install --save-dev @hello-litebox/commit-prompt commitizen inquirer@8 # inquirer is required as peer dependency


or yarn


yarn add -D @hello-litebox/commit-prompt commitizen inquirer@8 # inquirer is required as peer dependency
`

In package.json

`json
{
"scripts": {
"commit": "git-cz"
},
"config": {
"commitizen": {
"path": "@hello-litebox/commit-prompt"
}
}
}
`

$3

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

`bash


Install commitlint cli and conventional config

npm install --save-dev @commitlint/config-conventional @commitlint/cli

or yarn

yarn add @commitlint/config-conventional @commitlint/cli -D

Simple: config with conventional

echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js
`

$3

`bash
git add .
npm run commit


or yarn


yarn commit
``

Related

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