@nitpicker/report-html 0.20.0

package/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 D-ZERO Co., Ltd.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,19 @@
+# @nitpicker/report-html
+
+Generates a self-contained HTML report from a completed Nitpicker archive.
+The document contains the viewer summary and a bounded internal-page table,
+requires no Google credentials, and can be opened directly with `file://`.
+
+Use the CLI for interactive directory selection:
+
+```sh
+yarn cli report ./site.nitpicker --html
+```
+
+The package API is also available:
+
+```ts
+import { report } from '@nitpicker/report-html';
+
+await report({ filePath: './site.nitpicker' });
+```

package/lib/collect-html-report-pages.d.ts

@@ -0,0 +1,12 @@
+import type { ArchiveAccessor } from '@nitpicker/crawler';
+import type { HtmlReportPage } from '@nitpicker/viewer/report-ui';
+/**
+ * Collects inner-page rows for a static HTML report in `natural_url_rank`
+ * order, attaching redirect sources and per-page resource-file tallies.
+ * @param accessor - Archive whose viewer read model is already current.
+ * @param directories - Directory-prefix filters. Empty or omitted lists every inner page.
+ * @returns Page rows ready for `renderHtmlReport`.
+ * @example
+ * const pages = await collectHtmlReportPages(accessor, ['/docs']);
+ */
+export declare function collectHtmlReportPages(accessor: ArchiveAccessor, directories?: readonly string[]): Promise<HtmlReportPage[]>;

package/lib/collect-html-report-pages.js

@@ -0,0 +1,31 @@
+import { buildRedirectFromUrlsByDestId, getResourceFileCountsByPageIds, streamPageListRows, } from '@nitpicker/query';
+/**
+ * Collects inner-page rows for a static HTML report in `natural_url_rank`
+ * order, attaching redirect sources and per-page resource-file tallies.
+ * @param accessor - Archive whose viewer read model is already current.
+ * @param directories - Directory-prefix filters. Empty or omitted lists every inner page.
+ * @returns Page rows ready for `renderHtmlReport`.
+ * @example
+ * const pages = await collectHtmlReportPages(accessor, ['/docs']);
+ */
+export async function collectHtmlReportPages(accessor, directories = []) {
+    const redirectFrom = await buildRedirectFromUrlsByDestId(accessor);
+    const pages = [];
+    for await (const chunk of streamPageListRows(accessor, { directories })) {
+        const counts = await getResourceFileCountsByPageIds(accessor, chunk.map((row) => row.pageId));
+        for (const row of chunk) {
+            const resources = counts.get(row.pageId) ?? { total: 0, exists: 0 };
+            pages.push({
+                title: row.title,
+                url: row.url,
+                status: row.status,
+                redirectChain: [...(redirectFrom.get(row.pageId) ?? [])].toSorted((left, right) => left.localeCompare(right)),
+                metaDescription: row.description,
+                resourceFilesExists: resources.exists,
+                resourceFilesTotal: resources.total,
+                consoleErrorCount: row.consoleErrorCount,
+            });
+        }
+    }
+    return pages;
+}

package/lib/html-report-cancelled-error.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Thrown when the interactive directory prompt is dismissed (Ctrl+C), so
+ * `report()` can unwind `await using` archive disposal instead of calling
+ * `process.exit` from inside the library.
+ *
+ * `report-google-sheets` still exits immediately to dodge an enquirer
+ * readline double-close; HTML reporting prefers a clean archive close, and
+ * the CLI maps this error to exit code 0.
+ * @example
+ * ```ts
+ * throw new HtmlReportCancelledError();
+ * ```
+ */
+export declare class HtmlReportCancelledError extends Error {
+    constructor();
+}

package/lib/html-report-cancelled-error.js

@@ -0,0 +1,19 @@
+/**
+ * Thrown when the interactive directory prompt is dismissed (Ctrl+C), so
+ * `report()` can unwind `await using` archive disposal instead of calling
+ * `process.exit` from inside the library.
+ *
+ * `report-google-sheets` still exits immediately to dodge an enquirer
+ * readline double-close; HTML reporting prefers a clean archive close, and
+ * the CLI maps this error to exit code 0.
+ * @example
+ * ```ts
+ * throw new HtmlReportCancelledError();
+ * ```
+ */
+export class HtmlReportCancelledError extends Error {
+    constructor() {
+        super('HTML report cancelled');
+        this.name = 'HtmlReportCancelledError';
+    }
+}

package/lib/open-report-archive.d.ts

@@ -0,0 +1,12 @@
+import type { ArchiveAccessor } from '@nitpicker/crawler';
+interface HtmlReportArchiveHandle extends AsyncDisposable {
+    readonly accessor: ArchiveAccessor;
+}
+/**
+ * Opens a completed archive through the shared read-only tar cache.
+ * @param filePath - Completed `.nitpicker` archive path.
+ * @param onExtractProgress - Optional extraction progress callback.
+ * @returns A disposable read-only archive handle.
+ */
+export declare function openReportArchive(filePath: string, onExtractProgress?: (readBytes: number, totalBytes: number) => void): Promise<HtmlReportArchiveHandle>;
+export {};

package/lib/open-report-archive.js

@@ -0,0 +1,21 @@
+import { ArchiveManager } from '@nitpicker/query';
+/**
+ * Opens a completed archive through the shared read-only tar cache.
+ * @param filePath - Completed `.nitpicker` archive path.
+ * @param onExtractProgress - Optional extraction progress callback.
+ * @returns A disposable read-only archive handle.
+ */
+export async function openReportArchive(filePath, onExtractProgress) {
+    const manager = new ArchiveManager({ onExtractProgress });
+    const { accessor, mode } = await manager.open(filePath);
+    if (mode !== 'archive') {
+        await manager.closeAll();
+        throw new Error(`report: "${filePath}" is not a completed .nitpicker archive (detected mode: "${mode}").`);
+    }
+    return {
+        accessor,
+        async [Symbol.asyncDispose]() {
+            await manager.closeAll();
+        },
+    };
+}

package/lib/parse-directory-input.d.ts

@@ -0,0 +1,17 @@
+import type { HtmlReportDirectoryPrefix } from './types.js';
+/**
+ * Parses comma-separated full URLs or absolute pathnames for report filtering.
+ *
+ * Normalization is {@link parsePageDirectoryPrefix} (full URLs go through
+ * `@d-zero/shared/parse-url`). This wrapper only rejects relative tokens such
+ * as `docs`, which the query parser would treat as `/docs`.
+ *
+ * Pathnames are not fed to `new URL(..., base)`: a leading `//` is a
+ * protocol-relative URL there, so `//blog` would collapse to the site root.
+ * @param input - User-provided comma-separated value.
+ * @returns Deduplicated normalized directory prefixes.
+ * @throws {Error} If any token is empty, relative, or non-HTTP.
+ * @example
+ * parseDirectoryInput('/docs,https://example.com/help')
+ */
+export declare function parseDirectoryInput(input: string): HtmlReportDirectoryPrefix[];

package/lib/parse-directory-input.js

@@ -0,0 +1,62 @@
+import { parsePageDirectoryPrefix } from '@nitpicker/query';
+/**
+ * Matches a token written as an absolute URL. Pathname-only input is the
+ * remainder: it must start with `/` (including `//blog`, which is a path
+ * with repeated slashes — not a protocol-relative URL).
+ */
+const ABSOLUTE_URL = /^[a-z][a-z\d+.-]*:\/\//iu;
+/**
+ * Turns query's host+pathname parse into the CLI prefix shape: pathname-only
+ * root is shown as `/`, and a host filter is rebuilt as `https://{host}{path}`
+ * because `parsePageDirectoryPrefix` ignores scheme and port.
+ * @param parsed - Output of {@link parsePageDirectoryPrefix}.
+ * @returns The corresponding HTML-report prefix.
+ */
+function toHtmlReportDirectoryPrefix(parsed) {
+    if (parsed.hostname == null) {
+        const pathname = parsed.pathname === '' ? '/' : parsed.pathname;
+        return { origin: null, pathname, display: pathname };
+    }
+    const pathname = parsed.pathname === '' ? '/' : parsed.pathname;
+    const display = `https://${parsed.hostname}${parsed.pathname}`;
+    return {
+        origin: `https://${parsed.hostname}`,
+        pathname,
+        display,
+    };
+}
+/**
+ * Parses comma-separated full URLs or absolute pathnames for report filtering.
+ *
+ * Normalization is {@link parsePageDirectoryPrefix} (full URLs go through
+ * `@d-zero/shared/parse-url`). This wrapper only rejects relative tokens such
+ * as `docs`, which the query parser would treat as `/docs`.
+ *
+ * Pathnames are not fed to `new URL(..., base)`: a leading `//` is a
+ * protocol-relative URL there, so `//blog` would collapse to the site root.
+ * @param input - User-provided comma-separated value.
+ * @returns Deduplicated normalized directory prefixes.
+ * @throws {Error} If any token is empty, relative, or non-HTTP.
+ * @example
+ * parseDirectoryInput('/docs,https://example.com/help')
+ */
+export function parseDirectoryInput(input) {
+    const rawTokens = input.split(',').map((token) => token.trim());
+    if (rawTokens.length === 0 || rawTokens.some((token) => token.length === 0)) {
+        throw new Error('Enter one or more comma-separated directory prefixes.');
+    }
+    const prefixes = rawTokens.map((token) => {
+        if (!token.startsWith('/') && !ABSOLUTE_URL.test(token)) {
+            throw new Error(`Directory prefix must be a full URL or start with "/": ${token}`);
+        }
+        try {
+            return toHtmlReportDirectoryPrefix(parsePageDirectoryPrefix(token));
+        }
+        catch (error) {
+            throw new Error(`Directory URL must use http or https: ${token}`, { cause: error });
+        }
+    });
+    return [
+        ...new Map(prefixes.map((prefix) => [`${prefix.origin ?? ''}\0${prefix.pathname}`, prefix])).values(),
+    ];
+}

package/lib/report-html.d.ts

@@ -0,0 +1,3 @@
+export { HtmlReportCancelledError } from './html-report-cancelled-error.js';
+export { report } from './report.js';
+export type { HtmlReportParams } from './types.js';

package/lib/report-html.js

@@ -0,0 +1,2 @@
+export { HtmlReportCancelledError } from './html-report-cancelled-error.js';
+export { report } from './report.js';

package/lib/report.d.ts

@@ -0,0 +1,20 @@
+import type { HtmlReportParams } from './types.js';
+/**
+ * Generates a self-contained static HTML report from a completed archive.
+ *
+ * Google credentials are never consulted. The summary is always archive-wide;
+ * only the page table is narrowed when directory prefixes are required to
+ * stay at or below 10,000 inner pages.
+ * @param params - Archive path, optional output path, and directory input.
+ * @returns Resolves when the HTML file has been written.
+ * @example
+ * ```ts
+ * await report({
+ *   filePath: './site.nitpicker',
+ *   outputPath: './site.html',
+ *   interactive: false,
+ *   directoryInput: '/docs',
+ * });
+ * ```
+ */
+export declare function report(params: HtmlReportParams): Promise<void>;

package/lib/report.js

@@ -0,0 +1,80 @@
+import { writeFile } from 'node:fs/promises';
+import { TaskList } from '@d-zero/dealer';
+import { getViewerSummary, requireViewerReadModel } from '@nitpicker/query';
+import { renderHtmlReport } from '@nitpicker/viewer/report-ui';
+import { collectHtmlReportPages } from './collect-html-report-pages.js';
+import { openReportArchive } from './open-report-archive.js';
+import { resolveDirectoryPrefixes } from './resolve-directory-prefixes.js';
+import { resolveOutputPath } from './resolve-output-path.js';
+/** A `write()`-only sink that renders nothing, for `params.silent`. */
+const NULL_STREAM = {
+    write: () => true,
+    on: () => NULL_STREAM,
+    off: () => NULL_STREAM,
+};
+/**
+ * Generates a self-contained static HTML report from a completed archive.
+ *
+ * Google credentials are never consulted. The summary is always archive-wide;
+ * only the page table is narrowed when directory prefixes are required to
+ * stay at or below 10,000 inner pages.
+ * @param params - Archive path, optional output path, and directory input.
+ * @returns Resolves when the HTML file has been written.
+ * @example
+ * ```ts
+ * await report({
+ *   filePath: './site.nitpicker',
+ *   outputPath: './site.html',
+ *   interactive: false,
+ *   directoryInput: '/docs',
+ * });
+ * ```
+ */
+export async function report(params) {
+    await using archive = await openReportArchive(params.filePath, params.onExtractProgress);
+    await requireViewerReadModel(archive.accessor);
+    const prefixes = await resolveDirectoryPrefixes({
+        accessor: archive.accessor,
+        initialInput: params.directoryInput,
+        interactive: params.interactive === true,
+        onWarn: params.silent
+            ? () => { }
+            : (message) => {
+                // eslint-disable-next-line no-console
+                console.warn(message);
+            },
+    });
+    const directoryPrefixes = prefixes.map((prefix) => prefix.display);
+    const outputPath = resolveOutputPath(params.filePath, params.outputPath);
+    let html = '';
+    let pipeline = TaskList.from(0);
+    pipeline = pipeline.pipe('Collect pages', async (input, ctx) => {
+        ctx.progress('reading inner pages...');
+        const pages = await collectHtmlReportPages(archive.accessor, directoryPrefixes);
+        const summary = await getViewerSummary(archive.accessor);
+        ctx.progress(`${pages.length.toLocaleString()} pages`);
+        html = renderHtmlReport({
+            summary,
+            pages,
+            locale: 'ja',
+            generatedAt: new Date().toISOString(),
+            directoryPrefixes,
+        });
+        return input;
+    });
+    pipeline = pipeline.pipe('Write HTML', async (input, ctx) => {
+        ctx.progress('writing...');
+        await writeFile(outputPath, html, 'utf8');
+        ctx.progress(outputPath);
+        return input;
+    });
+    await pipeline.run({
+        stream: params.silent ? NULL_STREAM : process.stderr,
+        verbose: !process.stdout.isTTY,
+        keepElapsed: true,
+    });
+    if (!params.silent) {
+        // eslint-disable-next-line no-console
+        console.log(`Wrote ${outputPath}`);
+    }
+}

package/lib/resolve-directory-prefixes.d.ts

@@ -0,0 +1,21 @@
+import type { HtmlReportDirectoryPrefix } from './types.js';
+import type { ArchiveAccessor } from '@nitpicker/crawler';
+interface ResolveDirectoryPrefixesOptions {
+    readonly accessor: ArchiveAccessor;
+    readonly initialInput?: string;
+    readonly interactive: boolean;
+    readonly onWarn: (message: string) => void;
+}
+/**
+ * Resolves and validates the directory prefixes needed to keep a report bounded.
+ * @param options - Archive, initial non-interactive value, and warning sink.
+ * @returns Valid prefixes whose union contains at most 10,000 pages.
+ * @example
+ * const prefixes = await resolveDirectoryPrefixes({
+ *   accessor,
+ *   interactive: process.stdout.isTTY === true,
+ *   onWarn: console.warn,
+ * });
+ */
+export declare function resolveDirectoryPrefixes(options: ResolveDirectoryPrefixesOptions): Promise<HtmlReportDirectoryPrefix[]>;
+export {};

package/lib/resolve-directory-prefixes.js

@@ -0,0 +1,85 @@
+import { countPageListHostnames, countPageListRows } from '@nitpicker/query';
+import enquirer from 'enquirer';
+import { HtmlReportCancelledError } from './html-report-cancelled-error.js';
+import { parseDirectoryInput } from './parse-directory-input.js';
+const PAGE_LIMIT = 10_000;
+/**
+ * Asks for comma-separated directory prefixes on a TTY.
+ * @returns The raw input string.
+ * @throws {HtmlReportCancelledError} If the prompt is dismissed.
+ */
+async function promptForInput() {
+    try {
+        const answer = await enquirer.prompt({
+            type: 'input',
+            name: 'directories',
+            message: 'Filter inner pages by directory (comma-separated full URLs or /pathnames):',
+        });
+        return answer.directories;
+    }
+    catch {
+        // Why not `process.exit(0)` here (the Sheets reporter does that for
+        // enquirer Ctrl+C): this prompt runs under `report()`'s `await using`
+        // archive, and exiting the process would skip dispose. Throw so the
+        // archive closes; the CLI maps the error to exit code 0.
+        throw new HtmlReportCancelledError();
+    }
+}
+/**
+ * Resolves and validates the directory prefixes needed to keep a report bounded.
+ * @param options - Archive, initial non-interactive value, and warning sink.
+ * @returns Valid prefixes whose union contains at most 10,000 pages.
+ * @example
+ * const prefixes = await resolveDirectoryPrefixes({
+ *   accessor,
+ *   interactive: process.stdout.isTTY === true,
+ *   onWarn: console.warn,
+ * });
+ */
+export async function resolveDirectoryPrefixes(options) {
+    const unfilteredTotal = await countPageListRows(options.accessor);
+    const hostnameCount = await countPageListHostnames(options.accessor);
+    let input = options.initialInput;
+    if (unfilteredTotal <= PAGE_LIMIT && input == null) {
+        return [];
+    }
+    for (;;) {
+        if (input == null) {
+            if (!options.interactive) {
+                throw new Error(`HTML report has ${unfilteredTotal.toLocaleString()} inner pages; ` +
+                    'use --html-dirs with comma-separated directory prefixes to reduce it to 10,000 or fewer.');
+            }
+            options.onWarn(`HTML report has ${unfilteredTotal.toLocaleString()} inner pages; select directories containing 10,000 or fewer pages.`);
+            input = await promptForInput();
+        }
+        try {
+            const prefixes = parseDirectoryInput(input);
+            if (hostnameCount > 1 && prefixes.some((prefix) => prefix.origin === null)) {
+                throw new Error('This archive contains multiple hosts; every directory prefix must be a full URL.');
+            }
+            for (const prefix of prefixes) {
+                const count = await countPageListRows(options.accessor, {
+                    directories: [prefix.display],
+                });
+                if (count === 0) {
+                    throw new Error(`No inner page matches directory prefix: ${prefix.display}`);
+                }
+            }
+            const selectedTotal = await countPageListRows(options.accessor, {
+                directories: prefixes.map((prefix) => prefix.display),
+            });
+            if (selectedTotal > PAGE_LIMIT) {
+                throw new Error(`The selected directories contain ${selectedTotal.toLocaleString()} inner pages; narrow them to 10,000 or fewer.`);
+            }
+            return prefixes;
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            if (!options.interactive) {
+                throw new Error(`Invalid --html-dirs: ${message}`, { cause: error });
+            }
+            options.onWarn(`Warning: ${message}`);
+            input = await promptForInput();
+        }
+    }
+}

package/lib/resolve-output-path.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Resolves the HTML destination, defaulting to the archive basename in CWD.
+ * @param filePath - Source archive path.
+ * @param outputPath - Explicit destination, when supplied.
+ * @returns Absolute output path.
+ * @example
+ * resolveOutputPath('/tmp/site.nitpicker', undefined) // `${process.cwd()}/site.html`
+ */
+export declare function resolveOutputPath(filePath: string, outputPath?: string): string;

package/lib/resolve-output-path.js

@@ -0,0 +1,16 @@
+import path from 'node:path';
+/**
+ * Resolves the HTML destination, defaulting to the archive basename in CWD.
+ * @param filePath - Source archive path.
+ * @param outputPath - Explicit destination, when supplied.
+ * @returns Absolute output path.
+ * @example
+ * resolveOutputPath('/tmp/site.nitpicker', undefined) // `${process.cwd()}/site.html`
+ */
+export function resolveOutputPath(filePath, outputPath) {
+    if (outputPath) {
+        return path.resolve(process.cwd(), outputPath);
+    }
+    const parsed = path.parse(filePath);
+    return path.resolve(process.cwd(), `${parsed.name}.html`);
+}

package/lib/types.d.ts

@@ -0,0 +1,32 @@
+/** Parameters accepted by the static HTML reporter. */
+export interface HtmlReportParams {
+    /** Path to a completed `.nitpicker` archive. */
+    readonly filePath: string;
+    /** Destination path, or omitted for `<archive-name>.html` in the current directory. */
+    readonly outputPath?: string;
+    /** Comma-separated directory prefixes used for non-interactive large reports. */
+    readonly directoryInput?: string;
+    /** Whether the reporter may prompt for directory prefixes. */
+    readonly interactive?: boolean;
+    /** Suppresses completion and warning output. */
+    readonly silent?: boolean;
+    /** Receives archive extraction byte progress. */
+    readonly onExtractProgress?: (readBytes: number, totalBytes: number) => void;
+}
+/** Normalized directory prefix used to constrain inner-page rows. */
+export interface HtmlReportDirectoryPrefix {
+    /**
+     * Reconstructed `https://{hostname}` for a full-URL input (scheme and
+     * port dropped, matching `parsePageDirectoryPrefix`), or `null` for
+     * pathname-only input.
+     */
+    readonly origin: string | null;
+    /**
+     * Normalized absolute pathname without a trailing slash. The site root
+     * is `/` here so the CLI can show it; query matching treats `/` as no
+     * path restriction.
+     */
+    readonly pathname: string;
+    /** User-facing normalized representation passed to query directory filters. */
+    readonly display: string;
+}

package/lib/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,46 @@
+{
+	"name": "@nitpicker/report-html",
+	"version": "0.20.0",
+	"description": "Self-contained static HTML reports for Nitpicker archives",
+	"author": "D-ZERO",
+	"license": "Apache-2.0",
+	"engines": {
+		"node": ">=24.11.0"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/d-zero-dev/nitpicker.git",
+		"directory": "packages/@nitpicker/report-html"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"files": [
+		"lib"
+	],
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./lib/report-html.js",
+			"types": "./lib/report-html.d.ts"
+		}
+	},
+	"scripts": {
+		"build": "tsc",
+		"clean": "tsc --build --clean"
+	},
+	"dependencies": {
+		"@d-zero/dealer": "1.13.1",
+		"@nitpicker/crawler": "0.20.0",
+		"@nitpicker/query": "0.20.0",
+		"@nitpicker/viewer": "0.20.0",
+		"enquirer": "2.4.1",
+		"react": "19.2.8",
+		"react-dom": "19.2.8"
+	},
+	"devDependencies": {
+		"@d-zero/shared": "0.23.0",
+		"vitest": "4.1.11"
+	},
+	"gitHead": "c322c99bbaca356646d06130cb6eec2706c0ddc5"
+}