Rules

contextlint には 21 個のルール があり、7 つのカテゴリに分類されています。各ルールは ID で contextlint.config.json の rules 配列に登録します。

カテゴリ

Prefix	カテゴリ	検証する内容
TBL	Table	テーブルの内容: 必須カラム、空セル、許可値、パターン、列間制約、ファイル間 ID 一意性
SEC	Section	セクション見出しの存在と順序
STR	Structure	プロジェクトレベルのファイル存在
REF	Reference	リンク、アンカー、ファイル間 ID 参照、安定度の整合性、ゾーン依存、画像参照
CHK	Checklist	チェックリストの完了状態
CTX	Context	プレースホルダ検出、用語の一貫性
GRP	Graph	ドキュメント依存グラフ: トレーサビリティチェーン、循環参照、孤立ドキュメント

全 21 ルール

TBL — テーブル (6)

• TBL-001 必須カラム
• TBL-002 空セル
• TBL-003 許可値
• TBL-004 セルパターン
• TBL-005 列間制約
• TBL-006 ファイル間 ID 一意性

SEC — セクション (2)

• SEC-001 必須セクション
• SEC-002 セクション順序

STR — 構造 (1)

• STR-001 ファイル存在

REF — 参照 (6)

• REF-001 リンク切れ
• REF-002 ID の定義と参照
• REF-003 安定度の整合性
• REF-004 ゾーン依存
• REF-005 アンカー
• REF-006 画像参照

CHK — チェックリスト (1)

• CHK-001 未完了アイテム

CTX — コンテキスト品質 (2)

• CTX-001 プレースホルダ検出
• CTX-002 用語一貫性

GRP — グラフ (3)

• GRP-001 トレーサビリティチェーン
• GRP-002 循環参照
• GRP-003 孤立ドキュメント

各ルール page の構成

1. 概要 — 何を検出するか
2. なぜ必要か — どんな問題を防ぐか
3. オプション — 設定可能なフィールド
4. 違反例と修正後 — Bad → Good
5. 関連ルール

設定方法

各ルールは contextlint.config.json の rules 配列に登録します。

{
  "rules": [
    { "rule": "tbl001", "options": { "requiredColumns": ["ID", "Status"] } },
    { "rule": "ref001" }
  ]
}

ルール ID は <prefix><number> 形式（3 桁ゼロ埋め）。詳細は Configuration を参照してください。