Mini-cz is a tiny commitizen alternative.
- Commitizen alternative, but much smaller
- Supports commit types
- Supports commit scopes
- Extensible configuration
$ npm install mini-cz -D
$ yarn add mini-cz -D
$ pnpm install mini-cz -D
# install default config; or you can use your own config
$ npm install @mini-cz/config-default -D
$ yarn add @mini-cz/config-default -D
$ pnpm install @mini-cz/config-default -DFirst create a mini-cz.config.ts in your workspace root.
// mini-cz.config.tsexport{default}from"@mini-cz/config-default";Then add a script to your package.json:
{
"scripts": {
"commit": "mini-cz"
}
}Finally, run npm run commit, yarn commit or pnpm commit to start the commit process.
You can configure mini-cz by creating a mini-cz.config.ts file in your workspace root.
// mini-cz.config.tsimport{defineConfig}from"mini-cz";exportdefaultdefineConfig({// This is @mini-cz/config-defaultkinds: [{name: "feat",description: "A new feature",emoji: "✨",},{name: "fix",description: "A bug fix",emoji: "🐛",},{name: "docs",description: "Documentation only changes",emoji: "📚",},{name: "style",description:
"Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)",emoji: "💎",},{name: "refactor",description: "A code change that neither fixes a bug nor adds a feature",emoji: "📦",},{name: "perf",description: "A code change that improves performance",emoji: "🚀",},{name: "test",description: "Adding missing tests or correcting existing tests",emoji: "🚨",},{name: "chore",description:
"Changes that do not modify src or test files. Such as updating build tasks, package manager configs, etc.",emoji: "🤖",},],// And you can add some scopescopes: ["core","config-default"],});