跳转到主要内容
每个团队都有通用 linter 无法覆盖的约定 — 架构边界、命名模式、测试要求或业务特定约束。自定义代码审查规则让您将这些编码为自动检查。

在 Kodus 中创建规则

  1. 前往代码审查设置Kody 规则
  2. 点击添加规则
  3. 配置:
    • 名称 — 规则检查的内容(例如,“服务文件必须有测试”)
    • 范围 — 文件级(分析单个文件)或 PR 级(分析整个 PR)
    • 路径 — glob 模式以针对特定文件(例如,src/services/**/*.ts
    • 严重性 — 严重、高、中等或低
    • 说明 — 要检查内容的详细描述

规则的强大之处

规则可以访问丰富的上下文:
  • fileDiffpr_titlepr_descriptionpr_files_diff变量
  • 使用 @file:path/to/file.ts文件引用与模式进行比较
  • MCP 函数从连接的工具(Jira、代码库结构等)获取数据

示例:架构边界规则

名称:领域层不得依赖基础设施
范围:拉取请求
说明:检查 pr_files_diff 中 src/domain/
中引用 src/infrastructure/ 的任何导入。
参考 @file:docs/architecture.md 了解允许的依赖关系。

示例:测试覆盖规则

名称:每个服务必须有测试文件
范围:拉取请求
说明:对于 src/services/ 中修改的每个文件,
验证 test/services/ 中是否存在相应的测试文件。
使用 MCP 检查代码库文件树。

更多添加规则的方式

  • 从规则库导入 — 按语言和类别浏览经过验证的规则
  • 从 IDE 工具同步 — 自动从 Cursor、Copilot、Claude 导入规则
  • 代码库规则 — 在代码库中以 markdown 文件定义规则
  • 自动生成 — Kody 根据您的审查历史建议规则
完整参考,请参阅 Kody 规则