跳转到内容

TBL-001 必需列

验证表格的表头行包含所有必需的列。requiredColumns 中指定的任何列名缺失时,会报告为 error

在需求表、API 规格、数据定义等场景中,即使团队已经约定某些列(如 IDStatusOwner)必须存在,在编写新表格时仍可能整列遗漏,或在改写部分表格结构时漏掉其它部分。本规则可以防止这类失误。

字段类型必填说明
requiredColumnsstring[]必需列名的数组
sectionstring将验证范围限定为指定章节下的表格(标题中包含的字符串)
filesstring应用此规则的文件 glob
## 需求
| ID | 内容 |
| ------ | ---------------- |
| REQ-01 | 用户注册 |

设置 requiredColumns: ["ID", "Status"] 时,由于缺少 Status 列,会判定为违例。

docs/requirements.md
line 3 error Missing required column "Status" in table TBL-001
## 需求
| ID | 内容 | Status |
| ------ | ---------------- | ------ |
| REQ-01 | 用户注册 | stable |
{
"rule": "tbl001",
"options": {
"requiredColumns": ["ID", "Status"],
"section": "需求",
"files": "specs/*.md"
}
}