リポジトリルールは IDE ルールファイル検出と同じ自動同期メカニズムを使用します。両方の機能を有効にするには、設定で「リポジトリからルールを自動同期」を有効にしてください。セットアップについては ルールファイル検出 を参照してください。
使い方
リポジトリに直接カスタム Kody ルールを作成するには、特定のディレクトリに構造化されたマークダウンファイルを配置します。これにより、コードと並行してルールをバージョン管理し、チーム全体で共有できます。同期
- 自動検出:リポジトリルールは有効化されると自動的に検出および同期されます
- 手動同期:任意のルールファイルに
@kody-syncを追加して個別に同期します(自動同期が無効でも機能します) - Webアプリケーション:同期されたルールは Kodus Web アプリケーションのダッシュボードに表示されます
- リアルタイム更新:プルリクエストがクローズされるとルールファイルの変更が同期されます
ファイルの場所
ルールファイルを以下のいずれかのディレクトリに配置してください:.kody/rules/**/*.mdrules/**/*.md
ルールテンプレート
各ルールファイルはこの正確なテンプレート構造に従う必要があります:テンプレートフィールド
必須フィールド
厳密に必須なのは 2 つだけです:空でないtitle と、空でないルール本文。どちらかが欠けている
ファイルは丸ごとスキップされます。
デフォルト値のあるフィールド
それ以外はすべて任意です — 省略するとデフォルトが適用されます。severity は severity_min のエイリアスとして受け付けられます(打ち間違えやすく、意図が
明確なため)。4 つのレベル以外の値は "medium" にフォールバックし、"pull-request" 以外の
scope は "file" として扱われます。ルールの例
ファイルレベルルールの例
プルリクエストレベルルールの例
セットアップ要件
リポジトリルールを使用するには、2 つのオプションがあります:オプション 1:自動同期を有効にする(推奨)
- ルールファイル検出を有効にする:設定で「リポジトリからルールを自動同期」をトグルします
- ルールファイルを作成する:
.kody/rules/**またはrules/**ディレクトリに.mdファイルを配置します - 自動同期:PR がクローズされるとすべてのルールファイルが同期されます
オプション 2:手動同期(選択的)
- ルールファイルを作成する:
.kody/rules/**またはrules/**ディレクトリに.mdファイルを配置します - 同期マーカーを追加する:ルールファイルの任意の場所に
@kody-syncを含めます - 変更をコミット:マークされたファイルのみが同期されます(自動同期のトグルはオフのまま)