feat(web): add all.html generation

Author: avivkeller

package-lock.json

@@ -16,6 +16,7 @@ import metadata from './metadata/index.mjs';
 import oramaDb from './orama-db/index.mjs';
 import sitemap from './sitemap/index.mjs';
 import web from './web/index.mjs';
+import webAll from './web-all/index.mjs';
 
 export const publicGenerators = {
   'json-simple': jsonSimple,
@@ -30,6 +31,7 @@ export const publicGenerators = {
   'llms-txt': llmsTxt,
   sitemap,
   web,
+  'web-all': webAll,
 };
 
 // These ones are special since they don't produce standard output,

src/generators/index.mjs

@@ -0,0 +1,14 @@
+## `web-all` Generator
+
+The `web-all` generator creates a single `all.html` file containing all API documentation modules rendered through the `web` generator pipeline. This is the modern equivalent of `legacy-html-all` for the new web tooling.
+
+It is intended for offline browsing and for environments where JavaScript is unavailable: the in-page searchbar shipped with `web` requires JS, so a single all-in-one page makes browser-native text search (`Ctrl`+`F`) usable across the full documentation set.
+
+### Configuring
+
+The `web-all` generator accepts the following configuration options:
+
+| Name           | Type     | Default              | Description                                    |
+| -------------- | -------- | -------------------- | ---------------------------------------------- |
+| `output`       | `string` | -                    | The directory where `all.html` will be written |
+| `templatePath` | `string` | Inherited from `web` | Path to the HTML template file                 |

src/generators/web-all/README.md

@@ -0,0 +1,62 @@
+'use strict';
+
+import { readFile } from 'node:fs/promises';
+import { join } from 'node:path';
+
+import getConfig from '../../utils/configuration/index.mjs';
+import { writeFile } from '../../utils/file.mjs';
+import buildContent from '../jsx-ast/utils/buildContent.mjs';
+import { processJSXEntries } from '../web/utils/processing.mjs';
+
+/**
+ * Generates a single `all.html` file containing every API documentation
+ * module rendered through the `web` generator pipeline.
+ *
+ * @type {import('./types').Generator['generate']}
+ */
+export async function generate(input) {
+  const config = getConfig('web-all');
+
+  const template = await readFile(config.templatePath, 'utf-8');
+
+  // Match `legacy-html-all`: skip the synthetic `index` entries.
+  const entries = input.filter(entry => entry.api !== 'index');
+
+  // Build a single combined JSXContent that wraps every entry's content in
+  // one Layout component, mirroring how `jsx-ast` produces per-module pages.
+  const combined = await buildContent(entries, {
+    api: 'all',
+    path: '/all',
+    basename: 'all.html',
+    heading: {
+      type: 'heading',
+      depth: 1,
+      children: [{ type: 'text', value: 'All' }],
+      data: { name: 'All', text: 'All', slug: 'all' },
+    },
+  });
+
+  // Pass the original metadata entries as the sidebar source so `all.html`
+  // exposes the same navigation as the per-module pages produced by `web`.
+  const sidebarEntries = entries.map(entry => ({ data: entry }));
+
+  const { results, css, chunks } = await processJSXEntries(
+    [combined],
+    template,
+    sidebarEntries
+  );
+
+  if (config.output) {
+    for (const { html, path } of results) {
+      await writeFile(join(config.output, `${path}.html`), html, 'utf-8');
+    }
+
+    for (const chunk of chunks) {
+      await writeFile(join(config.output, chunk.fileName), chunk.code, 'utf-8');
+    }
+
+    await writeFile(join(config.output, 'styles.css'), css, 'utf-8');
+  }
+
+  return { html: results[0].html.toString(), css };
+}

src/generators/web-all/generate.mjs

@@ -0,0 +1,29 @@
+'use strict';
+
+import { createLazyGenerator } from '../../utils/generators.mjs';
+import web from '../web/index.mjs';
+
+/**
+ * Web "all" generator - produces a single `all.html` page that contains every
+ * API documentation module rendered into one combined web bundle.
+ *
+ * Mirrors the role of `legacy-html-all` for the new `web` generator. Useful
+ * for offline browsing and for reading the full documentation in environments
+ * where JavaScript is unavailable, since the `web` searchbar requires JS.
+ *
+ * @type {import('./types').Generator}
+ */
+export default createLazyGenerator({
+  name: 'web-all',
+
+  version: '1.0.0',
+
+  description:
+    'Generates the `all.html` file from the `web` generator, which includes all the modules in one single file',
+
+  dependsOn: 'metadata',
+
+  defaultConfiguration: {
+    templatePath: web.defaultConfiguration.templatePath,
+  },
+});

src/generators/web-all/index.mjs

@@ -0,0 +1,10 @@
+import type { MetadataEntry } from '../metadata/types';
+
+export type Configuration = {
+  templatePath: string;
+};
+
+export type Generator = GeneratorMetadata<
+  Configuration,
+  Generate<Array<MetadataEntry>, Promise<{ html: string; css: string }>>
+>;

src/generators/web-all/types.d.ts

@@ -96,13 +96,18 @@ async function executeServerCode(serverCodeMap, requireFn, virtualImports) {
  *
  * @param {Array<import('../../jsx-ast/utils/buildContent.mjs').JSXContent>} entries - The JSX AST entries to process.
  * @param {string} template - The HTML template string for the output pages.
+ * @param {Array<{ data: import('../../metadata/types').MetadataEntry }>} [sidebarEntries] - Entries used to build the sidebar page list. Defaults to `entries`. Pass the full set when rendering a subset (e.g. the `all` page) so the sidebar still links to every module.
  */
-export async function processJSXEntries(entries, template) {
+export async function processJSXEntries(
+  entries,
+  template,
+  sidebarEntries = entries
+) {
   const config = getConfig('web');
   const astBuilders = createASTBuilder();
   const requireFn = createRequire(import.meta.url);
   const virtualImports = {
-    '#theme/config': createConfigSource(entries),
+    '#theme/config': createConfigSource(sidebarEntries),
     ...config.virtualImports,
   };
   // Step 1: Convert JSX AST to JavaScript