@accesslint/core 0.1.2 → 0.2.0

package/README.md

@@ -2,29 +2,14 @@
 
 Pure accessibility rule engine for WCAG auditing. 83 bundled rules, a declarative rule engine, and zero browser dependencies.
 
-## Benchmarks
-
-Full audit (`runAudit`) on synthetic documents with a realistic mix of valid and invalid elements:
-
-| Document size | ops/sec | mean |
-| ------------- | ------: | ---: |
-| 100 elements | 252 | 4.0 ms |
-| 1,000 elements | 27 | 36.6 ms |
-| 2,000 elements | 2.0 | 494 ms |
-
-> Measured on GitHub Actions `ubuntu-latest` / Node 22 with `vitest bench` ([run](https://github.com/AccessLint/core/actions/runs/21695011947)).
-
-### Concordance with axe-core
-
-On a synthetic 500-element document exercising all rule categories:
+## Highlights
 
-| Metric | Value |
-| ------ | ----: |
-| Rules where both agree | 44 |
-| @accesslint/core only | 9 |
-| axe-core only | 4 |
-| **Concordance** (agreement / core findings) | **83%** |
-| **Coverage** (agreement / axe findings) | **92%** |
+- **Lightweight** — 29 KB gzipped (IIFE), with zero runtime dependencies
+- **Chunked audits** — time-budgeted processing via [`createChunkedAudit`](#createchunkedauditdoc-document-chunkedaudit) to avoid long tasks on the main thread
+- **Declarative rule engine** — define custom rules as JSON and compile them with [`compileDeclarativeRule`](#compiledeclarativerulespec-declarativerule-rule), no JavaScript required
+- **ESM, CJS, and IIFE** — tree-shakable ES modules, CommonJS for Node, and a single-file IIFE for script injection into any page
+- **Runs anywhere** — works with happy-dom, jsdom, and real browsers with no DOM polyfills or compatibility workarounds. Run accessibility audits in Vitest and React Testing Library using the same environment as the rest of your tests
+- **MIT licensed**
 
 ## Install
 
@@ -34,6 +19,22 @@ npm install @accesslint/core
 
 ## Quick start
 
+### Vitest + React Testing Library
+
+Audit a rendered component in your existing test suite:
+
+```tsx
+import { render } from "@testing-library/react";
+import { runAudit } from "@accesslint/core";
+import { LoginForm } from "./LoginForm";
+
+test("LoginForm has no accessibility violations", () => {
+  const { container } = render(<LoginForm />);
+  const { violations } = runAudit(container.ownerDocument);
+  expect(violations).toEqual([]);
+});
+```
+
 ### Playwright
 
 Inject the library into the page and audit the live DOM:
@@ -65,21 +66,27 @@ test("page has no accessibility violations", async ({ page }) => {
 Inject the library into the page and audit the live DOM:
 
 ```js
-// cypress/support/commands.js
+// cypress/e2e/a11y.cy.js
 Cypress.Commands.add("audit", () => {
-  cy.readFile("node_modules/@accesslint/core/dist/index.iife.js").then((src) => {
-    cy.window().then((win) => {
-      win.eval(src);
-      const { runAudit } = win.AccessLintCore;
-      return runAudit(win.document).violations;
+  return cy
+    .readFile("node_modules/@accesslint/core/dist/index.iife.js")
+    .then((src) => {
+      return cy.window().then((win) => {
+        win.eval(src);
+        const result = win.AccessLintCore.runAudit(win.document);
+        return result.violations;
+      });
     });
-  });
 });
 
-// cypress/e2e/a11y.cy.js
-it("has no accessibility violations", () => {
-  cy.visit("https://example.com");
-  cy.audit().should("have.length", 0);
+describe("sample.html accessibility audit", () => {
+  beforeEach(() => {
+    cy.visit("sample.html");
+  });
+
+  it("has no accessibility violations", () => {
+    cy.audit().should("have.length", 0);
+  });
 });
 ```
 
@@ -269,6 +276,30 @@ Helpers for building custom rules:
 | `video-caption` | A | 1.2.2 | Videos must have captions. |
 | `audio-caption` | A | 1.2.1 | Audio elements should have a text alternative. |
 
+## Benchmarks
+
+Full audit (`runAudit`) on synthetic documents with a realistic mix of valid and invalid elements:
+
+| Document size | ops/sec | mean |
+| ------------- | ------: | ---: |
+| 100 elements | 252 | 4.0 ms |
+| 1,000 elements | 27 | 36.6 ms |
+| 2,000 elements | 2.0 | 494 ms |
+
+> Measured on GitHub Actions `ubuntu-latest` / Node 22 with `vitest bench` ([run](https://github.com/AccessLint/core/actions/runs/21695011947)).
+
+### Concordance with axe-core
+
+On a synthetic 500-element document exercising all rule categories:
+
+| Metric | Value |
+| ------ | ----: |
+| Rules where both agree | 44 |
+| @accesslint/core only | 9 |
+| axe-core only | 4 |
+| **Concordance** (agreement / core findings) | **83%** |
+| **Coverage** (agreement / axe findings) | **92%** |
+
 ## Development
 
 ```sh