Files
Ekklesia/packages/ui/tests/tokens.test.ts
T
ekklesiaandClaude Opus 5.5 405e509bcb
CI / verify (pull_request) Successful in 1m13s
CI / infrastructure-smoke (pull_request) Successful in 34s
CI / package-release (pull_request) Successful in 48s
CI / migration-smoke (pull_request) Successful in 2m22s
CI / image-build (pull_request) Successful in 1m8s
CI / deploy-smoke (same-origin) (pull_request) Successful in 49s
CI / package-publication (pull_request) Successful in 57s
CI / deploy-smoke (split) (pull_request) Successful in 3m38s
Fix the Stage 1 Dashboard UX defects found in assembled review
The assembled Stage 1 Dashboard was reviewed by hand on a desktop, with
the sidebar collapsed, and on an iPhone. This fixes what that review
found, and records the decisions in ADR 0064:

- Discover is its own page at /settings/discover, with Installed and
  Updates beneath it as children. There is no Browse item any more.
  /settings/discover/browse is still read, as an alias, and is respelled
  in place. Parents and children now read as a hierarchy: a guide line,
  text-only children, a disclosure chevron, and parent and current
  states that look different.
- The sidebar is navigation only. Display pairing moves from the sidebar
  and drawer to Settings -> Displays: the paired displays, a deliberate
  Add display dialog, and revocation. Nothing takes focus on arrival;
  the code field is focused only once Add display is chosen.
- Collapsed icons are centred. Nav-link layout moves from inline styles
  to the shell stylesheet, and every collapsed item is one square
  centred on the rail.
- /settings is an overview of the installation: displays paired,
  modules installed and running, and a line for each other area. It
  reads only existing endpoints.
- Phones get a sticky, safe-area-aware header holding the menu trigger
  and the page name. New pages start at the top, and focus no longer
  scrolls content under the header.
- @ekklesia/ui draws checkbox and radio indicators from tokens rather
  than accent-color, so the selected state is the strong accent in
  Light and Dark alike.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-15 20:37:32 -05:00

162 lines
7.1 KiB
TypeScript

import { readdir, readFile } from "node:fs/promises";
import path from "node:path";
import { fileURLToPath } from "node:url";
import { ekklesiaDesignTokens } from "@ekklesia/design-tokens";
import { describe, expect, it } from "vitest";
import {
EKKLESIA_UI_STYLE_ATTRIBUTE,
EKKLESIA_UI_STYLESHEET,
installEkklesiaUiStyles,
} from "../src/index.js";
const packageDirectory = path.dirname(path.dirname(fileURLToPath(import.meta.url)));
async function sourceFiles(): Promise<readonly string[]> {
const directory = path.join(packageDirectory, "src");
return (await readdir(directory))
.filter((entry) => entry.endsWith(".ts") || entry.endsWith(".tsx"))
.map((entry) => path.join(directory, entry));
}
/** Any literal that would be a theme decision rather than a layout one. */
const THEME_LITERAL_PATTERN =
/#[0-9a-f]{3,8}\b|\brgba?\s*\(|\bhsla?\s*\(|\boklch\s*\(|\bsystem-ui\b|\bsans-serif\b/giu;
describe("the shared elements consume design tokens, never hardcoded theme values", () => {
it("expresses every theme value in the stylesheet as a token reference", () => {
expect(EKKLESIA_UI_STYLESHEET.match(THEME_LITERAL_PATTERN)).toBeNull();
expect(EKKLESIA_UI_STYLESHEET).toContain("var(--ekklesia-");
});
it("references only registered tokens", () => {
const referenced = [...EKKLESIA_UI_STYLESHEET.matchAll(/var\((--ekklesia-[a-z0-9-]+)\)/gu)].map(
([, variable]) => String(variable),
);
const registered = new Set(ekklesiaDesignTokens.list().map((token) => token.cssVariable));
expect(referenced.length).toBeGreaterThan(0);
expect([...new Set(referenced)].filter((variable) => !registered.has(variable))).toEqual([]);
});
it("never defines a global Ekklesia theme variable of its own", () => {
// Referencing `--ekklesia-*` is the contract; *declaring* one would invent a global theme
// variable outside the registry, which is precisely what the design-token contract forbids.
expect(EKKLESIA_UI_STYLESHEET).not.toMatch(/--ekklesia-[a-z0-9-]+\s*:/u);
});
it("hardcodes no theme value in component source either", async () => {
for (const file of await sourceFiles()) {
if (path.basename(file) === "styles.ts") {
continue;
}
expect(await readFile(file, "utf8")).not.toMatch(THEME_LITERAL_PATTERN);
}
});
it("never names a Node built-in or reads the environment", async () => {
for (const file of await sourceFiles()) {
const source = await readFile(file, "utf8");
expect(source).not.toContain('"node:');
expect(source).not.toContain("process.env");
}
});
it("depends only on the design tokens and React", async () => {
const manifest = JSON.parse(
await readFile(path.join(packageDirectory, "package.json"), "utf8"),
) as {
dependencies?: Record<string, string>;
devDependencies?: Record<string, string>;
peerDependencies?: Record<string, string>;
};
// React is a peer only (ADR 0053): the consumer's React is the one in every bundle these
// elements are built into. The development dependency resolves the package's own imports for its
// builds and tests; nothing loads it from this workspace in a production Node.js process
// (`runtime-imports-are-production-dependencies` allows exactly this peer).
expect(Object.keys(manifest.dependencies ?? {})).toEqual(["@ekklesia/design-tokens"]);
expect(manifest.devDependencies?.react).toBeDefined();
expect(Object.keys(manifest.peerDependencies ?? {})).toEqual(["react"]);
});
it("installs its stylesheet into a document root exactly once", () => {
const remove = installEkklesiaUiStyles(document);
installEkklesiaUiStyles(document);
expect(document.querySelectorAll(`style[${EKKLESIA_UI_STYLE_ATTRIBUTE}]`).length).toBe(1);
remove();
remove();
expect(document.querySelectorAll(`style[${EKKLESIA_UI_STYLE_ATTRIBUTE}]`).length).toBe(0);
});
});
describe("the element stylesheet takes every colour, radius, and duration from a token (ADR 0060)", () => {
// Comments are dropped: they may mention a value without using it.
const css = EKKLESIA_UI_STYLESHEET.replace(/\/\*[\s\S]*?\*\//gu, "");
it("contains no raw colour", () => {
expect(css).not.toMatch(/#[0-9a-f]{3,8}\b/iu);
expect(css).not.toMatch(/\b(?:rgba?|hsla?|oklch|lab|lch|hwb)\(/iu);
// A named colour is a raw colour too; `transparent` and `currentColor` are not colours.
expect(css).not.toMatch(/:\s*(?:white|black|red|green|blue|gray|grey)\s*;/iu);
});
it("rounds corners only with radius tokens", () => {
for (const match of css.matchAll(/border-radius:\s*([^;]+);/gu)) {
// Each corner is a radius token, or square.
for (const corner of (match[1] ?? "").split(/\s+/u)) {
expect(corner, match[0]).toMatch(/^(?:var\(--ekklesia-radius-[a-z]+\)|0)$/u);
}
}
});
it("animates only for motion-token durations", () => {
for (const match of css.matchAll(/(?:animation|transition):\s*([^;]+);/gu)) {
expect(match[1], match[0]).not.toMatch(/\b\d+(?:\.\d+)?m?s\b/u);
expect(match[1], match[0]).toContain("--ekklesia-motion-duration-");
}
});
});
/** The body of the rule whose whole selector list is exactly `selector`. */
function ruleBody(selector: string): string {
const escaped = selector.replace(/[.*+?^${}()|[\]\\]/gu, "\\$&");
const match = new RegExp(`(?<!,)\n${escaped} \\{([^}]*)\\}`, "u").exec(EKKLESIA_UI_STYLESHEET);
return match?.[1] ?? "";
}
describe("choice indicators are drawn from tokens (ADR 0064)", () => {
it("never leaves a checkbox or radio to the browser's accent-tinted rendering", () => {
// `accent-color` lets each browser pick its own mark for the selected state — a near-black dot
// on the light theme's pale teal — so the selected state matched neither theme.
expect(EKKLESIA_UI_STYLESHEET).not.toMatch(/accent-color\s*:/u);
const base = ruleBody(".ek-checkbox__input,\n.ek-radio__input");
expect(base).toContain("appearance: none");
expect(base).toContain("var(--ekklesia-border-control)");
expect(base).toContain("var(--ekklesia-background-surface)");
});
it("marks the selected state with the strong accent, the same in light and dark", () => {
const radio = ruleBody(".ek-radio__input:checked");
expect(radio).toContain("background: var(--ekklesia-accent-strong)");
expect(radio).toContain("border-color: var(--ekklesia-accent-strong)");
expect(radio).toContain("var(--ekklesia-background-surface)");
const checkbox = ruleBody(".ek-checkbox__input:checked");
expect(checkbox).toContain("background: var(--ekklesia-accent-strong)");
expect(ruleBody(".ek-checkbox__input:checked::before")).toContain(
"background: var(--ekklesia-background-surface)",
);
// A radio is round by the pill radius token, never a literal.
expect(ruleBody(".ek-radio__input")).toContain("var(--ekklesia-radius-pill)");
});
it("keeps disabled and forced-colour states", () => {
expect(ruleBody(".ek-checkbox__input:disabled,\n.ek-radio__input:disabled")).toContain(
"var(--ekklesia-state-disabled-opacity)",
);
expect(EKKLESIA_UI_STYLESHEET).toMatch(/@media \(forced-colors: active\)/u);
});
});