# likebloodmoon/eaa-kit architecture

> Architecture diagram of the GitHub repository likebloodmoon/eaa-kit, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/likebloodmoon/eaa-kit
- Repository: https://github.com/likebloodmoon/eaa-kit

## Overview

eaa-kit is a build-time WCAG 2.2 AA auditor and accessibility-statement generator. Its principal workflow discovers a project or accepts a build/URL, collects pages, audits them, and emits reports; optional review records and baselines add human checks and regression comparisons. Separate capabilities generate country-specific statements and integrate audits into build tools. The README documents several workflows whose implementation was not sampled; those edges cite the README, and no unsampled source is treated as inspected.

Main entry points: [`src/cli/audit.ts`](https://github.com/likebloodmoon/eaa-kit/blob/master/src/cli/audit.ts) (Audit command), [`src/cli/pages.ts`](https://github.com/likebloodmoon/eaa-kit/blob/master/src/cli/pages.ts) (Page resolution), [`src/cli/index.ts`](https://github.com/likebloodmoon/eaa-kit/blob/master/src/cli/index.ts) (CLI dispatcher), [`src/cli/statement.ts`](https://github.com/likebloodmoon/eaa-kit/blob/master/src/cli/statement.ts) (Statement command)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_cli["CLI workflows"]
  node_cli["CLI dispatcher<br/>[index.ts]"]
  node_audit_cmd["Audit command<br/>[audit.ts]"]
  node_config["Config validation<br/>[define.ts]"]
end

subgraph group_discovery["Project discovery"]
  node_project["Project detection<br/>[project.ts]"]
  node_frameworks["Stack detection<br/>[frameworks.ts]"]
  node_routes["Route discovery<br/>[routes.ts]"]
  node_page_resolution["Page resolution<br/>[pages.ts]"]
  node_fs["Filesystem helpers<br/>[fs.ts]"]
end

subgraph group_audit["Audit and analysis"]
  node_collection["HTML collection<br/>[collect.ts]"]
  node_crawl["Running-site crawl<br/>[crawl.ts]"]
  node_jsdom["Browserless engine<br/>[jsdom.ts]"]
  node_playwright["Chromium engine<br/>[playwright.ts]"]
  node_results["Finding shaping<br/>[result.ts]"]
  node_coverage["WCAG coverage<br/>[coverage.ts]"]
  node_impact["Severity thresholds<br/>[impact.ts]"]
end

subgraph group_outputs["Reports and assurance"]
  node_review["Manual review<br/>[review.ts]"]
  node_baseline[("Regression baseline<br/>[baseline.ts]")]
  node_cache[("Page cache<br/>[cache.ts]")]
  node_remediation["Fix guidance<br/>[remediation.ts]"]
  node_reports["Audit reports"]
end

subgraph group_statement["Statements and integrations"]
  node_statement_cli["Statement command<br/>[statement.ts]"]
  node_statement_render["Statement rendering<br/>[render.ts]"]
  node_countries["Country rules<br/>[countries.ts]"]
  node_integrations["Build integrations<br/>[run.ts]"]
end

node_user(("Site maintainer"))

node_user -->|"runs command"| node_cli
node_cli -->|"dispatches"| node_audit_cmd
node_cli -->|"dispatches"| node_statement_cli
node_audit_cmd -->|"resolves pages"| node_page_resolution
node_page_resolution -->|"detects project"| node_project
node_project -->|"detects stack"| node_frameworks
node_page_resolution -->|"crawls running site"| node_crawl
node_page_resolution -->|"collects build HTML"| node_collection
node_collection -->|"checks paths"| node_fs
node_audit_cmd -->|"runs audit"| node_jsdom
node_audit_cmd -->|"selects browser engine"| node_playwright
node_jsdom -->|"shapes findings"| node_results
node_audit_cmd -->|"reports coverage"| node_coverage
node_audit_cmd -->|"applies threshold"| node_impact
node_audit_cmd -->|"reads review"| node_review
node_audit_cmd -->|"checks regressions"| node_baseline
node_audit_cmd -->|"reuses unchanged pages"| node_cache
node_results -->|"adds fix guidance"| node_remediation
node_audit_cmd -->|"writes reports"| node_reports
node_statement_cli -->|"loads configuration"| node_config
node_statement_cli -->|"generates statement"| node_statement_render
node_statement_render -->|"selects country text"| node_countries
node_statement_render -->|"includes review evidence"| node_review
node_integrations -->|"runs build audit"| node_audit_cmd
node_user -.->|"configures build hook"| node_integrations

click node_cli "https://github.com/likebloodmoon/eaa-kit/blob/master/src/cli/index.ts"
click node_audit_cmd "https://github.com/likebloodmoon/eaa-kit/blob/master/src/cli/audit.ts"
click node_project "https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/project.ts"
click node_frameworks "https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/frameworks.ts"
click node_routes "https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/routes.ts"
click node_page_resolution "https://github.com/likebloodmoon/eaa-kit/blob/master/src/cli/pages.ts"
click node_collection "https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/collect.ts"
click node_crawl "https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/crawl.ts"
click node_jsdom "https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/runners/jsdom.ts"
click node_playwright "https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/runners/playwright.ts"
click node_results "https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/result.ts"
click node_coverage "https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/coverage.ts"
click node_impact "https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/impact.ts"
click node_review "https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/review.ts"
click node_baseline "https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/baseline.ts"
click node_cache "https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/cache.ts"
click node_remediation "https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/remediation.ts"
click node_reports "https://github.com/likebloodmoon/eaa-kit/tree/master/src/audit/report"
click node_config "https://github.com/likebloodmoon/eaa-kit/blob/master/src/config/define.ts"
click node_statement_cli "https://github.com/likebloodmoon/eaa-kit/blob/master/src/cli/statement.ts"
click node_statement_render "https://github.com/likebloodmoon/eaa-kit/blob/master/src/statement/render.ts"
click node_countries "https://github.com/likebloodmoon/eaa-kit/blob/master/src/config/countries.ts"
click node_integrations "https://github.com/likebloodmoon/eaa-kit/blob/master/src/integration/run.ts"
click node_fs "https://github.com/likebloodmoon/eaa-kit/blob/master/src/fs.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_audit_cmd,node_config toneBlue
class node_project,node_frameworks,node_routes,node_page_resolution,node_fs toneAmber
class node_collection,node_crawl,node_jsdom,node_playwright,node_results,node_coverage,node_impact toneMint
class node_review,node_baseline,node_cache,node_remediation,node_reports toneRose
class node_statement_cli,node_statement_render,node_countries,node_integrations,node_user toneIndigo
```

## Components

### CLI workflows

- [CLI dispatcher](https://github.com/likebloodmoon/eaa-kit/blob/master/src/cli/index.ts): `src/cli/index.ts`
- [Audit command](https://github.com/likebloodmoon/eaa-kit/blob/master/src/cli/audit.ts): `src/cli/audit.ts`
- [Config validation](https://github.com/likebloodmoon/eaa-kit/blob/master/src/config/define.ts): `src/config/define.ts`

### Project discovery

- [Project detection](https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/project.ts): `src/audit/project.ts`
- [Stack detection](https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/frameworks.ts): `src/audit/frameworks.ts`
- [Route discovery](https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/routes.ts): `src/audit/routes.ts`
- [Page resolution](https://github.com/likebloodmoon/eaa-kit/blob/master/src/cli/pages.ts): `src/cli/pages.ts`
- [Filesystem helpers](https://github.com/likebloodmoon/eaa-kit/blob/master/src/fs.ts): `src/fs.ts`

### Audit and analysis

- [HTML collection](https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/collect.ts): `src/audit/collect.ts`
- [Running-site crawl](https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/crawl.ts): `src/audit/crawl.ts`
- [Browserless engine](https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/runners/jsdom.ts): `src/audit/runners/jsdom.ts`
- [Chromium engine](https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/runners/playwright.ts): `src/audit/runners/playwright.ts`
- [Finding shaping](https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/result.ts): `src/audit/result.ts`
- [WCAG coverage](https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/coverage.ts): `src/audit/coverage.ts`
- [Severity thresholds](https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/impact.ts): `src/audit/impact.ts`

### Reports and assurance

- [Manual review](https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/review.ts): `src/audit/review.ts`
- [Regression baseline](https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/baseline.ts): `src/audit/baseline.ts`
- [Page cache](https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/cache.ts): `src/audit/cache.ts`
- [Fix guidance](https://github.com/likebloodmoon/eaa-kit/blob/master/src/audit/remediation.ts): `src/audit/remediation.ts`
- [Audit reports](https://github.com/likebloodmoon/eaa-kit/tree/master/src/audit/report): `src/audit/report`

### Statements and integrations

- [Statement command](https://github.com/likebloodmoon/eaa-kit/blob/master/src/cli/statement.ts): `src/cli/statement.ts`
- [Statement rendering](https://github.com/likebloodmoon/eaa-kit/blob/master/src/statement/render.ts): `src/statement/render.ts`
- [Country rules](https://github.com/likebloodmoon/eaa-kit/blob/master/src/config/countries.ts): `src/config/countries.ts`
- [Build integrations](https://github.com/likebloodmoon/eaa-kit/blob/master/src/integration/run.ts): `src/integration/run.ts`

### Other components

- **Site maintainer**

## Connections

- Site maintainer → CLI dispatcher: runs command (evidence: `README.md`)
- CLI dispatcher → Audit command: dispatches (evidence: `src/cli/index.ts`)
- CLI dispatcher → Statement command: dispatches (evidence: `src/cli/index.ts`)
- Audit command → Page resolution: resolves pages (evidence: `src/cli/audit.ts`)
- Page resolution → Project detection: detects project (evidence: `src/cli/pages.ts`)
- Project detection → Stack detection: detects stack (evidence: `src/audit/project.ts`)
- Page resolution → Running-site crawl: crawls running site (evidence: `src/cli/pages.ts`)
- Page resolution → HTML collection: collects build HTML (evidence: `src/cli/pages.ts`)
- HTML collection → Filesystem helpers: checks paths (evidence: `src/audit/collect.ts`)
- Audit command → Browserless engine: runs audit (evidence: `src/cli/audit.ts`)
- Audit command → Chromium engine: selects browser engine (evidence: `src/cli/command.ts`)
- Browserless engine → Finding shaping: shapes findings (evidence: `src/audit/runners/jsdom.ts`)
- Audit command → WCAG coverage: reports coverage (evidence: `README.md`)
- Audit command → Severity thresholds: applies threshold (evidence: `src/cli/audit.ts`)
- Audit command → Manual review: reads review (evidence: `src/cli/audit.ts`)
- Audit command → Regression baseline: checks regressions (evidence: `README.md`)
- Audit command → Page cache: reuses unchanged pages (evidence: `README.md`)
- Finding shaping → Fix guidance: adds fix guidance (evidence: `README.md`)
- Audit command → Audit reports: writes reports (evidence: `src/cli/audit.ts`)
- Statement command → Config validation: loads configuration
- Statement command → Statement rendering: generates statement (evidence: `README.md`)
- Statement rendering → Country rules: selects country text (evidence: `src/config/countries.ts`)
- Statement rendering → Manual review: includes review evidence (evidence: `src/statement/render.ts`)
- Build integrations → Audit command: runs build audit (evidence: `src/integration/run.ts`)
- Site maintainer → Build integrations: configures build hook (evidence: `README.md`)
