Skip to content

Rules

Rules mapped to specific WCAG success criteria. Violations may constitute accessibility barriers.

RuleCodeWCAGDescription
no-color-onlyCLR0011.4.1Don’t convey information only through color

Best practices for cognitive accessibility. Not WCAG requirements, but improve usability for users with cognitive disabilities.

RuleCodeDescription
line-lengthFMT001Lines should be 120 characters or fewer
no-all-capsLNG002Avoid all-caps text (hard to read)
plain-languageLNG001Avoid technical jargon (EOF, STDIN, etc.)
emoji-moderationSCR001Limit emoji use (confuses screen readers)
punctuationLNG003Error messages should end with punctuation
error-structureA11Y003Errors should explain why and how to fix
no-ambiguous-pronounsLNG004Avoid starting with “it”, “this”, etc.

All messages follow the What/Why/Fix structure:

[ERROR] CODE: What happened
Why: Explanation of why this matters
Fix: Actionable suggestion
[WARN] CODE: What to improve
Why: Why this matters
Fix: How to improve (optional)
[OK] CODE: What was checked

Letter grades (A-F) are informational summaries. For CI pipelines, gate on specific rule failures, error count thresholds, or regressions from a baseline — not on letter grades.