styleproof 3.7.0 → 3.8.0

package/CHANGELOG.md

@@ -7,6 +7,49 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+## [3.8.0] - 2026-07-05
+
+### Added
+
+- **Zero-config out of the box** — `styleproof-init` now scaffolds a crawl-by-default
+  spec for any non-Next.js app: `defineCrawlCapture({ from: '/', settle, inventory: true })`
+  captures every surface the nav links to (the root plus each same-origin `<a href>`)
+  with **nothing to hand-list** — the surface set is discovered from the rendered nav and
+  can't drift from it. Next.js keeps filesystem route discovery; both variants now enable
+  the inventory guard by default.
+- **`defineCrawlCapture` auto-width** — omit `widths` and StyleProof detects each
+  discovered surface's `@media` breakpoints and sweeps one viewport per band, the same
+  zero-config behaviour explicit surfaces already had.
+- **`defineCrawlCapture` `settle` hook** — run an app-specific step (e.g. trigger
+  scroll-reveal) after navigating to each crawled surface, for parity with a hand-listed
+  surface's `go`.
+- **`inventory` spec option** — `defineStyleMapCapture` / `defineCrawlCapture` now forward
+  `inventory: true` to the capture, so turning the inventory guard on (a removed nav item
+  fails `styleproof-diff`) is a one-line opt-in from a spec, no manual `captureStyleMap`.
+- The crawl now always covers its `from` root on an unfiltered crawl, so a home page not
+  linked in its own nav — or a single-page app with no links — is still captured.
+
+### Changed
+
+- `styleproof-init` guidance now leads with "it runs on your first PR with no extra
+  steps" (CI captures both sides on a cache miss); the local `npx styleproof-map`
+  pre-cache is framed as an optional speedup, not a required first step.
+
+### Tests / docs
+
+- **Dogfood: the "100% surfaced" contract** — `test/pr-surfacing.e2e.spec.ts` runs the
+  real capture → diff → report flow for every change class (resting style,
+  `:hover/:focus/:active` drop, `::before/::after`, DOM add/remove/retag, a removed nav
+  item via the inventory guard, a new surface, and a clean no-op) and asserts each is
+  surfaced — the last two levels through the actual `styleproof-diff` / `styleproof-report`
+  CLIs. Closes the four classes that previously had no end-to-end proof (`:active` drop,
+  DOM removed, retag, pseudo-element change).
+- **Dogfood: zero-config flow** — `test/cli-flow.e2e.spec.ts` runs `styleproof-init` on a
+  real multi-page app and proves the generated crawl spec captures every page (root +
+  pricing + about), multi-width, with the inventory harvested — no spec editing.
+- **`docs/what-it-catches.md`** — states what StyleProof catches and its honest boundary
+  (surfaces it never captured), so a green check is earned, not assumed.
+
 ## [3.7.0] - 2026-07-04
 
 ### Added

package/bin/styleproof-init.mjs

@@ -153,64 +153,37 @@ defineStyleMapCapture({
   exclude: Object.fromEntries(
     ROUTES.filter((r) => r.dynamic).map((r) => [r.key, \`dynamic route (\${r.path}) — add a surface with a concrete param\`]),
   ),
+  inventory: true, // also fail the diff when a nav item / route the UI used to offer disappears
   dir: process.env.STYLEMAP_DIR,
 });
 `;
 
-// Non-Next project: one sample surface + a commented guard block to wire to
-// whatever the project uses as a route/view registry.
+// Non-Next project: crawl every surface the nav links to, so ANY app captures its
+// whole reachable surface out of the box with nothing to hand-list. The crawl reads
+// the rendered nav; the surface set can't drift from it.
 const GENERIC_SPEC = `import type { Page } from '@playwright/test';
-import { defineStyleMapCapture, type Surface } from 'styleproof';
+import { defineCrawlCapture } from 'styleproof';
 
 ${HEADER}
 
 ${SETTLE}
 
-const SURFACES: Surface[] = [
-  {
-    key: 'home',
-    go: async (page) => {
-      await page.goto('/');
-      await settle(page);
-    },
-    ignore: [], // e.g. ['.live-feed', '.ad-slot'] for nondeterministic regions
-    // No widths → StyleProof detects your @media breakpoints from the loaded CSS and
-    // sweeps one viewport per band. Pass an explicit array (e.g. 1280, 768, 390) to pin them (or to
-    // cover a JS-only matchMedia breakpoint that has no CSS @media rule).
-    // Non-live UI states belong here as variants, so the base branch's
-    // dialog-open state compares to the head branch's dialog-open state.
-    // variants: [
-    //   {
-    //     key: 'dialog-open',
-    //     go: async (page) => {
-    //       await page.getByRole('button', { name: /open settings/i }).click();
-    //       await page.getByRole('dialog').waitFor();
-    //     },
-    //   },
-    //   {
-    //     key: 'popover-open',
-    //     go: async (page) => {
-    //       await page.getByRole('button', { name: /more/i }).click();
-    //       await page.locator('[popover], [role="menu"]').first().waitFor();
-    //     },
-    //   },
-    // ],
-  },
-  // Add more surfaces for distinct routes/views; add menus, dialogs, popovers,
-  // selected tabs, and form errors as variants of the route/view that owns them.
-];
-
-defineStyleMapCapture({
-  surfaces: SURFACES,
-  // Coverage guard (recommended): declare every route your app knows about so a
-  // newly added page can't ship without a surface. Wire \`expected\` to your route
-  // registry — a routes/views list, your router config, or a glob of your pages —
-  // and StyleProof fails the suite (no STYLEMAP_DIR needed) when a route has no
-  // surface and isn't excluded. (A Next.js app gets this auto-wired; see
-  // \`discoverNextRoutes\` in the README.)
-  //   expected: ROUTES.map((r) => r.id),
-  //   exclude: { checkout: 'auth-gated — fixture pending' },
+// Zero-config capture: crawl every surface your nav links to from '/'. The surface set
+// is DISCOVERED from the rendered nav, so it can't drift from it — no hand-listed
+// \`surfaces\` array to maintain, and a page you add to the nav is captured automatically.
+// The root (/) is always captured, plus every same-origin <a href> it links to.
+defineCrawlCapture({
+  from: '/',
+  settle, // trigger scroll-reveal per surface (StyleProof handles fonts/animation/network itself)
+  // No \`widths\` → StyleProof detects each surface's @media breakpoints and sweeps one
+  // viewport per band. Pass an array (e.g. [1440, 768, 390]) to pin them.
+  inventory: true, // also fail the diff when a nav item / route the UI used to offer disappears
+  ignore: [], // e.g. ['.live-feed', '.ad-slot'] for nondeterministic regions
   dir: process.env.STYLEMAP_DIR,
+  // A single-route SPA whose views are ?tab= / client-routed? Keep only those:
+  //   match: /\\?tab=/,
+  // Certify menus, dialogs, tabs, and form-error states on every surface as variants:
+  //   variants: [{ key: 'menu-open', go: async (page) => { await page.getByRole('button', { name: /menu/i }).click(); } }],
 });
 `;
 
@@ -472,7 +445,8 @@ if (spec.wrote) {
         (dynamic ? ` (${dynamic} dynamic route(s) excluded pending a concrete param)` : ''),
     );
   } else {
-    console.log('  no Next.js routes detected — wrote a starter surface + a commented coverage-guard block');
+    console.log('  no Next.js routes detected — wrote a crawl-by-default spec that captures every');
+    console.log('  surface your nav links to from / (nothing to hand-list; the inventory guard is on)');
   }
   wroteSomething = true;
 } else {
@@ -508,15 +482,14 @@ if (ci.wrote) {
   console.log(`${CI_PATH} already exists — left untouched`);
 }
 
-console.log('\nHow the gate works — local-first maps, CI report when cached:');
-console.log('  1. Commit your code, then run:');
+console.log('\nHow the gate works — it runs on your first PR with no extra steps:');
+console.log('  1. Commit and open a PR. CI captures the base and head surfaces in one pinned');
+console.log('     environment and posts the StyleProof report — no local step required.');
+console.log('  2. (Optional, faster) Pre-cache this commit so CI skips recapturing the base:');
 console.log('       npx styleproof-map');
-console.log('     It captures a production-build map into .styleproof/ and uploads the bundle');
-console.log('     to the styleproof-maps branch when the git remote is available.');
-console.log('  2. Open the PR. CI restores the base/head bundles and generates the report');
-console.log('     without a browser when both maps are present and compatible.');
-console.log('  3. If a bundle is missing or incompatible, CI recaptures both sides in the same');
-console.log('     environment before generating the report. Correctness beats a stale cache.');
+console.log('     It captures a production-build map into .styleproof/ and uploads the bundle to');
+console.log('     the styleproof-maps branch when the git remote is available; CI then restores');
+console.log('     it and generates the report without a browser.');
 
 if (!wroteSomething) console.log('\nnothing to write — project already scaffolded.');
 process.exit(0);

package/dist/crawl.d.ts

@@ -37,6 +37,10 @@ export type SelectLinksOptions = {
     match?: LinkMatch;
     /** Derive the surface key from a link URL. Default: {@link defaultLinkKey}. */
     key?: (url: URL) => string;
+    /** Also capture the crawled page itself as the first surface, so `from` is always
+     *  covered — even if the nav doesn't link back to it, or it's a single-page app with
+     *  no links at all. Default false. Used for an unfiltered "capture everything" crawl. */
+    includeSelf?: boolean;
 };
 /**
  * Filename-safe, readable key from a link URL. Joins the path segments and the

package/dist/crawl.js

@@ -83,6 +83,11 @@ export function selectCrawlLinks(hrefs, opts) {
     const keyFor = opts.key ?? defaultLinkKey;
     const seen = new Set();
     const out = [];
+    if (opts.includeSelf) {
+        const selfUrl = base.pathname + base.search;
+        seen.add(selfUrl);
+        out.push({ key: keyFor(base), url: selfUrl });
+    }
     for (const href of hrefs) {
         const link = href ? toLink(href, base, keyFor, opts.match) : null;
         if (!link || seen.has(link.url))

package/dist/runner.d.ts

@@ -168,6 +168,15 @@ export type DefineOptions = {
      * their exact capture set unless this is enabled.
      */
     popups?: boolean | PopupCaptureOptions;
+    /**
+     * Opt-in inventory guard (default OFF). Harvest each surface's navigable
+     * affordances — route links, `role=tab`/`menuitem`, button-only nav — into
+     * `StyleMap.inventory`, so `styleproof-diff` fails when a nav item / route the UI
+     * used to offer disappears (acknowledge intentional removals in
+     * `styleproof.inventory.json`). Additive; ignored by the certification style diff.
+     * See `docs/inventory-guard.md`.
+     */
+    inventory?: boolean;
 };
 export declare function selfCheckErrorMessage(surfaceKey: string, drift: Finding[], volatile?: string[], liveCandidates?: LiveRegionCandidate[]): string;
 type ResolvedPopupCaptureOptions = Required<PopupCaptureOptions>;
@@ -238,10 +247,16 @@ export type CrawlOptions = CaptureConfig & {
     match?: LinkMatch;
     /** Derive a surface key from a link URL. Default: path+query slug (`/?tab=x` → `x`). */
     key?: (url: URL) => string;
-    /** Viewport widths swept for every discovered surface — one per @media band. */
-    widths: number[];
+    /** Viewport widths swept for every discovered surface. Omit to auto-detect each
+     *  surface's @media breakpoints (one viewport per band) — the same zero-config
+     *  behaviour as an explicit surface with no `widths`. */
+    widths?: number[];
     /** Viewport height per width (default 800). */
     height?: number | ((width: number) => number);
+    /** Run after navigating to each discovered link, before capture — e.g. to trigger
+     *  scroll-reveal content. The built-in font/animation/network settle always runs;
+     *  this is the app-specific hook, the crawl's parity with a hand-listed surface's `go`. */
+    settle?: (page: Page) => Promise<void>;
     /** Selectors skipped on every surface (live regions, third-party embeds). */
     ignore?: string[];
     /** Deterministic variants captured for every discovered link surface. */

package/dist/runner.js

@@ -371,6 +371,7 @@ async function captureSurface(page, surface, width, s) {
             ignore: surface.ignore ?? [],
             captureText: s.captureText,
             captureComponent: s.captureComponent,
+            inventory: s.inventory,
             pendingRequests: requests.pending,
             metadata: surface.metadata,
         });
@@ -435,6 +436,7 @@ function resolveSettings(c) {
         captureText: c.captureText ?? false,
         captureComponent: c.captureComponent ?? false,
         popups: resolvePopupCaptureOptions(c.popups),
+        inventory: c.inventory ?? false,
     };
 }
 /**
@@ -517,17 +519,28 @@ export function defineStyleMapCapture(options) {
  * ```
  */
 export function defineCrawlCapture(options) {
-    const { from, match, key, widths, height, ignore, variants, liveStates, popups, linkTimeout = 15_000, dir } = options;
+    const { from, match, key, widths, height, ignore, variants, liveStates, popups, linkTimeout = 15_000, dir, settle, } = options;
     const settings = resolveSettings(options);
-    test.describe('styleproof crawl-capture', () => {
+    // Title contains "styleproof capture" so the same `--grep 'styleproof capture'`
+    // that styleproof-map uses to select capture tests picks up crawl specs too.
+    test.describe('styleproof capture (crawl)', () => {
         test.skip(!dir, 'set STYLEMAP_DIR=<label> to capture computed-style maps');
         test('discover surfaces by crawling links, then capture each', async ({ page }) => {
             // 1. Load the root and wait for its nav links to hydrate — an SPA renders them
             //    client-side, so they aren't in the initial HTML.
             await page.goto(from, { waitUntil: 'load' });
-            await page.waitForSelector('a[href]', { timeout: linkTimeout });
+            // Wait for the nav's links to hydrate (an SPA renders them client-side). A link-less
+            // page is fine for an unfiltered crawl — it still captures `from` itself (includeSelf);
+            // a `match`-filtered crawl genuinely needs links, so let its timeout surface.
+            await page.waitForSelector('a[href]', { timeout: linkTimeout }).catch((e) => {
+                if (match !== undefined)
+                    throw e;
+            });
             const hrefs = await page.$$eval('a[href]', (els) => els.map((e) => e.getAttribute('href')));
-            const links = selectCrawlLinks(hrefs, { base: page.url(), match, key });
+            // Unfiltered crawl → also capture `from` itself, so the root is always covered and
+            // a single-page (or no-nav-self-link) app still yields a surface. A `match`-filtered
+            // crawl captures only the links the caller asked for.
+            const links = selectCrawlLinks(hrefs, { base: page.url(), match, key, includeSelf: match === undefined });
             if (links.length === 0) {
                 throw new Error(`styleproof crawl: no links matched at ${from}. The nav must render same-origin ` +
                     `<a href> links (a button-only nav exposes nothing to crawl), and \`match\` must keep them.`);
@@ -536,6 +549,8 @@ export function defineCrawlCapture(options) {
                 key: link.key,
                 go: async (p) => {
                     await p.goto(link.url, { waitUntil: 'load' });
+                    if (settle)
+                        await settle(p);
                 },
                 widths,
                 ignore,
@@ -546,12 +561,27 @@ export function defineCrawlCapture(options) {
             }));
             // Budget the whole sweep up front: one test captures every surface, and
             // captureSurface no longer sets its own timeout, so size it to the work found.
-            test.setTimeout(Math.max(180_000, captureSurfaces.reduce((sum, surface) => sum + (surface.widths?.length ?? 0), 0) * 60_000));
+            // With auto-width the band count isn't known until each surface renders, so
+            // assume up to 4 bands per surface.
+            test.setTimeout(Math.max(180_000, captureSurfaces.reduce((sum, surface) => sum + (surface.widths?.length ?? 4), 0) * 60_000));
             // 2. Capture each discovered surface. Aggregate failures so one bad surface
             //    reports without skipping the rest — they're an independent set, not a chain.
             const failures = [];
             for (const surface of captureSurfaces) {
-                for (const width of surface.widths ?? []) {
+                // Auto-width parity with explicit surfaces: no widths given → navigate once and
+                // detect this surface's @media bands, then sweep one viewport per band.
+                let sweep = surface.widths;
+                if (!sweep || sweep.length === 0) {
+                    try {
+                        await surface.go(page);
+                        sweep = await detectViewportWidths(page);
+                    }
+                    catch (e) {
+                        failures.push(`${surface.key} @ auto: ${e.message}`);
+                        continue;
+                    }
+                }
+                for (const width of sweep) {
                     try {
                         await captureSurface(page, surface, width, settings);
                     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "styleproof",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "description": "Catch every CSS change before it ships — review PRs and certify refactors by the browser's computed styles, not pixels. Works with any styling system.",
   "keywords": [
     "playwright",