Skip to content

theme.missing token fallback

github-actions[bot] edited this page Sep 6, 2026 · 2 revisions

theme.missing-token-fallback

Rule ID: theme.missing-token-fallback Severity: WARN Category: theme Target Standards: W3C CSS Custom Properties for Cascading Variables Module Level 1, WCAG 2.2 Guideline 4.1 Compatible (Robust Graceful Degradation)


1. Overview & Core Invariant

Detects CSS variable references without fallback values

Core Invariant:

"CSS variable references in production code must supply a safe fallback value to guard against unresolved design tokens."


2. Technical Grounding & Engine Realities

CSS variables evaluated via var(--name) without a fallback revert to the CSS specification's 'guaranteed-invalid value' when undefined or failing to load.

When developers write color: var(--text-brand) or bg-[var(--brand)] without a fallback:

  1. Broken Visual Contrast: Elements render completely transparent or default black, failing WCAG AA contrast.
  2. Unhandled CDN / Token Latency: If design tokens load asynchronously or via isolated packages, missing fallbacks cause flash of broken unstyled content (FOBUC).
  3. Graceful Degradation Failure: Micro-frontends or embedded widgets fail without host variable injection.

Charites recommends always supplying a fallback argument: var(--name, fallback-value).


3. Vulnerability & Risk Taxonomy

Risk Vector Severity Impact
Guaranteed-Invalid Property Rendering MEDIUM Missing tokens evaluate to transparent/initial CSS values, causing catastrophic unreadable contrast.
Micro-frontend Style Decoupling LOW Components embedded in foreign hosts break when global tokens are not shared.

4. Non-Compliant Code Patterns (Bad Examples)

ASTRO (Missing fallback in arbitrary Tailwind utility class):

<div class="bg-[var(--brand)] text-[var(--text-color)]">Unsafe Variable</div>

TSX (Missing fallback in inline style attribute):

export function Card() {
  return <div style={{ color: "var(--brand-primary)" }}>Missing Fallback</div>;
}

ASTRO (Missing fallback inside style block):

<style>
  .badge {
    background-color: var(--accent-color);
  }
</style>

5. Compliant Implementation Patterns (Good Examples)

ASTRO (Safe fallback in arbitrary Tailwind utility class):

<div class="bg-[var(--brand,#2563eb)] text-[var(--text-color,currentColor)]">Safe Variable</div>

TSX (Safe fallback in inline style attribute):

export function Card() {
  return <div style={{ color: "var(--brand-primary, #1e293b)" }}>Safe Fallback</div>;
}

ASTRO (Safe fallback inside style block):

<style>
  .badge {
    background-color: var(--accent-color, #f59e0b);
  }
</style>

6. Detection & Verification Pipeline (How The Rule Evaluates Code)

This theme rule evaluates source templates against the project's design token graph:

flowchart TD
    Node["AST Node (Astro / TSX element)"] --> Extract["1. Extract Class Names (e.g. 'hover:bg-primary/10')"]
    Extract --> Strip["2. Strip Variants (hover:, dark:, sm:) -> 'bg-primary/10'"]
    Strip --> Split["3. Split Opacity Modifier -> Utility: 'bg-primary', Opacity: '/10'"]
    Split --> Convention["4. Query TokenConvention (Candidate: '--color-primary-light')"]
    Convention --> GraphQuery{"5. Check Token Graph (Does token exist in active scope?)"}
    GraphQuery -- "No (Banana Test)" --> Safe["Pass (Valid Custom / Untokenized Color)"]
    GraphQuery -- "Yes (Official Token Exists)" --> IgnoreCheck{"6. Check charites:ignore directive"}
    IgnoreCheck -- "Ignored" --> Safe
    IgnoreCheck -- "Not Ignored" --> Diag["7. Emit Diagnostic: theme.missing-token-fallback with Replacement Suggestion"]
Loading

Step-by-Step Evaluation:

  1. AST Node Traversal: internal/analyzer streams JSX/Astro AST elements to the rule's Evaluate visitor.
  2. Variant Normalization: Strips responsive (sm:, md:), interaction state (hover:, focus:), and theme (dark:) prefixes to isolate the core utility class.
  3. Modifier Extraction: Parses utility segments and extracts slash opacity modifiers.
  4. Token Convention Resolution: Consults the TokenConvention adapter to determine the official semantic design token replacement candidate.
  5. Token Graph Verification (Banana Test): Queries token.Context to verify that the candidate token is declared in global.css or tokens.json within the element's scope. If not declared, the custom value is permitted without a false-positive diagnostic.
  6. Directive Suppression Check: Inspects preceding AST comments for charites:ignore theme.missing-token-fallback.
  7. Diagnostic Emission: Produces a structured diagnostic with line number, column span, and actionable replacement suggestion.

7. Verification & Test Harness (How The Test Works: 1-SSOT Tri-Corpus)

This rule is rigorously tested and validated across the canonical 1-SSOT Tri-Corpus in tests/correctness/theme.missing-token-fallback/:

flowchart TD
    subgraph GoldenCorpus ["1-SSOT Tri-Corpus Test Matrix for theme.missing-token-fallback"]
        subgraph P ["Positive Corpus (tests/correctness/theme.missing-token-fallback/positive/)"]
            P1["P1: Obvious Direct Violation"]
            P2["P2: Indirect / Variant Concatenation"]
            P3["P3: Helper / clsx / cn Wrapper"]
            P4["P4: Deeply Nested Elements"]
            P5["P5: Aliased Imports / Re-exports"]
        end
        subgraph N ["Negative Corpus (tests/correctness/theme.missing-token-fallback/negative/)"]
            N1["N1: Valid Design Tokens"]
            N2["N2: Explicit charites:ignore Directive"]
            N3["N3: Third-Party / Vendor Components"]
            N4["N4: Clean Semantic HTML"]
            N5["N5: Untokenized Custom Values (Banana Test)"]
        end
        subgraph A ["Adversarial Corpus (tests/correctness/theme.missing-token-fallback/adversarial/)"]
            A1["A1: Template Literal Interpolations"]
            A2["A2: Ternary Conditional Expressions"]
            A3["A3: Spread Properties & Dynamic Overrides"]
            A4["A4: Dynamic Object Class Syntax"]
            A5["A5: Shadowed Variable Identifiers"]
            A6["A6: Nested Closures & HOC Wrappers"]
            A7["A7: Obfuscated Classes & Cyclic Tokens"]
        end
    end

    P --> TestRunner["Automated Runner (rule_test.go)"]
    N --> TestRunner
    A --> TestRunner
    TestRunner --> Gates["Quality Gates: Zero Panic, Zero False-Positive, Zero Bypass"]
Loading
  • Positive Fixtures (P1-P5): Verified to trigger diagnostics at exact lines and column spans.
  • Negative Fixtures (N1-N5): Verified to produce zero diagnostics on valid tokens and legitimate exemptions.
  • Adversarial Fixtures (A1-A7): Verified to prevent evasion across dynamic expressions, string interpolations, and cyclic references.

8. How to Suppress (Ignore Directives)

If this pattern is required for an intentional exception, suppress the diagnostic using the canonical Charites Rule ID:

<!-- charites:ignore theme.missing-token-fallback intentional exception -->
// charites:ignore theme.missing-token-fallback intentional exception

9. Configuration Reference (charites.yaml)

rules:
  theme.missing-token-fallback:
    severity: warn # error | warn | info | off

Rule Categories

A11y (16 rules)
Browser (12 rules)
Cls (16 rules)
Design (1 rules)
Ergonomy (5 rules)
Inp (16 rules)
Lcp (16 rules)
Mobile (5 rules)
Performance (16 rules)
Pwa (10 rules)
Responsive (18 rules)
Semantic (1 rules)
Theme (32 rules)
Ux (20 rules)

Clone this wiki locally