跳转到主要内容
手动执行编码标准既耗时又不一致。不同的审查者发现不同的问题,约定会随时间漂移。解决方案是将标准编码为在每个 PR 上自动运行的规则。

如何使用 Kodus

Kodus 让您定义 Kody 规则 — 在每次代码审查中自动检查的自定义指令。有两种类型:
  • 审查规则在代码审查期间运行,分析文件差异或整个 PR 以检查您的标准
  • 记忆是持久的约定,Kody 在所有交互中应用 — 代码审查、对话和建议

示例:执行命名约定

您可以创建文件级规则:
  • 规则: “React 组件必须使用 PascalCase 文件名”
  • 路径: src/components/**/*.tsx
  • 严重性: 高
  • 说明: “标记不遵循 PascalCase 命名的组件文件。“

示例:执行架构边界

PR 级规则可以验证跨文件关注点:
  • 规则: “领域层不得从基础设施层导入”
  • 范围: 拉取请求
  • 说明: “检查 pr_files_diffsrc/domain/ 中引用 src/infrastructure/ 的任何导入语句。这违反了我们的六边形架构。“

其他方法

您还可以通过以下方式执行标准:
  • 从规则库导入 — 浏览预建的安全、性能和风格规则
  • 同步 IDE 规则 — 自动从 Cursor、Copilot、Claude 和其他 AI 工具导入规则
  • 代码库规则 — 直接在代码库中以 markdown 文件定义规则(kodus/rules/
  • 自动生成规则 — 让 Kody 分析 3 个月的审查历史并根据团队模式建议规则

开始使用

  1. 前往代码审查设置Kody 规则
  2. 点击添加规则并定义您的标准
  3. 设置路径、严重性和详细说明
  4. Kody 将在未来的每个 PR 上执行
更多详情,请参阅 Kody 规则文档