@agnilabs/conv-commit-liner
v0.0.3
Published
A lightweight conventional commit message generator
Downloads
168
Maintainers
Readme
@agnilabs/conv-commit-liner
A lightweight conventional commit message generator that analyzes your staged changes and suggests appropriate commit messages.
Installation
# Using npm
npm install -g @agnilabs/conv-commit-liner
# Using bun
bun install -g @agnilabs/conv-commit-liner
Usage
After staging your changes with git add
, simply run:
ccl
This will analyze your staged changes and suggest an appropriate conventional commit message.
Options
-s, --scope <scope>
: Specify the commit scope-b, --breaking
: Mark as a breaking change-t, --type <type>
: Override the commit type
Examples
# Basic usage
ccl
# With scope
ccl -s api
# Breaking change
ccl -b
# Override type
ccl -t feat
# Combine options
ccl -t fix -s auth -b
Commit Types
The tool automatically determines the commit type based on the changed files:
test
: Changes to test filesdocs
: Changes to documentationchore
: Changes to package filesci
: Changes to CI configurationfeat
: Default for other changes
License
MIT