Skip to content

theme.missing color scheme

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

theme.missing-color-scheme

Rule ID: theme.missing-color-scheme Severity: WARN Category: theme Target Standards: W3C CSS Color Adjustment Module Level 1, HTML Living Standard Section 4.2.5.5 (color-scheme)


1. Overview & Core Invariant

Detects dark theme definitions (.dark, [data-theme="dark"]) missing color-scheme property

Core Invariant:

"Dark mode theme selectors must declare color-scheme: dark to synchronize native browser UI elements with the theme."


2. Technical Grounding & Engine Realities

When developers configure dark mode using .dark or [data-theme='dark'] CSS rules without declaring color-scheme: dark:

  1. White Form Controls: Native form elements ( dropdown popovers, calendars, checkboxes) remain bright white.
  2. Inverted Scrollbars: Operating system scrollbars fail to enter dark mode, glaring against dark page content.
  3. Blinding Autofill Scrims: Browser credential autofill backgrounds turn blinding yellow-white.

Charites enforces declaring color-scheme: dark within all dark mode selector scopes.


3. Vulnerability & Risk Taxonomy

Risk Vector Severity Impact
Native UI Flash MEDIUM Native controls, scrollbars, and dropdowns render in high-contrast light theme inside dark mode.
Form Usability Degradation LOW Datepickers and select menus become illegible due to mismatched browser chrome defaults.

4. Non-Compliant Code Patterns (Bad Examples)

ASTRO (Dark mode class without color-scheme declaration):

<style>
  .dark {
    --background: #09090b;
    --foreground: #fafafa;
  }
</style>

TSX (Data-theme attribute without color-scheme):

export function DarkTheme() {
  return (
    <style>{`
      [data-theme="dark"] {
        --bg-main: #121212;
      }
    `}</style>
  );
}

5. Compliant Implementation Patterns (Good Examples)

ASTRO (Dark selector with explicit color-scheme):

<style>
  .dark {
    color-scheme: dark;
    --background: #09090b;
    --foreground: #fafafa;
  }
</style>

ASTRO (Global color-scheme on root):

<style>
  :root {
    color-scheme: light dark;
  }
</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-color-scheme 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-color-scheme.
  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-color-scheme/:

flowchart TD
    subgraph GoldenCorpus ["1-SSOT Tri-Corpus Test Matrix for theme.missing-color-scheme"]
        subgraph P ["Positive Corpus (tests/correctness/theme.missing-color-scheme/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-color-scheme/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-color-scheme/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-color-scheme intentional exception -->
// charites:ignore theme.missing-color-scheme intentional exception

9. Configuration Reference (charites.yaml)

rules:
  theme.missing-color-scheme:
    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