@catcuts-skills/commit
v1.0.8
Published
读取 staged 代码差异，自动生成符合 Conventional Commits 规范的提交文本
Maintainers
catcutsReadme
Commit Skill
自动生成符合 Conventional Commits 规范的提交信息。
项目简介
这是一个实用的 Claude Code 技能，能够读取 Git 暂存区的代码差异，自动生成符合 Conventional Commits 规范的提交信息。
功能特性
- 智能分析: 分析 Git 暂存区的代码差异
- 规范生成: 自动生成符合 Conventional Commits 规范的提交文本
- 类型识别: 识别 feat、fix、docs、style、refactor、test、chore 等提交类型
- 格式化输出: 提供清晰、规范的提交信息格式
安装方法
快速安装
从 npm 安装包时会自动将 skill 注册到 Opencode、Claude Code、Codex、Cursor 及其他 23 个工具。感谢 Vercel 开源的 skills 管理工具🌹
# 全局安装（推荐）
npm install -g @<your-username>/commit
# 项目级安装
npm install @<your-username>/commit本地开发安装
如果正在开发本 skill，可以使用 npm scripts 手动安装：
# 全局安装
npm run install:global
# 项目级安装
npm run install:local手动安装
如果自动安装失败，可以手动运行：
# 全局安装
npx skills . -a claude-code -g -y
# 项目级安装
npx skills . -a claude-code -y测试安装
运行测试以验证安装配置（不会实际安装）：
npm test卸载
重要：由于 npm 的限制，全局卸载时 preuninstall hook 可能不会执行。请按照以下步骤正确卸载：
方式 1：使用 npm scripts（推荐）
# 全局卸载
npm run uninstall:global
npm uninstall -g @catcuts-skills/commit
# 项目级卸载
npm run uninstall:local
npm uninstall @catcuts-skills/commit方式 2：手动清理（如果方式 1 失败）
# 1. 清理技能文件
rm -rf ~/.claude/skills/commit
rm -rf ~/.agents/skills/commit
# 2. 卸载 npm 包
npm uninstall -g @catcuts-skills/commitWindows PowerShell:
# 1. 清理技能文件
Remove-Item -Recurse -Force "$env:USERPROFILE\.claude\skills\commit"
Remove-Item -Recurse -Force "$env:USERPROFILE\.agents\skills\commit"
# 2. 卸载 npm 包
npm uninstall -g @catcuts-skills/commit为什么需要两步？
npm 的 preuninstall hook 在全局卸载时不保证被执行，这是 npm 的已知限制。因此需要先手动清理技能文件，再卸载 npm 包。
使用示例
安装完成后，在 Claude Code 中输入：
commit或者：
生成 commit message或者：
创建提交预期行为：
- 技能会执行
git diff --staged获取暂存区差异 - 分析代码变更的类型和范围
- 生成符合 Conventional Commits 规范的提交信息
- 提供格式化的输出供用户确认
示例输出：
feat(skill): 添加提交信息生成功能
- 分析 Git 暂存区的代码差异
- 识别变更类型和影响范围
- 生成符合规范的提交信息
Closes #123Conventional Commits 规范
本技能遵循 Conventional Commits 规范，支持以下提交类型：
| 类型 | 说明 | 示例 |
|------|------|------|
| feat | 新功能 | feat: 添加用户登录功能 |
| fix | 修复 bug | fix: 修复登录页面错误 |
| docs | 文档更新 | docs: 更新 README.md |
| style | 代码格式调整 | style: 统一代码缩进 |
| refactor | 重构代码 | refactor: 优化数据处理逻辑 |
| test | 测试相关 | test: 添加单元测试 |
| chore | 构建/工具相关 | chore: 更新依赖版本 |
提交信息格式：
<type>(<scope>): <subject>
<body>
<footer>技术细节
安装原理
本技能使用 Vercel 开源的 skills 工具进行安装管理，支持 Opencode、Claude Code、Codex、Cursor 及其他 23 个工具。
package.json中的postinstall钩子自动运行安装脚本- 安装脚本调用
add-skill将SKILL.md复制到目标目录 - Claude Code 自动检测并加载技能
安装路径
全局安装:
- 实际存储:
~/.agents/skills/commit/ - Claude Code 链接:
~/.claude/skills/commit/(符号链接)
项目级安装:
- 实际存储:
.agents/skills/commit/ - Claude Code 链接:
.claude/skills/commit/(符号链接)
项目结构
skills/commit/
├── package.json # NPM 包配置
├── SKILL.md # 技能定义文件
├── README.md # 使用文档
├── LICENSE # MIT 许可证
├── .gitignore # Git 忽略规则
└── scripts/
├── install-skill.js # 安装脚本
└── uninstall-skill.js # 卸载脚本系统要求
- Node.js >= 18.0.0
- npm >= 9.0.0
- Git
- Claude Code CLI
开发
本技能基于 agent-skill-npm-boilerplate 开发。
相关资源
许可证
MIT License - 详见 LICENSE 文件