create commit in human way.
# npm
npm install -g OwlTing/cz
# yarn
yarn global add OwlTing/cz
# pnpm
pnpm install -g OwlTing/cz
# bun
bun install -g OwlTing/czAdd
export PATH="$(yarn global bin):$PATH"to your~./zshrcif you installed it by yarn global
# Run tests in watch mode
pnpm test
# Run tests once
pnpm test:run
# Run tests with coverage
pnpm test:coverage
# Generate coverage badge
pnpm coverage:badgeThis project uses lefthook for pre-commit hooks that automatically run:
- Unit tests (
pnpm test:run) - TypeScript compilation check (
pnpm build)
# npm
npm update -g owlting_cz
# yarn
yarn global upgrade owlting_cz
# pnpm
pnpm update -g owlting_cz
# bun
bun update -g owlting_cz# npm
npm uninstall -g owlting_cz
# yarn
yarn global remove owlting_cz
# pnpm
pnpm uninstall -g owlting_cz
# bun
bun remove -g owlting_czcz [Options]Options:
--version Show version number
-i, --init Set default project prefix.
-w, --where Show config file path.
--help Show helpsupport OwlPay and OwlNest currently
cz -i
pick a commit type
cz
commit message
if need to tag Jira issue for title prefix
use default prefix
or select another project
input Jira issue ID
{
name: 'chore',
emoji: '🧹',
description: 'Build process or auxiliary tool changes',
value: 'chore'
},
{
name: 'ci',
emoji: '👷',
description: 'CI related changes',
value: 'ci'
},
{
name: 'docs',
emoji: '📝',
description: 'Documentation only changes',
value: 'docs'
},
{
name: 'feat',
emoji: '💡',
description: 'A new feature',
value: 'feat'
},
{
name: 'fix',
emoji: '🐛',
description: 'A bug fix',
value: 'fix'
},
{
name: 'hotfix',
emoji: '🚨',
description: 'Emergency fix',
value: 'hotfix'
},
{
name: 'perf',
emoji: '⚡',
description: 'A code change that improves performance',
value: 'perf'
},
{
name: 'refactor',
emoji: '🔨',
description: 'A code change that neither fixes a bug or adds a feature',
value: 'refactor'
},
{
name: 'release',
emoji: '🎉',
description: 'Create a release commit',
value: 'release'
},
{
name: 'style',
emoji: '🎨',
description: 'Markup, white-space, formatting, missing semi-colons...',
value: 'style'
},
{
name: 'test',
emoji: '🎮',
description: 'Adding missing tests',
value: 'test'
},
{
name: 'storybook',
emoji: '📚',
description: 'New storybook',
value: 'storybook'
},
{
name: 'revert',
emoji: '🔙',
description: 'Revert a commit',
value: 'revert'
}
Inspired by cz-cli
- adapt for other projects prefix
- unit test
- CLI