madoka-opencode-git-check
v0.1.3
Published
OpenCode 插件 — 一键扫描、分类、审查并提交代码
Readme
madoka-opencode-git-check
OpenCode 插件 — 一键扫描、分类、审查并提交代码
为 OpenCode 提供完整的 Git 工作流能力:扫描工作目录、智能分类、预提交质量检查、暂存/提交、以及 .gitignore 智能生成。
功能
- 智能分类:按 8 类自动归类变更文件(源码、配置、文档、测试、样式、资源、构建产物、其他),标注状态与增删行统计
- 预提交检查:检测冲突标记、调试语句、敏感信息、大文件、TODO 标记,并自动运行项目 lint
- 安全落盘:
gitignore_write使用fs.writeFile直接写入,避免 shell 转义问题 - 跨平台:基于
node:fs与git -C实现,不依赖 bash,Windows / macOS / Linux 通用 - UTF-8:全量 UTF-8 编码,中文提交信息无乱码
工具
| 工具 | 说明 |
|------|------|
| git_scan | 扫描工作目录所有变更并按 8 类自动分类 |
| git_stage | git add 全部或指定文件 |
| pre_commit_check | 检查暂存区(冲突/调试/敏感信息/TODO/大文件/lint)+ 返回 diff |
| git_commit | git commit -m 仅本地提交,不推送 |
| gitignore_scan | 扫描项目结构,给出 .gitignore 建议 |
| gitignore_write | 写入 .gitignore |
命令
| 命令 | 说明 |
|------|------|
| /commit | 中文提交流程(扫描 → 分类 → 暂存 → 检查 → 审查 → 提交) |
| /commit:en | 英文提交流程 |
| /gitignore | 生成 .gitignore 流程 |
安装
发布后
在你的 opencode.json 中添加:
{ "plugin": ["madoka-opencode-git-check"] }本地开发 / 调试
{ "$schema": "https://opencode.ai/config.json", "plugin": ["./dist/index.js"] }本地开发
npm install
npm run build # 输出 dist/
npm run dev # watch
npm run typecheck # 类型检查项目结构
src/
index.ts # 插件入口:注册 config + 6 tools + 3 commands
lib/
scanner.ts # git_scan 逻辑 + 分类/格式化
checks.ts # pre_commit_check 逻辑
stage.ts # git_stage
commit.ts # git_commit
ignore.ts # gitignore_scan/write协议
MIT
