メインコンテンツへスキップ
すべてのチームには、汎用のリンターではカバーできない規約があります — アーキテクチャの境界、命名パターン、テスト要件、またはビジネス固有の制約など。カスタムコードレビュールールを使用すると、これらを自動チェックとしてエンコードできます。

Kodusでルールを作成する

  1. コードレビュー設定Kodyルール に移動します
  2. ルールを追加 をクリックします
  3. 設定します:
    • 名前 — ルールが確認する内容(例:「サービスファイルにはテストが必要です」)
    • スコープ — ファイルレベル(個々のファイルを分析)またはPRレベル(PR全体を分析)
    • パス — 特定のファイルを対象とするglobパターン(例:src/services/**/*.ts
    • 重要度 — 重大、高、中、または低
    • 指示 — チェックする内容の詳細な説明

ルールを強力にするもの

ルールはリッチなコンテキストにアクセスできます:
  • fileDiffpr_titlepr_descriptionpr_files_diff などの変数
  • パターンと比較するための @file:path/to/file.ts によるファイル参照
  • 接続されたツール(Jira、リポジトリ構造など)からデータを取得するMCP関数

例:アーキテクチャ境界ルール

名前: ドメイン層はインフラストラクチャに依存してはいけません
スコープ: プルリクエスト
指示: pr_files_diffでsrc/domain/内のsrc/infrastructure/を参照するimportを確認します。
許可された依存関係については@file:docs/architecture.mdを参照してください。

例:テストカバレッジルール

名前: すべてのサービスにテストファイルが必要です
スコープ: プルリクエスト
指示: src/services/内で変更された各ファイルについて、
対応するテストファイルがtest/services/に存在することを確認します。
MCPを使用してリポジトリのファイルツリーを確認します。

ルールを追加するその他の方法

  • ルールライブラリからインポート — 言語とカテゴリ別に検証済みルールを参照
  • IDEツールから同期 — Cursor、Copilot、Claudeからルールを自動インポート
  • リポジトリルール — リポジトリ内のmarkdownファイルでルールを定義
  • 自動生成 — Kodyがレビュー履歴に基づいてルールを提案
完全なリファレンスについては、Kodyルールを参照してください。