Rules

contextlint ships 21 rules organized into 7 categories. Each rule is registered by ID in the rules array of contextlint.config.json.

Categories

Prefix	Category	What it validates
TBL	Table	Table content: required columns, empty cells, allowed values, patterns, cross-column constraints, cross-file ID uniqueness
SEC	Section	Existence and order of section headings
STR	Structure	Project-level file existence
REF	Reference	Links, anchors, cross-file ID references, stability consistency, zone dependencies, image references
CHK	Checklist	Checklist completion status
CTX	Context	Placeholder detection, term consistency
GRP	Graph	Document dependency graph: traceability chains, circular references, orphan documents

All 21 rules

TBL — Table (6)

• TBL-001 Required columns
• TBL-002 Empty cells
• TBL-003 Allowed values
• TBL-004 Cell pattern
• TBL-005 Cross-column constraints
• TBL-006 Cross-file ID uniqueness

SEC — Section (2)

• SEC-001 Required sections
• SEC-002 Section order

STR — Structure (1)

• STR-001 Required files

REF — Reference (6)

• REF-001 Broken links
• REF-002 ID definitions and references
• REF-003 Stability consistency
• REF-004 Zone dependencies
• REF-005 Anchors
• REF-006 Image references

CHK — Checklist (1)

• CHK-001 Unchecked items

CTX — Context quality (2)

• CTX-001 Placeholder detection
• CTX-002 Term consistency

GRP — Graph (3)

• GRP-001 Traceability chain
• GRP-002 Circular references
• GRP-003 Orphan documents

Structure of each rule page

1. Overview — what it detects
2. Why it matters — what problem it prevents
3. Options — configurable fields
4. Bad example and fix — Bad → Good
5. Related rules

How to configure

Each rule is registered in the rules array of contextlint.config.json.

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

Rule IDs use the form <prefix><number> (3-digit zero-padded). See Configuration for details.