コンテンツにスキップ

CHK-001 未完了アイテム

Markdown のチェックリスト(- [ ] / - [x])が、すべてチェック済みであることを検証します。未チェックのアイテムが残っていると warning で報告されます。

リリース前のレビューチェックリストや、移行作業のタスクリストなど、「すべて埋まっていることが完了の条件」 になるチェックリストは多くあります。しかし - [ ] のままマージしても Markdown としては valid なので、レビューでも CI でも通り抜けてしまいます。完了状態を機械的に検出することで、レビュー前の取りこぼしを防げます。

フィールド必須説明
sectionstring検証対象を特定セクション配下のチェックリストに絞る(見出しテキストの完全一致)
filesstringこのルールを適用するファイルの glob

オプション全体を省略しても動作します(全セクションのチェックリストが対象)。

## Review Checklist
- [x] Code review completed
- [ ] Security review completed
- [x] Tests passing

Security review completed が未チェックなので違反になります。

docs/review.md
line 4 warning Unchecked item "Security review completed" in section "Review Checklist" CHK-001
## Review Checklist
- [x] Code review completed
- [x] Security review completed
- [x] Tests passing
{
"rule": "chk001",
"options": {
"section": "Review Checklist",
"files": "**/review.md"
}
}

section を指定すると、その見出し配下のチェックリストだけを検証対象にできます。同じファイルにレビュー用と備忘録用のチェックリストが混在していても、レビュー用だけを必須にすることが可能です。