Install as development dependencies:
pnpm add -D @we-mobius/commitizen
Using pnpm exec commit
to commit your changes.
Or using pnpm exec cz
to commit your changes, equipped with commitizen
's functionality.
Install commitlint
and husky
as development dependencies:
pnpm dlx husky-init
pnpm install
pnpm add -D @commitlint/cli@latest
Using husky's command to add commitlint
as commit-msg
git hooks:
pnpm exec husky add .husky/commit-msg 'pnpm exec commitlint --edit ${1}'
Create a commitlint
config file named .commitlintrc.json
in the root directory of your project, with the following content:
{
"extends": "@we-mobius/commitizen/commitlint"
}
Done, here we go, run git add .
and pnpm exec cz
to commit our changes.
Don't forget to add Commitizen friendly badge to your README.md
:
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
- [ ] Support fine-grained instructions for breaking parts and issue parts, see @commitlint/config-conventional.
- [ ] Respect the
commitlint
configurations in the workspace root or the project root, usingcommitlint
configurations to change thecommitizen
configurations. - [ ] Add
commitizen-init
command to initialize thecommitizen
-related configurations, including install necessary dependencies, addingcommitlint
configurations, adding git hooks, and so on. Then users can usepnpm dlx commitizen-init
to get started, everything just works. - [ ] Reading
commitizen.config.js
to get the configurations; or reading configurations from validcommitlint
config files. Functionalitiescommitlint
provided will be integrated into Mobius Commitizen in the future, socommitizen.config.js
will be the first config choice.
- Built with Commitizen.
- Derived from cz-customizable.
- Inspired by cz-conventional-changelog, cz-emoji
- Compatible with commitlint