https://github.com/charlzyx/gocz
https://github.com/charlzyx/gocz
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/charlzyx/gocz
- Owner: charlzyx
- Created: 2024-12-17T01:11:20.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-12-30T13:37:59.000Z (5 months ago)
- Last Synced: 2025-02-11T17:15:57.054Z (4 months ago)
- Language: Go
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gocz
一个简单的命令行工具，用于生成规范的 git commit message / A simple CLI tool for generating standardized git commit messages.
基本都是从 [muandane/goji](https://github.com/muandane/goji) 抄的, 但是我用不到那么多功能, 根据我的使用习惯改了一下
> Commitizen-like Emoji Commit Tool written in Go (think cz-emoji and other commitizen adapters but in go) 🚀
## 特性 / Features
- 🎯 交互式提交信息生成 / Interactive commit message generation
- 🌈 支持 emoji 表情符号 / Emoji support
- 🔍 智能范围检测 (packages/_) / Smart scope detection (packages/_)
- 🎨 双语界面 (中文/英文) / Bilingual interface (Chinese/English)
- ⚙️ 可自定义配置 / Customizable configuration
## 安装 / Installation
```bash
curl -sSL https://raw.githubusercontent.com/charlzyx/gocz/refs/heads/master/install.sh | bash
```
或者自己 build 吧
> 源码
```bash
# 克隆仓库 / Clone repository
git clone https://github.com/charlzyx/gocz.git
cd gocz
# 安装依赖 / Install dependencies
go mod tidy
# 本地构建 / Local build
go build
```
## 配置 / Configuration
> 其实就是 changelogen 的 json 文件里面的 types 字段
工具会按以下顺序查找配置文件：
1. 当前目录的 `changelog.config.json`
2. 用户目录的 `~/.changelog.config.json`
3. 内置的默认配置
配置文件示例 / Configuration example:
```json
{
"types": {
"feat": {
"semver": "minor",
"title": "🚀 增强功能 / Enhancements"
},
"fix": {
"semver": "patch",
"title": "🩹 修复问题 / Fixes"
},
"perf": {
"semver": "patch",
"title": "🔥 性能优化 / Performance"
},
"refactor": {
"semver": "patch",
"title": "⚡ 代码重构 / Refactors"
},
"chore": {
"title": "🏡 杂务处理 / Chore"
},
"ci": {
"title": "🤖 持续集成 / CI"
},
"docs": {
"semver": "patch",
"title": "📖 文档更新 / Documentation"
},
"style": {
"title": "💅 代码风格 / Styles"
},
"test": {
"title": "✅ 测试用例 / Tests"
},
"wip": {
"title": "🚧 未完成 / Work in Progress"
}
}
}
```