CommitGuard

CommitGuard：提交瞬间的 AI 逻辑审查 🎯

CommitGuard 就像一个智能逻辑检查器，专注于代码逻辑，在你提交的瞬间即时捕捉 Bug 与不良模式 —— 早于推送、早于 CI、无人察觉。它以闪电般的速度，只分析实际变更，提供清晰、可执行的建议。

✨ 隐私至上：你的代码永远不会被存储。我们仅实时分析变更差异，之后不留任何痕迹。

---

🚀 快速开始，无缝集成

只需几分钟，即可为任何 Git 仓库开启守护：

1. 安装：运行 npm install -g @commitguard/cli，一次安装，全局使用。
2. 初始化：在项目目录下运行 commitguard init，5 秒内自动设置好 Git 钩子。
3. 配置（可选）：运行 commitguard config 自定义规则，或直接使用智能默认值。
4. 提交：像往常一样使用 git commit，CommitGuard 将自动在每次提交时运行。
5. 静默守护：默认只标记有风险的变更。你可以选择修复，或使用 --skip 标记覆盖并继续推送。

---

🛡️ 全面守护你的代码质量

• 安全检查：捕获暴露的 API 密钥、调试密码等安全隐患。
• 架构检查：防止结构性反模式和可能成为技术债的循环依赖。
• 代码质量检查：拦截调试语句、合并冲突、无上下文的 TODO 等不应发布的代码。
• 性能检查：在影响用户之前，检测出缓慢或阻塞的代码模式。

💪 专为开发者设计

• 友好覆盖：需要时可通过 --skip 标志或交互选项绕过检查。
• 完全可配置：启用、禁用或自定义规则，以适应你的项目和团队标准。
• 自定义规则：为你团队的命名规范、特定模式或需求创建自己的规则。
• 零设置保护：智能默认值提供即时保护，无需配置文件。

---

💡 为什么需要更早的审查？

传统的 PR 审查反馈往往太迟，淹没在噪音中。CommitGuard 在问题刚引入、修复成本最低时介入。

• 即时反馈 vs. 延迟反馈：提交时立即获得“循环中检测到数组查找”提示，而不是三天后 PR 里的“这里该用 Map”。
• 防止 Bug 累积：在 2 个文件的提交中捕获问题，而不是等它隐藏在有 47 个文件的 PR 合并后才被发现。
• 聚焦小改动：审查每个小提交，比一次性审查大量文件更专注、高效。
• 立即学习与调整：在错误首次出现时就抓住它，立即调整编码方式，防止在同一问题上反复犯错。
• 编码团队智慧：将“部落知识”转化为规则（如“控制器中禁止直接数据库查询”），让审查自动化。
• 适应你的风格：工具可以学习并适应你团队偏好的模式（例如组合优于继承）。

---

🔧 自定义规则示例

你可以创建自定义提示，让 CommitGuard 检查对团队至关重要的特定事项：

检查公共 API 兼容性：如果本次变更涉及函数输入或返回值的修改，验证公共合约是否保持兼容或已被破坏。

保持代码风格一致：根据文件现有风格，标记破坏既定模式的新逻辑（如提前返回 vs. 嵌套条件判断）。

防止功能蔓延：标记那些为现有函数引入新职责（而非最小化扩展）的变更。

---

⚙️ 工作原理与隐私承诺

• 仅分析你的变更差异，而非整个代码库。
• 分析过程实时进行，零存储、零缓存、零保留。
• 你的代码永远不会被用于训练 AI 模型。
• 我们从不出售或商业化你的任何数据。

CommitGuard 在你编写代码时默默守护，直到你犯错，才会发现它的价值。