@krapwoo/ds-viewer 0.4.8 → 0.5.0

package/README.md

@@ -272,6 +272,28 @@ actually apply:
   in an iPhone SE viewport (375 × 667 points), scaled down only when its cell is narrower. In the
   browser viewer it opens that example in its own device-sized document, so overlays that portal
   to the page (React Native's `Modal`) open inside the phone, not over the catalog.
+- **`OverlayDemo`** — a phone with a catalog button that opens an overlay. Children get
+  `{ open, close }`; keep the overlay mounted and drive its own `visible` from `open`, so its
+  animations play. `keepTrigger` makes the button a toggle; `triggerLabel` can follow the state;
+  `initiallyOpen` starts it open.
+  ```tsx
+  <OverlayDemo triggerLabel="Open sheet">
+    {({ open, close }) => (
+      <BottomSheet visible={open} onDismiss={close} footer={<Dock><Button label="Confirm" onPress={close} /></Dock>}>
+        …
+      </BottomSheet>
+    )}
+  </OverlayDemo>
+  ```
+- **`PhoneScreen`** — a whole app screen inside a `PhoneFrame`: `header` stays at the top,
+  `footer` at the phone's bottom, and the children scroll between them instead of pushing the
+  footer off the screen. `floating` is a layer over the top for toasts (position its content
+  yourself); `bodyWrapper` puts your own surface around the scrolling body.
+  ```tsx
+  <PhoneFrame>
+    <PhoneScreen header={<TopNav title="Saved trips" />} footer={<Dock>…</Dock>}>…</PhoneScreen>
+  </PhoneFrame>
+  ```
 - Full-width (`itemsFill`) variants and states wrap at most **3** across; set `maxColumns` to
   change that. A filled example that keeps its own fixed width is centred in its cell.
   Default to one preview; add a second width only when a narrower (or wider) viewport actually
@@ -463,6 +485,27 @@ Button
   dynamically-constructed references remain uncheckable rather than being guessed at. A
   declared `intentionalStaticPreview` is taken as the author's own call, not independently
   verified; only a real browser check confirms actual behavior.
+- `overlay-without-device-frame` (warning) — the component imports React Native's `Modal`, which
+  opens over the whole catalog page on the web, but its page imports no `PhoneFrame`,
+  `OverlayDemo`, `PhoneScreen` or `BoundedOverlayViewport`. Conservative: it can't see
+  `import * as RN`, a re-exported `Modal`, or a Modal opened by a sub-component.
+
+### `doctor --render`
+
+`npx ds-viewer doctor --render` also starts the viewer, opens every page in a headless browser,
+and adds what only a real render shows:
+
+- `render-error` / `render-no-heading` (errors): a console error, or a page that didn't render.
+- `render-layout` (warning): an example wider than its cell (the viewer's own check), with the
+  page and file. `render-catalog-warning` (warning): any other `[Catalog]` warning, reported once.
+- `render-unavailable` / `render-failed` (errors): no browser, or the catalog didn't start.
+
+It needs `puppeteer` in your project (`npm install --save-dev puppeteer`); ds-viewer doesn't
+install a browser. It takes about two minutes for 50 pages and works with `--json` (progress
+goes to stderr), `--ci` and `doctor.strict`, so CI can run `npx ds-viewer doctor --render --ci`.
+It stops the viewer it started, including on Ctrl-C (exit codes 130, 143 or 129 for SIGINT,
+SIGTERM or SIGHUP). On Windows it stops the viewer with `taskkill`; that path is unit-tested, not
+run on a real Windows machine.
 
 ## Known gaps
 

package/dist/cli/dev.js

@@ -106,6 +106,7 @@ function packageManagerLabel(pm) {
  *  (the endpoint, Task 12, refuses `POST /update` itself); this function only ever runs a plan it
  *  has already been told is safe to apply. */
 export async function performUpdate(config, currentVersion, plan, deps) {
+    const startAt = deps.from === 'doctor' ? 3 : deps.from === 'migrate' ? 2 : 1;
     const migrationCount = plan.files.filter((f) => f.reason.startsWith('migration:')).length;
     const pm = detectPackageManager(config.projectRoot);
     // Names the detected package manager and the real migration count (Important finding, Fable
@@ -133,30 +134,34 @@ export async function performUpdate(config, currentVersion, plan, deps) {
             state: i < completedCount ? 'done' : i === completedCount ? 'now' : 'todo',
         })),
     });
-    report(1);
-    const { command, args } = installUpgradeCommand(pm, '@krapwoo/ds-viewer', plan.latest);
-    try {
-        await deps.execImpl(command, args, { cwd: config.projectRoot, encoding: 'utf8' });
-    }
-    catch (error) {
-        deps.onStatus({ phase: 'failure', log: error.message, failedStep: stepDefs[1].failLabel ?? stepDefs[1].label });
-        return;
-    }
-    report(2);
-    try {
-        await deps.execImpl('node', [installedMainJs(config.projectRoot), 'migrate', '--from', currentVersion], { cwd: config.projectRoot, encoding: 'utf8' });
+    report(startAt);
+    if (startAt <= 1) {
+        const { command, args } = installUpgradeCommand(pm, '@krapwoo/ds-viewer', plan.latest);
+        try {
+            await deps.execImpl(command, args, { cwd: config.projectRoot, encoding: 'utf8' });
+        }
+        catch (error) {
+            deps.onStatus({ phase: 'failure', log: error.message, failedStep: stepDefs[1].failLabel ?? stepDefs[1].label, step: 'install' });
+            return;
+        }
+        report(2);
     }
-    catch (error) {
-        deps.onStatus({ phase: 'failure', log: error.message, failedStep: stepDefs[2].label });
-        return;
+    if (startAt <= 2) {
+        try {
+            await deps.execImpl('node', [installedMainJs(config.projectRoot), 'migrate', '--from', currentVersion], { cwd: config.projectRoot, encoding: 'utf8' });
+        }
+        catch (error) {
+            deps.onStatus({ phase: 'failure', log: error.message, failedStep: stepDefs[2].label, step: 'migrate' });
+            return;
+        }
+        report(3);
     }
-    report(3);
     let doctorOutput;
     try {
         doctorOutput = await deps.execImpl('node', [installedMainJs(config.projectRoot), 'doctor'], { cwd: config.projectRoot, encoding: 'utf8' });
     }
     catch (error) {
-        deps.onStatus({ phase: 'failure', log: error.message, failedStep: stepDefs[3].label });
+        deps.onStatus({ phase: 'failure', log: error.message, failedStep: stepDefs[3].label, step: 'doctor' });
         return;
     }
     report(4);
@@ -331,32 +336,56 @@ export async function dev(initialConfig, devOptions = {}) {
     let child;
     const secret = randomBytes(24).toString('hex');
     const allowedOrigin = `http://localhost:${port}`;
+    // The plan the last update ran with, so a failed migrate or doctor step can be resumed.
+    let lastPlan;
+    const runUpdate = (plan, from) => {
+        lastPlan = plan;
+        watchersPaused = true;
+        void performUpdate(config, ownVersion, plan, {
+            execImpl: defaultExecImpl,
+            from,
+            onStatus: (status) => {
+                updateStatus = status;
+                if (status.phase === 'failure')
+                    watchersPaused = false; // the update stopped — keep developing on the old version.
+            },
+            restart: async (result) => {
+                writeFileSync(statusFile, JSON.stringify({ phase: 'success', ...result }));
+                await performRestart({ projectRoot: config.projectRoot, port, child, watchers, endpointServer, doctorSummary: result.doctorSummary, files: result.files });
+            },
+        }).catch((error) => {
+            // `performUpdate` only reports 'failure' from its own guarded steps; anything thrown outside
+            // them (e.g. writing the status file) lands here instead of as an unhandled rejection.
+            updateStatus = { phase: 'failure', log: error.message, failedStep: 'Updating', step: 'other' };
+            watchersPaused = false;
+        });
+    };
     const endpointDeps = {
         secret,
         allowedOrigin,
         buildPlan: () => buildUpdatePlan(config, ownVersion),
-        startUpdate: (plan) => {
-            watchersPaused = true;
-            void performUpdate(config, ownVersion, plan, {
-                execImpl: defaultExecImpl,
-                onStatus: (status) => {
-                    updateStatus = status;
-                    if (status.phase === 'failure')
-                        watchersPaused = false; // the update stopped — keep developing on the old version.
-                },
-                restart: async (result) => {
-                    writeFileSync(statusFile, JSON.stringify({ phase: 'success', ...result }));
-                    await performRestart({ projectRoot: config.projectRoot, port, child, watchers, endpointServer, doctorSummary: result.doctorSummary, files: result.files });
-                },
-            }).catch((error) => {
-                // Minor finding, Fable correction pass: `performUpdate` only ever reports `'failure'` from
-                // its own guarded steps — a throw outside them (e.g. `writeFileSync(statusFile)` itself
-                // failing) previously became an unhandled rejection with nothing watching for it.
-                updateStatus = { phase: 'failure', log: error.message, failedStep: 'Updating' };
-                watchersPaused = false;
+        // Install, migrate, doctor, restart; `from` resumes after a failed migrate or doctor step.
+        startUpdate: (plan) => runUpdate(plan),
+        getStatus: () => updateStatus,
+        dismissStatus: () => {
+            updateStatus = { phase: 'idle' };
+        },
+        resumeUpdate: (step) => {
+            if (lastPlan) {
+                runUpdate(lastPlan, step);
+                return;
+            }
+            // No plan in memory (this process didn't run the failed update): rebuild it first.
+            updateStatus = { phase: 'updating', steps: [{ label: 'Preparing', state: 'now' }] };
+            void buildUpdatePlan(config, ownVersion).then((plan) => {
+                if ('error' in plan)
+                    updateStatus = { phase: 'failure', log: plan.error, failedStep: 'Preparing', step: 'other' };
+                else
+                    runUpdate(plan, step);
+            }, (error) => {
+                updateStatus = { phase: 'failure', log: error.message, failedStep: 'Preparing', step: 'other' };
             });
         },
-        getStatus: () => updateStatus,
         getVersionStatus: version.getVersionStatus,
         checkNow: version.checkNow,
         setAutoCheck: version.setAutoCheck,

package/dist/cli/doctor.js

@@ -3,7 +3,7 @@ import { readFileSync } from 'node:fs';
 import path from 'node:path';
 import { discoverAllPageFiles, resolvePageId } from "./pageIndex.js";
 import { readHostTsconfigOptions } from "./props.js";
-import { readStaticPages } from "./staticPage.js";
+import { importedNames, readStaticPages } from "./staticPage.js";
 import { resolveGlob } from "./glob.js";
 import { sync } from "./sync.js";
 import { gridColumnLimit } from "../native/catalog/comparison.js";
@@ -208,6 +208,43 @@ function checkMissingComposition(pages, components) {
     }
     return issues;
 }
+/** The viewer exports that frame an example as a phone (or another bounded document), so an
+ *  overlay that portals to the document body opens inside it instead of over the catalog. */
+const DEVICE_FRAME_EXPORTS = ['PhoneFrame', 'OverlayDemo', 'PhoneScreen', 'BoundedOverlayViewport'];
+/** Whether a component's own source imports React Native's `Modal` (by its imported name, so an
+ *  alias still counts and an unrelated local `Modal` doesn't). Conservative by design: it can't see
+ *  `import * as RN`, a re-exported `Modal`, or a Modal opened by a sub-component. */
+function importsModal(file) {
+    try {
+        const source = ts.createSourceFile(file, readFileSync(file, 'utf8'), ts.ScriptTarget.ES2022, true, ts.ScriptKind.TSX);
+        return [...importedNames(source, 'react-native').values()].includes('Modal');
+    }
+    catch {
+        return false;
+    }
+}
+/** `overlay-without-device-frame`: a page whose component opens a React Native `Modal` (which
+ *  portals to the document body on the web, covering the whole catalog) but whose page imports no
+ *  device frame. A page whose imports couldn't be read is skipped, never assumed unframed. */
+export function checkOverlaysFramed(pages, components, projectRoot) {
+    const byName = new Map(components.map((c) => [c.name, c]));
+    const issues = [];
+    for (const page of pages) {
+        if (!page.component || page.viewerImports === undefined)
+            continue;
+        if (page.viewerImports.some((name) => DEVICE_FRAME_EXPORTS.includes(name)))
+            continue;
+        const component = byName.get(page.component);
+        if (!component || !importsModal(path.resolve(projectRoot, component.file)))
+            continue;
+        issues.push(issue({
+            id: 'overlay-without-device-frame', severity: 'warning', ...pageRef(page),
+            message: `"${component.name}" opens a React Native Modal, which covers the whole catalog page unless its example is inside a phone.`,
+            fix: 'Wrap the example in <PhoneFrame> (or use <OverlayDemo>), so it opens inside the phone.',
+        }));
+    }
+    return issues;
+}
 /** A function-typed prop's printed type always contains `=>` (`cli/props.ts`'s own displayed type
  *  strings — "(value: string) => void", "() => void", …); a plain data prop's never does. */
 function isFunctionPropType(type) {
@@ -509,6 +546,15 @@ export function checkPageTypeErrors(pages, options = {}) {
     }
     return issues;
 }
+/** Adds findings to a finished result: applies `doctor.strict`, recounts errors and warnings, and
+ *  resets the exit code. */
+export function withExtraIssues(result, extra, strict) {
+    const added = strict ? extra.map((i) => (i.severity === 'warning' ? { ...i, severity: 'error' } : i)) : extra;
+    const issues = [...result.issues, ...added];
+    const errors = issues.filter((i) => i.severity === 'error').length;
+    const summary = { ...result.summary, errors, warnings: issues.length - errors };
+    return { ...result, issues, summary, exitCode: errors > 0 ? 1 : 0 };
+}
 /** "With examples" means what `checkComponentNoExamples` (Task 4) checks the *absence* of: at
  *  least one checkable page with a real example, not merely "has a page" (an `init`-drafted
  *  "Needs examples" page has one, with none). */
@@ -572,6 +618,7 @@ export function runDoctor(config) {
     let issues = [
         ...collectIssues(pages, components),
         ...checkPageTypeErrors(pages, { fallbackPaths, hostRoot: config.projectRoot }),
+        ...checkOverlaysFramed(pages, components, config.projectRoot),
         ...collectGlobalIssues({ syncWarnings: syncResult.warnings, tokenFileCount }),
     ];
     // Design's own `--json` example gives a project-relative `file`; `StaticPage.file` is absolute
@@ -588,7 +635,8 @@ export function runDoctor(config) {
         withExamples: countWithExamples(pages, components),
         unboundExamples: countUnboundExamples(pages),
     };
-    return { version: 1, summary, update: null, issues, exitCode: summary.errors > 0 ? 1 : 0 };
+    const pageFileById = new Map(pages.map((p) => [resolvePageId(p, p.file), path.relative(config.projectRoot, p.file)]));
+    return { version: 1, summary, update: null, issues, exitCode: summary.errors > 0 ? 1 : 0, pageFiles: pageFileById };
 }
 export function toDoctorJson(result) {
     const { version, summary, update, issues } = result;

package/dist/cli/endpoint.js

@@ -166,6 +166,39 @@ export function createUpdateEndpoint(deps) {
             });
             return;
         }
+        if (req.method === 'POST' && req.url === '/update/dismiss' && deps.dismissStatus) {
+            const phase = deps.getStatus().phase;
+            if (starting || phase === 'updating' || phase === 'restarting') {
+                sendJson(res, 409, { error: 'An update is running.' }, deps.allowedOrigin);
+                return;
+            }
+            deps.dismissStatus();
+            sendJson(res, 200, deps.getStatus(), deps.allowedOrigin);
+            return;
+        }
+        if (req.method === 'POST' && req.url === '/update/resume' && deps.resumeUpdate) {
+            const status = deps.getStatus();
+            const step = status.phase === 'failure' ? status.step : undefined;
+            if (starting || (step !== 'migrate' && step !== 'doctor')) {
+                sendJson(res, 409, { error: 'There is no failed migrate or doctor step to resume.' }, deps.allowedOrigin);
+                return;
+            }
+            // Same reasoning as POST /update: answer first, then run the work on the next tick.
+            starting = true;
+            sendJson(res, 202, { started: true }, deps.allowedOrigin);
+            setImmediate(() => {
+                try {
+                    deps.resumeUpdate(step);
+                }
+                catch (error) {
+                    console.warn('Update could not resume: ' + error.message);
+                }
+                finally {
+                    starting = false;
+                }
+            });
+            return;
+        }
         if (req.method === 'GET' && req.url === '/update/status') {
             sendJson(res, 200, deps.getStatus(), deps.allowedOrigin);
             return;

package/dist/cli/main.js

@@ -5,7 +5,8 @@ import { resolveConfig } from "./config.js";
 import { initExistingProject, initNewProject, promptInitMode } from "./init.js";
 import { dev } from "./dev.js";
 import { sync } from "./sync.js";
-import { formatHuman, runDoctor, toDoctorJson } from "./doctor.js";
+import { formatHuman, runDoctor, toDoctorJson, withExtraIssues } from "./doctor.js";
+import { renderCheck } from "./render.js";
 import { explainPage, formatExplain, parseHeights } from "./explain.js";
 import { readOwnVersion } from "./packageVersion.js";
 import { checkForUpdate, defaultPreferencesDir, readPersonalAutoCheck, resolveAutoCheck } from "./updateCheck.js";
@@ -27,6 +28,7 @@ Commands:
   doctor   Check every page for drift and coverage gaps
            --json          print the machine-readable report instead
            --ci            exit 1 when any error was found (never on a warning alone)
+           --render        also open every page in a headless browser (needs puppeteer)
   explain <Page>
            Print why a page's specimens are laid out the way they are
            --heights <first>,<second>  check side-by-side placement with these measured heights
@@ -116,7 +118,14 @@ export async function runInit(projectRoot, rest, options = {}) {
  *  plain `doctor` (no `--ci`) always returns 0 here regardless of errors found. */
 export async function runDoctorCommand(projectRoot, rest, options = {}) {
     const config = resolveConfig(projectRoot);
-    const result = runDoctor(config);
+    let result = runDoctor(config);
+    // `--render`: open every page in a headless browser and add what only a real render shows.
+    // Progress goes to stderr, so `--json` output stays pure JSON.
+    if (rest.includes('--render')) {
+        const files = result.pageFiles;
+        const rendered = await (options.renderCheck ?? renderCheck)(config.projectRoot, { files, log: (line) => process.stderr.write(`${line}\n`) });
+        result = withExtraIssues(result, rendered, Boolean(config.doctor?.strict));
+    }
     // Design §4 "`--ci`: ... no update check." — `--ci` skips this whole block even when
     // `updateCheck` is otherwise enabled; `result.update` stays `null`.
     // Same precedence as the viewer: CI's environment variable, your own switch, the project config.

package/dist/cli/render.js

@@ -0,0 +1,247 @@
+// cli/render.ts — `doctor --render`: open every catalog page in a headless browser and report what
+// only a real render shows (console errors, pages that fail to render, the viewer's own [Catalog]
+// layout warnings). The browser is resolved from the project; ds-viewer never installs one.
+import { spawn, spawnSync } from 'node:child_process';
+import { createRequire } from 'node:module';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+const OVERFLOW = /is \d+px wide in a \d+px cell/;
+/**
+ * Turns one page's console output into doctor findings. Console errors and a missing heading are
+ * errors. The viewer's own `[Catalog]` warnings are warnings: `render-layout` for an example that
+ * overflows its cell, `render-catalog-warning` for anything else. Other console noise (React Native
+ * web deprecations, logs) is ignored. `seen` is shared across the whole run, so a warning the
+ * catalog logs on every page (a duplicate id, an unknown `composedOf` name) is reported once.
+ */
+export function issuesFromPage(page, messages, hasHeading, seen = new Set()) {
+    const ref = { page: page.id, ...(page.file ? { file: page.file } : {}) };
+    const issues = [];
+    if (!hasHeading) {
+        issues.push({ id: 'render-no-heading', severity: 'error', ...ref, message: 'The page rendered without its heading, so it probably failed to render.', fix: 'Open the page in `ds-viewer dev` and check the browser console.' });
+    }
+    const pageErrors = new Set();
+    for (const m of messages) {
+        const first = m.text.split('\n')[0];
+        if (m.type === 'error' || m.type === 'pageerror') {
+            if (pageErrors.has(first))
+                continue;
+            pageErrors.add(first);
+            issues.push({ id: 'render-error', severity: 'error', ...ref, message: `Console error while rendering: ${first}`, fix: 'Open the page in `ds-viewer dev` and fix the error in the browser console.' });
+        }
+        else if ((m.type === 'warn' || m.type === 'warning') && first.startsWith('[Catalog] ')) {
+            const text = first.slice('[Catalog] '.length);
+            if (seen.has(text))
+                continue;
+            seen.add(text);
+            issues.push(OVERFLOW.test(text)
+                ? { id: 'render-layout', severity: 'warning', ...ref, message: text, fix: 'Give the page a wider specimenSize; see the README page guide.' }
+                : { id: 'render-catalog-warning', severity: 'warning', ...ref, message: text, fix: 'Follow the message; the static doctor rule of the same name has the details.' });
+        }
+    }
+    return issues;
+}
+/** The project's own puppeteer, or `undefined` when it isn't installed. */
+export function loadProjectPuppeteer(projectRoot) {
+    try {
+        return createRequire(path.join(path.resolve(projectRoot), 'package.json'))('puppeteer');
+    }
+    catch {
+        return undefined;
+    }
+}
+export const RENDER_UNAVAILABLE = {
+    id: 'render-unavailable',
+    severity: 'error',
+    message: "`doctor --render` needs a headless browser, and puppeteer isn't installed in this project.",
+    fix: 'npm install --save-dev puppeteer (then run doctor --render again).',
+};
+const DEV_START_TIMEOUT_MS = 120_000;
+const FIRST_LOAD_TIMEOUT_MS = 300_000;
+const PAGE_TIMEOUT_MS = 120_000;
+const SETTLE_MS = 900;
+/** Stops `dev` and everything it started (Expo/Metro): the whole process tree on Windows, the
+ *  whole process group elsewhere (Expo stops through dev's own signal handler). Releases the pipes
+ *  so this process can exit. `os` is injectable for tests. */
+export function stopDev(child, os = {}) {
+    const platform = os.platform ?? process.platform;
+    if (child.pid) {
+        try {
+            if (platform === 'win32')
+                (os.spawnSync ?? spawnSync)('taskkill', ['/pid', String(child.pid), '/T', '/F'], { stdio: 'ignore' });
+            else
+                (os.kill ?? ((pid, signal) => process.kill(pid, signal)))(-child.pid, 'SIGTERM');
+        }
+        catch {
+            // Already exited.
+        }
+    }
+    child.stdout?.destroy();
+    child.stderr?.destroy();
+    child.unref();
+}
+/** The last few KB of dev's output, so a failed start can say why. */
+function outputTail() {
+    let tail = '';
+    return {
+        push: (data) => {
+            tail = (tail + String(data)).slice(-4000);
+        },
+        text: () => {
+            const lines = tail.trim().split('\n').slice(-8).join('\n');
+            return lines ? `\n${lines}` : '';
+        },
+    };
+}
+/** Starts the project's own `dev` in its own process group. `onSpawn` receives the child at once,
+ *  so a signal during startup can still stop it. */
+function startDev(projectRoot, onSpawn) {
+    const main = path.join(path.dirname(fileURLToPath(import.meta.url)), 'main.js');
+    return new Promise((resolve, reject) => {
+        const child = spawn(process.execPath, [main, 'dev'], {
+            cwd: projectRoot,
+            env: { ...process.env, CI: '1', DS_VIEWER_NO_UPDATE_CHECK: '1' },
+            detached: process.platform !== 'win32',
+            stdio: ['ignore', 'pipe', 'pipe'],
+        });
+        onSpawn(child);
+        const output = outputTail();
+        let done = false;
+        const fail = (message) => {
+            if (done)
+                return;
+            done = true;
+            clearTimeout(timer);
+            stopDev(child);
+            reject(new Error(`${message}${output.text()}`));
+        };
+        const timer = setTimeout(() => fail('Timed out waiting for ds-viewer dev to start.'), DEV_START_TIMEOUT_MS);
+        // Read continuously (so Metro's output never fills the pipe) and keep the tail for errors.
+        child.stderr?.on('data', output.push);
+        child.stdout?.on('data', (data) => {
+            output.push(data);
+            const match = String(data).match(/Starting the catalog at http:\/\/localhost:(\d+)/);
+            if (match && !done) {
+                done = true;
+                clearTimeout(timer);
+                resolve({ child, port: Number(match[1]) });
+            }
+        });
+        child.on('exit', (code) => fail(`ds-viewer dev exited early (code ${code}).`));
+    });
+}
+const SIGNAL_EXIT_CODES = { SIGINT: 130, SIGTERM: 143, SIGHUP: 129 };
+/** A sidebar href's page id; a malformed escape falls back to the raw text (like `idFromHash`). */
+function idFromHref(href) {
+    const raw = href.slice(1);
+    try {
+        return decodeURIComponent(raw);
+    }
+    catch {
+        return raw;
+    }
+}
+/** Opens every sidebar page and returns its findings. `files` maps page ids to project-relative
+ *  page files, for the findings' `file`. `log` receives progress lines (stderr in the CLI). `deps`
+ *  replaces the browser, dev process control and exit for tests. */
+export async function renderCheck(projectRoot, options = {}) {
+    projectRoot = path.resolve(projectRoot);
+    const deps = options.deps ?? {};
+    const puppeteer = (deps.puppeteer ?? loadProjectPuppeteer(projectRoot));
+    if (!puppeteer)
+        return [RENDER_UNAVAILABLE];
+    const stop = deps.stopDev ?? ((child) => stopDev(child));
+    const exit = deps.exit ?? ((code) => process.exit(code));
+    const log = options.log ?? (() => { });
+    // Set as soon as dev is spawned, before it's ready, so a signal during startup still stops it.
+    let devChild;
+    let port = 0;
+    let browser;
+    // Ctrl-C or a CI cancel must still stop Metro: `dev` runs in its own process group, so the
+    // terminal's signal never reaches it. Registered before the browser launches, so it runs ahead
+    // of puppeteer's own handler.
+    const handlers = Object.keys(SIGNAL_EXIT_CODES).map((signal) => {
+        const handler = () => {
+            if (devChild)
+                stop(devChild);
+            exit(SIGNAL_EXIT_CODES[signal]);
+        };
+        process.on(signal, handler);
+        return [signal, handler];
+    });
+    try {
+        // The browser first: a missing browser download shouldn't start Metro for nothing.
+        try {
+            browser = await puppeteer.launch({ headless: true });
+        }
+        catch (error) {
+            return [{ ...RENDER_UNAVAILABLE, message: `Couldn't start the headless browser: ${error.message.split('\n')[0]}`, fix: 'npx puppeteer browsers install chrome' }];
+        }
+        ({ port } = await (deps.startDev ?? startDev)(projectRoot, (child) => {
+            devChild = child;
+        }));
+        const home = await browser.newPage();
+        const deadline = Date.now() + FIRST_LOAD_TIMEOUT_MS;
+        for (;;) {
+            try {
+                await home.goto(`http://localhost:${port}`, { waitUntil: 'networkidle0', timeout: FIRST_LOAD_TIMEOUT_MS });
+                break;
+            }
+            catch (error) {
+                if (!String(error).includes('ERR_CONNECTION_REFUSED') || Date.now() > deadline)
+                    throw error;
+                await new Promise((r) => setTimeout(r, 1000));
+            }
+        }
+        // Runs in the browser; `document` is typed loosely because the CLI compiles without DOM types.
+        const hrefs = await home.evaluate(() => {
+            const doc = globalThis.document;
+            return [...new Set(Array.from(doc.querySelectorAll('a[href^="#"]')).map((a) => a.getAttribute('href') ?? ''))];
+        });
+        await home.close();
+        const ids = hrefs.map(idFromHref).filter(Boolean);
+        if (ids.length === 0) {
+            return [{ id: 'render-failed', severity: 'error', message: 'The catalog rendered no sidebar links, so it probably failed to render at all.', fix: 'Run `ds-viewer dev` and check the browser console.' }];
+        }
+        log(`Rendering ${ids.length} pages…`);
+        const seen = new Set();
+        const issues = [];
+        for (const id of ids) {
+            // One page failing (a navigation timeout) is that page's finding; the others still run.
+            let page;
+            try {
+                page = await browser.newPage();
+                await page.setViewport({ width: 1280, height: 800 });
+                const messages = [];
+                page.on('console', (m) => messages.push({ type: m.type(), text: m.text() }));
+                page.on('pageerror', (e) => messages.push({ type: 'pageerror', text: String(e) }));
+                await page.goto(`http://localhost:${port}/#${encodeURIComponent(id)}`, { waitUntil: 'networkidle0', timeout: PAGE_TIMEOUT_MS });
+                await new Promise((r) => setTimeout(r, options.settleMs ?? SETTLE_MS));
+                const hasHeading = await page.evaluate(() => {
+                    const doc = globalThis.document;
+                    return Boolean(doc.querySelector('[role="heading"]')?.textContent?.trim());
+                });
+                issues.push(...issuesFromPage({ id, file: options.files?.get(id) }, messages, hasHeading, seen));
+                await page.close();
+            }
+            catch (error) {
+                // A stuck page's tab is closed, so it doesn't keep loading next to the remaining pages.
+                await page?.close().catch(() => { });
+                const file = options.files?.get(id);
+                issues.push({ id: 'render-error', severity: 'error', page: id, ...(file ? { file } : {}), message: `Couldn't open the page: ${error.message.split('\n')[0]}`, fix: 'Open the page in `ds-viewer dev`; it may be very slow to load or stuck.' });
+            }
+        }
+        log(`Checked ${ids.length} pages.`);
+        return issues;
+    }
+    catch (error) {
+        return [{ id: 'render-failed', severity: 'error', message: `Couldn't render the catalog: ${error.message}`, fix: "Run `ds-viewer dev` to see why the catalog doesn't start." }];
+    }
+    finally {
+        for (const [signal, handler] of handlers)
+            process.off(signal, handler);
+        if (browser)
+            await browser.close().catch(() => { });
+        if (devChild)
+            stop(devChild);
+    }
+}

package/dist/cli/staticPage.js

@@ -42,6 +42,7 @@ function readStaticPage(file) {
     }
     const sourceFile = ts.createSourceFile(file, text, ts.ScriptTarget.ES2022, true, ts.ScriptKind.TSX);
     const imports = importedNames(sourceFile, '@krapwoo/ds-viewer');
+    const viewerImports = [...new Set(imports.values())];
     const defineCatalogPageNames = localNamesFor(imports, 'defineCatalogPage');
     const gridNames = localNamesFor(imports, 'grid');
     const call = defaultExportCall(sourceFile);
@@ -49,13 +50,13 @@ function readStaticPage(file) {
         // Not a recognized `defineCatalogPage(...)` default export — e.g. a hand-written object, or a
         // shadowed/renamed import this reader can't trace. Not a parse error: the file is valid
         // TypeScript, just not literal-checkable.
-        return { file, checkable: false };
+        return { file, checkable: false, viewerImports };
     }
     const consts = topLevelConsts(sourceFile);
     const pageObject = resolve(call.arguments[0], consts, new Set());
     if (!ts.isObjectLiteralExpression(pageObject))
-        return { file, checkable: false };
-    const page = { file, checkable: true };
+        return { file, checkable: false, viewerImports };
+    const page = { file, checkable: true, viewerImports };
     const idProp = findProp(pageObject, 'id');
     const componentProp = findProp(pageObject, 'component');
     const groupProp = findProp(pageObject, 'group');
@@ -193,16 +194,21 @@ function readComposedOf(node, consts) {
     return entries;
 }
 /** Local name -> imported name, for every named import from `moduleSpecifier`. */
-function importedNames(sourceFile, moduleSpecifier) {
+export function importedNames(sourceFile, moduleSpecifier) {
     const names = new Map();
     for (const statement of sourceFile.statements) {
         if (!ts.isImportDeclaration(statement) || !ts.isStringLiteral(statement.moduleSpecifier) || statement.moduleSpecifier.text !== moduleSpecifier) {
             continue;
         }
+        // Type-only imports bring no runtime value (`import type { X }`, `import { type X }`).
+        if (statement.importClause?.isTypeOnly)
+            continue;
         const bindings = statement.importClause?.namedBindings;
         if (!bindings || !ts.isNamedImports(bindings))
             continue;
         for (const element of bindings.elements) {
+            if (element.isTypeOnly)
+                continue;
             names.set(element.name.text, element.propertyName ? element.propertyName.text : element.name.text);
         }
     }