コンテンツにスキップ

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"
}
}
  • TBL-002 空セル — 必須カラムが存在した上で、セルが空でないかを検証
  • TBL-003 許可値 — カラムの値が許可リストに含まれるかを検証