跳转到内容

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 后,可以仅将该标题下的清单作为验证对象。即使同一文件中混有评审用清单和备忘录用清单,也可以仅强制评审用清单完成。