forgebook 0.0.0-stage → 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ensiria
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,137 @@
-# Temporary Holding Version
+# Forgebook
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+See every component in every theme, contrast, language and width. Write CSF stories, run `forgebook dev`: one frame
+per story, switches for theme, contrast, motion and language, and a props table from the components' types.
+
+> **Status:** 0.x, early. Its author's design system runs on it; the API may still change between minor versions,
+> and every change is in the
+> [changelog](https://github.com/ensiria/forgebook/blob/develop/packages/forgebook/CHANGELOG.md).
+
+**Requirements:** Node 22.18 or later · Vite 8 (the catalogue is built on it; other bundlers are not supported) · React 19 today, through
+[`@forgebook/react`](https://www.npmjs.com/package/@forgebook/react); other frameworks plug in through the same
+adapter (the catalogue's own interface is React either way) · npm, pnpm, yarn or bun ·
+[MIT licence](https://github.com/ensiria/forgebook/blob/develop/packages/forgebook/LICENSE)
+
+## Install
+
+In a project with React and Vite, both packages: `forgebook` is the catalogue, `@forgebook/react` the adapter it draws
+React components with.
+
+```sh
+npm install --save-dev forgebook @forgebook/react
+```
+
+## A first catalogue
+
+A component, with its props typed and documented:
+
+```tsx
+// src/Badge.tsx
+export type BadgeProps = {
+  /** The text. */
+  readonly label: string;
+  /** How it reads. @defaultValue "neutral" */
+  readonly tone?: "neutral" | "success" | "danger";
+};
+
+/** A small label beside a title. */
+export const Badge = ({ label, tone = "neutral" }: BadgeProps) => (
+  <span className={`badge badge--${tone}`}>{label}</span>
+);
+```
+
+Its stories, in [CSF 3](https://storybook.js.org/docs/api/csf):
+
+```tsx
+// src/Badge.stories.tsx
+import type { Meta, Story } from "@forgebook/react";
+
+import { Badge } from "./Badge";
+
+export default { title: "Components/Badge", component: Badge } satisfies Meta<typeof Badge>;
+
+/** The label as most pages use it. */
+export const Default: Story<typeof Badge> = { args: { label: "New" } };
+
+/** A success. */
+export const Success: Story<typeof Badge> = { args: { label: "Paid", tone: "success" } };
+```
+
+The catalogue's configuration, beside `package.json`:
+
+```ts
+// forgebook.config.ts
+import { react } from "@forgebook/react/vite";
+import { defineConfig } from "forgebook";
+
+export default defineConfig({
+  framework: react(),
+  title: "My components",
+  stories: ["src/**/*.stories.tsx"]
+});
+```
+
+Then:
+
+```sh
+npx forgebook dev      # the catalogue, live
+npx forgebook build    # static files in dist/, for any web server
+```
+
+Badge's page shows its stories, each in its own frame, and an API table read from `BadgeProps`: `label` required,
+`tone` with its three values and its default, each with its TSDoc.
+
+## What a catalogue gives you
+
+- **One frame per story**, so a story's styles and globals never leak into another, and its address opens it alone.
+- **Switches** in the toolbar for theme, contrast and motion, and the languages you declare; a library adds its own
+  (density, brand) through a preset.
+- **Widths** to draw a story at, and a **compare** view that draws the same story once per value of one or two
+  switches (every theme at both contrasts), per text size or per style sheet, side by side.
+- **Props from the types**: the API table and the panel's controls come from the component's TypeScript props and
+  their TSDoc, nothing written twice.
+- **Interaction states and motion**: `:hover`, `:active`, `:focus`, `:focus-visible` and `:focus-within` forced on a
+  story without a pointer; motion replayed on demand.
+- **Packages as sources**: a library ships its stories (`StorySource`), and an app's catalogue lists them beside its
+  own, each with its name, logo and texts.
+- **`CATALOG.md`** for coding agents: `forgebook-docs` writes one dense line per component, hook and helper of a
+  package, from its exports, their TSDoc and its stories.
+- **Tests from the stories**, with [`@forgebook/testing`](https://www.npmjs.com/package/@forgebook/testing): every
+  story in the browser with axe, spills and overlays, screenshots, and every story rendered on the server.
+
+It adds about a dozen packages to a React and Vite project.
+
+## Coming from Storybook
+
+Forgebook reads Storybook's story files as they are: CSF 3 and CSF 2 (`Template.bind({})`), titles of any depth and
+titles from the file's path, `args` and `argTypes` (with their controls), actions from `fn()` or an `argTypes` action,
+`play` with Testing Library (`@testing-library/dom` and `@testing-library/user-event`, optional peers), `loaders`,
+`tags` (`!dev`, `!test`) and a story's `globals`.
+
+It does not read MDX, doc blocks or addons. Actions are explicit only: an `on*` prop is not turned into an action by
+its name.
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `forgebook dev` / `forgebook build` | Runs the catalogue of `forgebook.config.ts`, or builds it into static files |
+| `forgebook-docs` | Writes a package's `CATALOG.md` from its exports, their TSDoc and its stories |
+| `forgebook-texts` | Checks a package's story texts and lists what each language still has to translate |
+
+Each command prints its options with `--help`.
+
+## Packages
+
+| Package | What it is |
+|---|---|
+| `forgebook` | The catalogue: the shell, the frame, the Vite plugin, the commands |
+| [`@forgebook/react`](https://www.npmjs.com/package/@forgebook/react) | React's story types, renderer and props reader |
+| [`@forgebook/story-format`](https://www.npmjs.com/package/@forgebook/story-format) | The story format, for a library whose stories must not depend on a catalogue |
+| [`@forgebook/testing`](https://www.npmjs.com/package/@forgebook/testing) | Tests generated from the stories |
+
+## Contributing
+
+Bugs, proposals and pull requests:
+[CONTRIBUTING.md](https://github.com/ensiria/forgebook/blob/develop/CONTRIBUTING.md). Security problems:
+[SECURITY.md](https://github.com/ensiria/forgebook/blob/develop/SECURITY.md).

package/dist/bin/forgebook/catalogueVite.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The Vite configuration the `forgebook` command runs a catalogue with: its folder as the root, Forgebook's plugin
+ * with the configuration already read, and the framework's own plugins.
+ *
+ * @module
+ */
+import type { InlineConfig } from "vite";
+import type { ResolvedConfig } from "../../src/vite/configFile.ts";
+/**
+ * Vite's configuration for a catalogue.
+ *
+ * @param config - the catalogue's configuration, read.
+ * @param overrides - what the command sets (the port, the output folder).
+ */
+export declare const catalogueVite: (config: ResolvedConfig, overrides: InlineConfig) => Promise<InlineConfig>;
+//# sourceMappingURL=catalogueVite.d.ts.map

package/dist/bin/forgebook/catalogueVite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalogueVite.d.ts","sourceRoot":"","sources":["../../../bin/forgebook/catalogueVite.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEzC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAGnE;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GACxB,QAAQ,cAAc,EACtB,WAAW,YAAY,KACtB,OAAO,CAAC,YAAY,CAMrB,CAAC"}

package/dist/bin/forgebook/catalogueVite.js

@@ -0,0 +1,15 @@
+import { forgebookPlugin } from "../../src/vite/forgebookPlugin.js";
+/**
+ * Vite's configuration for a catalogue.
+ *
+ * @param config - the catalogue's configuration, read.
+ * @param overrides - what the command sets (the port, the output folder).
+ */
+export const catalogueVite = async (config, overrides) => ({
+    ...overrides,
+    root: config.dir,
+    // the configuration file is Forgebook's: a vite.config beside it is not read
+    configFile: false,
+    plugins: [forgebookPlugin({ config }), ...((await config.framework.vitePlugins?.()) ?? [])]
+});
+//# sourceMappingURL=catalogueVite.js.map

package/dist/bin/forgebook/catalogueVite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalogueVite.js","sourceRoot":"","sources":["../../../bin/forgebook/catalogueVite.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAChC,MAAsB,EACtB,SAAuB,EACA,EAAE,CAAC,CAAC;IAC3B,GAAG,SAAS;IACZ,IAAI,EAAE,MAAM,CAAC,GAAG;IAChB,6EAA6E;IAC7E,UAAU,EAAE,KAAK;IACjB,OAAO,EAAE,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;CAC5F,CAAC,CAAC"}

package/dist/bin/forgebook/forgebook.d.mts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=forgebook.d.mts.map

package/dist/bin/forgebook/forgebook.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"forgebook.d.mts","sourceRoot":"","sources":["../../../bin/forgebook/forgebook.mts"],"names":[],"mappings":""}

package/dist/bin/forgebook/forgebook.mjs

@@ -0,0 +1,93 @@
+#!/usr/bin/env node
+/**
+ * The `forgebook` command: runs a catalogue from its `forgebook.config.ts` (`dev`, the dev server) or builds it into
+ * static files (`build`), with no page or Vite configuration of the app's own.
+ *
+ * @module
+ */
+import { resolve } from "node:path";
+import { defineScript, ScriptError } from "@ensiria/cli-kit/script";
+import { build, createServer } from "vite";
+import { CONFIG_FILES, findConfigFile, loadConfigFile } from "../../src/vite/configFile.js";
+import { catalogueVite } from "./catalogueVite.js";
+/** The command, as the hints print it. */
+const COMMAND = "forgebook";
+/**
+ * The catalogue's configuration: the file given, or the one in the folder the command runs in.
+ *
+ * @param file - the configuration file given; none to look in the current folder.
+ * @throws a `ScriptError` when there is none, or it cannot be used.
+ */
+const configOf = async (file) => {
+    const found = file === undefined ? findConfigFile(process.cwd()) : resolve(file);
+    if (found === undefined)
+        throw new ScriptError(`No ${CONFIG_FILES[0]} here`, {
+            hint: `Run ${COMMAND} in the catalogue's folder, or give --config`
+        });
+    try {
+        return await loadConfigFile(found);
+    }
+    catch (error) {
+        throw new ScriptError(error instanceof Error ? error.message : String(error));
+    }
+};
+await defineScript({
+    name: "forgebook",
+    command: COMMAND,
+    summary: "Run a catalogue of stories from its forgebook.config.ts, or build it into static files.",
+    icon: "docs",
+    options: {
+        config: {
+            type: "string",
+            valueName: "file",
+            description: "The configuration file; forgebook.config.ts in the current folder by default."
+        },
+        port: {
+            type: "string",
+            valueName: "number",
+            description: "dev: the port to listen on; Vite's by default."
+        },
+        host: {
+            type: "string",
+            valueName: "address",
+            description: "dev: the address to listen on; localhost by default."
+        },
+        out: { type: "string", valueName: "folder", description: "build: the folder to write; dist by default." },
+        force: {
+            type: "boolean",
+            description: "dev: pre-bundle the dependencies again, ignoring Vite's cache (as a first start does)."
+        }
+    },
+    positionals: [{ name: "command", description: "What to do.", required: true, choices: ["dev", "build"] }],
+    examples: [
+        { command: `${COMMAND} dev`, description: "Run the catalogue of the folder you are in." },
+        { command: `${COMMAND} dev --port 6006`, description: "On a given port." },
+        { command: `${COMMAND} build --out site`, description: "Build it into static files." }
+    ],
+    run: async ({ args, options, log, onInterrupt }) => {
+        const config = await configOf(options.config);
+        if (args.command === "build") {
+            await build(await catalogueVite(config, { build: { outDir: resolve(config.dir, options.out ?? "dist") } }));
+            log.success(`${config.title} built`);
+            return;
+        }
+        const port = options.port === undefined ? undefined : Number(options.port);
+        if (port !== undefined && !Number.isInteger(port))
+            throw new ScriptError(`--port ${options.port} is not a port`);
+        const server = await createServer(await catalogueVite(config, {
+            server: {
+                ...(port === undefined ? {} : { port, strictPort: true }),
+                ...(options.host === undefined ? {} : { host: options.host })
+            },
+            ...(options.force === true ? { optimizeDeps: { force: true } } : {})
+        }));
+        await server.listen();
+        server.printUrls();
+        await new Promise((done) => {
+            onInterrupt(() => {
+                void server.close().then(done);
+            });
+        });
+    }
+}).run();
+//# sourceMappingURL=forgebook.mjs.map

package/dist/bin/forgebook/forgebook.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"forgebook.mjs","sourceRoot":"","sources":["../../../bin/forgebook/forgebook.mts"],"names":[],"mappings":";AACA;;;;;GAKG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAE3C,OAAO,EACL,YAAY,EACZ,cAAc,EACd,cAAc,EAEf,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,0CAA0C;AAC1C,MAAM,OAAO,GAAG,WAAW,CAAC;AAE5B;;;;;GAKG;AACH,MAAM,QAAQ,GAAG,KAAK,EAAE,IAAwB,EAA2B,EAAE;IAC3E,MAAM,KAAK,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjF,IAAI,KAAK,KAAK,SAAS;QACrB,MAAM,IAAI,WAAW,CAAC,MAAM,YAAY,CAAC,CAAC,CAAC,OAAO,EAAE;YAClD,IAAI,EAAE,OAAO,OAAO,8CAA8C;SACnE,CAAC,CAAC;IACL,IAAI,CAAC;QACH,OAAO,MAAM,cAAc,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,WAAW,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAChF,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,YAAY,CAAC;IACjB,IAAI,EAAE,WAAW;IACjB,OAAO,EAAE,OAAO;IAChB,OAAO,EAAE,yFAAyF;IAClG,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE;QACP,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,MAAM;YACjB,WAAW,EAAE,+EAA+E;SAC7F;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,QAAQ;YACnB,WAAW,EAAE,gDAAgD;SAC9D;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,SAAS;YACpB,WAAW,EAAE,sDAAsD;SACpE;QACD,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,8CAA8C,EAAE;QACzG,KAAK,EAAE;YACL,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,wFAAwF;SACtG;KACF;IACD,WAAW,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;IACzG,QAAQ,EAAE;QACR,EAAE,OAAO,EAAE,GAAG,OAAO,MAAM,EAAE,WAAW,EAAE,6CAA6C,EAAE;QACzF,EAAE,OAAO,EAAE,GAAG,OAAO,kBAAkB,EAAE,WAAW,EAAE,kBAAkB,EAAE;QAC1E,EAAE,OAAO,EAAE,GAAG,OAAO,mBAAmB,EAAE,WAAW,EAAE,6BAA6B,EAAE;KACvF;IACD,GAAG,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,WAAW,EAAE,EAAiB,EAAE;QAChE,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,IAAI,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;YAC7B,MAAM,KAAK,CACT,MAAM,aAAa,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC,CAC/F,CAAC;YACF,GAAG,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,KAAK,QAAQ,CAAC,CAAC;YACrC,OAAO;QACT,CAAC;QACD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC3E,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC;YAC/C,MAAM,IAAI,WAAW,CAAC,UAAU,OAAO,CAAC,IAAI,gBAAgB,CAAC,CAAC;QAChE,MAAM,MAAM,GAAG,MAAM,YAAY,CAC/B,MAAM,aAAa,CAAC,MAAM,EAAE;YAC1B,MAAM,EAAE;gBACN,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;gBACzD,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;aAC9D;YACD,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACrE,CAAC,CACH,CAAC;QACF,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC;QACtB,MAAM,CAAC,SAAS,EAAE,CAAC;QACnB,MAAM,IAAI,OAAO,CAAO,CAAC,IAAI,EAAE,EAAE;YAC/B,WAAW,CAAC,GAAG,EAAE;gBACf,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAC,CAAC,GAAG,EAAE,CAAC"}

package/dist/bin/forgebook-docs/catalogueDocs.types.d.ts

@@ -0,0 +1,90 @@
+/**
+ * The types of `forgebook-docs`: what it reads from a package, and its `--json` report.
+ *
+ * @module
+ */
+import type { ComponentDocs } from "../../src/componentDocs.ts";
+/** One exported function, value or type of a module. */
+export type ExportDocs = {
+    /** The export's name. */
+    readonly name: string;
+    /** What it is. */
+    readonly kind: "function" | "value" | "type";
+    /** A function's parameter names (`?` when optional, `...` when rest). */
+    readonly parameters?: readonly string[];
+    /** The first paragraph of its TSDoc. */
+    readonly summary: string;
+};
+/** One exported module (a subpath that is not a component). */
+export type ModuleDocs = {
+    /** The subpath (`./utils/cn`). */
+    readonly subpath: string;
+    /** Its exports, in the module's order. */
+    readonly exports: readonly ExportDocs[];
+};
+/** One mixin or function of a public Sass module. */
+export type SassMemberDocs = {
+    /** A mixin or a function. */
+    readonly kind: "mixin" | "function";
+    /** Its name. */
+    readonly name: string;
+    /** Its parameter names, without defaults (`$placement`). */
+    readonly parameters: readonly string[];
+    /** The first line of its `///` comment. */
+    readonly summary: string;
+};
+/** One public Sass module. */
+export type SassModuleDocs = {
+    /** The subpath (`./scss/focus`). */
+    readonly subpath: string;
+    /** Its mixins and functions. */
+    readonly members: readonly SassMemberDocs[];
+};
+/** One published style sheet. */
+export type StyleSheetDocs = {
+    /** The subpath (`./tokens.css`). */
+    readonly subpath: string;
+    /** The first sentence of its leading comment. */
+    readonly summary: string;
+};
+/** One component with stories. */
+export type CatalogueComponent = {
+    /** Its stories' title (`Inputs/Selection/Select`). */
+    readonly title: string;
+    /** The subpath that exports it. */
+    readonly subpath: string;
+    /** Its docs. */
+    readonly docs: ComponentDocs;
+    /** Its stories' names. */
+    readonly stories: readonly string[];
+};
+/** Everything `CATALOG.md` lists. */
+export type CatalogueData = {
+    /** The package's name (`@acme/ui`). */
+    readonly packageName: string;
+    /** The components with stories, by title. */
+    readonly components: readonly CatalogueComponent[];
+    /** The other exported modules. */
+    readonly modules: readonly ModuleDocs[];
+    /** The public Sass modules. */
+    readonly sassModules: readonly SassModuleDocs[];
+    /** The published style sheets. */
+    readonly styleSheets: readonly StyleSheetDocs[];
+};
+/** The `--json` document. */
+export type CatalogueDocsReport = {
+    /** `written` / `up-to-date`, or `valid` with `--check`. */
+    readonly status: "written" | "up-to-date" | "valid";
+    /** The file, relative to the working directory. */
+    readonly file: string;
+    /** How many components, modules, Sass modules and style sheets it lists. */
+    readonly counts: {
+        readonly components: number;
+        readonly modules: number;
+        readonly sassModules: number;
+        readonly styleSheets: number;
+    };
+    /** Story files that could not be read, with why. */
+    readonly problems: readonly string[];
+};
+//# sourceMappingURL=catalogueDocs.types.d.ts.map

package/dist/bin/forgebook-docs/catalogueDocs.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalogueDocs.types.d.ts","sourceRoot":"","sources":["../../../bin/forgebook-docs/catalogueDocs.types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAEhE,wDAAwD;AACxD,MAAM,MAAM,UAAU,GAAG;IACvB,yBAAyB;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,kBAAkB;IAClB,QAAQ,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,GAAG,MAAM,CAAC;IAC7C,yEAAyE;IACzE,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACxC,wCAAwC;IACxC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,+DAA+D;AAC/D,MAAM,MAAM,UAAU,GAAG;IACvB,kCAAkC;IAClC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,0CAA0C;IAC1C,QAAQ,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,CAAC;CACzC,CAAC;AAEF,qDAAqD;AACrD,MAAM,MAAM,cAAc,GAAG;IAC3B,6BAA6B;IAC7B,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,UAAU,CAAC;IACpC,gBAAgB;IAChB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4DAA4D;IAC5D,QAAQ,CAAC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IACvC,2CAA2C;IAC3C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,8BAA8B;AAC9B,MAAM,MAAM,cAAc,GAAG;IAC3B,oCAAoC;IACpC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,gCAAgC;IAChC,QAAQ,CAAC,OAAO,EAAE,SAAS,cAAc,EAAE,CAAC;CAC7C,CAAC;AAEF,iCAAiC;AACjC,MAAM,MAAM,cAAc,GAAG;IAC3B,oCAAoC;IACpC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,kCAAkC;AAClC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,sDAAsD;IACtD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,mCAAmC;IACnC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,gBAAgB;IAChB,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,0BAA0B;IAC1B,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF,qCAAqC;AACrC,MAAM,MAAM,aAAa,GAAG;IAC1B,uCAAuC;IACvC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,6CAA6C;IAC7C,QAAQ,CAAC,UAAU,EAAE,SAAS,kBAAkB,EAAE,CAAC;IACnD,kCAAkC;IAClC,QAAQ,CAAC,OAAO,EAAE,SAAS,UAAU,EAAE,CAAC;IACxC,+BAA+B;IAC/B,QAAQ,CAAC,WAAW,EAAE,SAAS,cAAc,EAAE,CAAC;IAChD,kCAAkC;IAClC,QAAQ,CAAC,WAAW,EAAE,SAAS,cAAc,EAAE,CAAC;CACjD,CAAC;AAEF,6BAA6B;AAC7B,MAAM,MAAM,mBAAmB,GAAG;IAChC,2DAA2D;IAC3D,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,OAAO,CAAC;IACpD,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,EAAE;QACf,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;QAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;QAC7B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;KAC9B,CAAC;IACF,oDAAoD;IACpD,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC,CAAC"}

package/dist/bin/forgebook-docs/catalogueDocs.types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=catalogueDocs.types.js.map

package/dist/bin/forgebook-docs/catalogueDocs.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalogueDocs.types.js","sourceRoot":"","sources":["../../../bin/forgebook-docs/catalogueDocs.types.ts"],"names":[],"mappings":""}

package/dist/bin/forgebook-docs/catalogueMarkdown.d.ts

@@ -0,0 +1,9 @@
+import type { CatalogueData } from "./catalogueDocs.types.ts";
+/**
+ * The text of `CATALOG.md`.
+ *
+ * @param data - what the command read.
+ * @returns the Markdown, ending with a newline.
+ */
+export declare const catalogueMarkdown: (data: CatalogueData) => string;
+//# sourceMappingURL=catalogueMarkdown.d.ts.map

package/dist/bin/forgebook-docs/catalogueMarkdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalogueMarkdown.d.ts","sourceRoot":"","sources":["../../../bin/forgebook-docs/catalogueMarkdown.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAsB,aAAa,EAA0B,MAAM,0BAA0B,CAAC;AAkG1G;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,MAAM,aAAa,KAAG,MA6CvD,CAAC"}

package/dist/bin/forgebook-docs/catalogueMarkdown.js

@@ -0,0 +1,132 @@
+/** The props whose keys are the parts. */
+const PART_MAPS = ["classNames", "styles", "refs"];
+/** A prop in short. */
+const shortProp = (prop) => {
+    const required = prop.isRequired ? "!" : "";
+    switch (prop.kind) {
+        case "choice":
+            return `${prop.name}${required}=${(prop.choices ?? [])
+                .map((choice) => prop.defaultValue === JSON.stringify(choice) || prop.defaultValue === String(choice)
+                ? `${choice}*`
+                : String(choice))
+                .join("|")}`;
+        case "event":
+            return `${prop.name}(${(prop.signature?.parameters ?? []).map((parameter) => parameter.name).join(", ")})`;
+        case "toggle":
+            return `${prop.name}${required}`;
+        default:
+            return `${prop.name}${required}:${prop.type}`;
+    }
+};
+/** A sentence without its final full stop, so a line can go on after it. */
+const sentence = (text) => text.replace(/\.$/, "");
+/** The import of a subpath. */
+const importOf = (packageName, subpath) => `${packageName}${subpath.slice(1)}`;
+/** One component's line. */
+const componentLine = (packageName, component) => {
+    const { docs } = component;
+    const where = ` \`${importOf(packageName, component.subpath)}\``;
+    // the part maps are summed up by the parts at the end of the line
+    const props = docs.props
+        .filter((prop) => !PART_MAPS.includes(prop.name))
+        .map(shortProp)
+        .join(" ");
+    const parts = docs.parts.length === 0 ? "" : ` · parts: ${docs.parts.join(", ")}`;
+    return `- **${docs.name}**${where}: ${sentence(docs.description)}. ${props}${parts}`;
+};
+/** Letters and digits only, lower case: how a subpath and an export name are compared. */
+const comparable = (text) => text.toLowerCase().replace(/[^a-z0-9]/g, "");
+/**
+ * The module's main export: the one named after the subpath (`./theming/tokens-css` → `tokensCss`), then one whose
+ * name holds it (`./theming/contrast` → `analyseContrast`), otherwise the first function or value.
+ */
+const mainExport = (subpath, entries) => {
+    const name = comparable(subpath.split("/").at(-1) ?? "");
+    return (entries.find((entry) => comparable(entry.name) === name) ??
+        entries.find((entry) => comparable(entry.name).includes(name)) ??
+        entries[0]);
+};
+/** One module's line. */
+const moduleLine = (packageName, module) => {
+    const values = module.exports.filter((entry) => entry.kind !== "type");
+    const types = module.exports.filter((entry) => entry.kind === "type").map((entry) => entry.name);
+    const main = mainExport(module.subpath, values);
+    const head = main === undefined ? "" : ` ${shortExport(main)}: ${sentence(main.summary)}`;
+    const rest = [
+        ...values.filter((entry) => entry !== main).map(shortExport),
+        ...(types.length === 0 ? [] : [`types ${types.join(", ")}`])
+    ];
+    return `- \`${importOf(packageName, module.subpath)}\`${head}${rest.length === 0 ? "" : `. Also: ${rest.join(", ")}`}`;
+};
+/** One export in short: a function with its parameters, a value or a type by name. */
+const shortExport = (entry) => entry.kind === "function" ? `${entry.name}(${(entry.parameters ?? []).join(", ")})` : entry.name;
+/** A title's family, group (empty when it has none) and name. */
+const place = (title) => {
+    const segments = title.split("/");
+    return [segments[0] ?? "", segments.length === 3 ? (segments[1] ?? "") : "", segments.at(-1) ?? ""];
+};
+/**
+ * Compares components by where their titles place them: by family, the ones without a group first, then by group
+ * and name, so each family and group is one heading.
+ */
+const byPlace = (left, right) => {
+    const [leftFamily, leftGroup, leftName] = place(left.title);
+    const [rightFamily, rightGroup, rightName] = place(right.title);
+    return (leftFamily.localeCompare(rightFamily) ||
+        leftGroup.localeCompare(rightGroup) ||
+        leftName.localeCompare(rightName));
+};
+/**
+ * The text of `CATALOG.md`.
+ *
+ * @param data - what the command read.
+ * @returns the Markdown, ending with a newline.
+ */
+export const catalogueMarkdown = (data) => {
+    const lines = [
+        `# ${data.packageName}`,
+        "",
+        "<!-- GENERATED by forgebook-docs from the exports, their TSDoc and the stories: do not edit. -->",
+        "",
+        "Read before writing a component, hook or helper: what exists, how to import it, its props in short",
+        "(`a|b*`: values, `*` the default; `!` required; `onX(value)`: an event).",
+        ""
+    ];
+    lines.push("## Components", "");
+    if (data.components.length === 0)
+        lines.push("None yet.", "");
+    let heading = "";
+    for (const component of [...data.components].sort(byPlace)) {
+        const group = component.title.split("/").slice(0, -1).join(" › ");
+        if (group !== heading) {
+            lines.push(`### ${group}`);
+            heading = group;
+        }
+        lines.push(componentLine(data.packageName, component));
+    }
+    if (data.components.length > 0)
+        lines.push("");
+    if (data.modules.length > 0) {
+        lines.push("## Modules", "");
+        const modules = [...data.modules].sort((left, right) => left.subpath.localeCompare(right.subpath));
+        for (const module of modules)
+            lines.push(moduleLine(data.packageName, module));
+        lines.push("");
+    }
+    if (data.sassModules.length > 0) {
+        lines.push("## Sass modules", "", `\`@use "pkg:${data.packageName}/scss/<name>"\`.`, "");
+        for (const module of data.sassModules) {
+            const members = module.members.map((member) => `${member.name}(${member.parameters.join(", ")}): ${sentence(member.summary)}`);
+            lines.push(`- \`${module.subpath.slice("./scss/".length)}\`: ${members.join("; ")}`);
+        }
+        lines.push("");
+    }
+    if (data.styleSheets.length > 0) {
+        lines.push("## Style sheets", "");
+        for (const sheet of data.styleSheets)
+            lines.push(`- \`${importOf(data.packageName, sheet.subpath)}\`: ${sheet.summary}`);
+        lines.push("");
+    }
+    return `${lines.join("\n").trimEnd()}\n`;
+};
+//# sourceMappingURL=catalogueMarkdown.js.map

package/dist/bin/forgebook-docs/catalogueMarkdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalogueMarkdown.js","sourceRoot":"","sources":["../../../bin/forgebook-docs/catalogueMarkdown.ts"],"names":[],"mappings":"AAcA,0CAA0C;AAC1C,MAAM,SAAS,GAAG,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AAEnD,uBAAuB;AACvB,MAAM,SAAS,GAAG,CAAC,IAAc,EAAU,EAAE;IAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ;YACX,OAAO,GAAG,IAAI,CAAC,IAAI,GAAG,QAAQ,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;iBACnD,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CACd,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,YAAY,KAAK,MAAM,CAAC,MAAM,CAAC;gBAClF,CAAC,CAAC,GAAG,MAAM,GAAG;gBACd,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CACnB;iBACA,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACjB,KAAK,OAAO;YACV,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;QAC7G,KAAK,QAAQ;YACX,OAAO,GAAG,IAAI,CAAC,IAAI,GAAG,QAAQ,EAAE,CAAC;QACnC;YACE,OAAO,GAAG,IAAI,CAAC,IAAI,GAAG,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;IAClD,CAAC;AACH,CAAC,CAAC;AAEF,4EAA4E;AAC5E,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAEnE,+BAA+B;AAC/B,MAAM,QAAQ,GAAG,CAAC,WAAmB,EAAE,OAAe,EAAU,EAAE,CAAC,GAAG,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAEvG,4BAA4B;AAC5B,MAAM,aAAa,GAAG,CAAC,WAAmB,EAAE,SAA6B,EAAU,EAAE;IACnF,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;IAC3B,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC;IACjE,kEAAkE;IAClE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK;SACrB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAChD,GAAG,CAAC,SAAS,CAAC;SACd,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;IAClF,OAAO,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,KAAK,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,KAAK,GAAG,KAAK,EAAE,CAAC;AACvF,CAAC,CAAC;AAEF,0FAA0F;AAC1F,MAAM,UAAU,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;AAE1F;;;GAGG;AACH,MAAM,UAAU,GAAG,CAAC,OAAe,EAAE,OAA8B,EAA0B,EAAE;IAC7F,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACzD,OAAO,CACL,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;QACxD,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC9D,OAAO,CAAC,CAAC,CAAC,CACX,CAAC;AACJ,CAAC,CAAC;AAEF,yBAAyB;AACzB,MAAM,UAAU,GAAG,CAAC,WAAmB,EAAE,MAAkB,EAAU,EAAE;IACrE,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC;IACvE,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACjG,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAChD,MAAM,IAAI,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;IAC1F,MAAM,IAAI,GAAG;QACX,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC;QAC5D,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;KAC7D,CAAC;IACF,OAAO,OAAO,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;AACzH,CAAC,CAAC;AAEF,sFAAsF;AACtF,MAAM,WAAW,GAAG,CAAC,KAAiB,EAAU,EAAE,CAChD,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;AAEnG,iEAAiE;AACjE,MAAM,KAAK,GAAG,CAAC,KAAa,EAAqC,EAAE;IACjE,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAClC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AACtG,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,GAAG,CAAC,IAAgC,EAAE,KAAiC,EAAU,EAAE;IAC9F,MAAM,CAAC,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5D,MAAM,CAAC,WAAW,EAAE,UAAU,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAChE,OAAO,CACL,UAAU,CAAC,aAAa,CAAC,WAAW,CAAC;QACrC,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC;QACnC,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,CAClC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,IAAmB,EAAU,EAAE;IAC/D,MAAM,KAAK,GAAG;QACZ,KAAK,IAAI,CAAC,WAAW,EAAE;QACvB,EAAE;QACF,kGAAkG;QAClG,EAAE;QACF,oGAAoG;QACpG,0EAA0E;QAC1E,EAAE;KACH,CAAC;IACF,KAAK,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;IAChC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IAC9D,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,KAAK,MAAM,SAAS,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3D,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClE,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;YACtB,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,EAAE,CAAC,CAAC;YAC3B,OAAO,GAAG,KAAK,CAAC;QAClB,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;IACzD,CAAC;IACD,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC/C,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QAC7B,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACnG,KAAK,MAAM,MAAM,IAAI,OAAO;YAAE,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC;QAC/E,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,EAAE,eAAe,IAAI,CAAC,WAAW,kBAAkB,EAAE,EAAE,CAAC,CAAC;QACzF,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACtC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAChC,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAC3F,CAAC;YACF,KAAK,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;QAClC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,WAAW;YAClC,KAAK,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACrF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC;AAC3C,CAAC,CAAC"}

package/dist/bin/forgebook-docs/collectDocs.d.ts

@@ -0,0 +1,17 @@
+import type { ExtractStoryComponent } from "../../src/vite/adapter.ts";
+import type { CatalogueData } from "./catalogueDocs.types.ts";
+/** What was read, and what could not be. */
+export type CollectedDocs = {
+    /** The catalogue's data. */
+    readonly data: CatalogueData;
+    /** One message per file that could not be read. */
+    readonly problems: readonly string[];
+};
+/**
+ * Reads a package for its catalogue.
+ *
+ * @param packageDir - the package's folder.
+ * @param extractStoryComponent - the framework's reading of a story file's component (its docs module).
+ */
+export declare const collectDocs: (packageDir: string, extractStoryComponent: ExtractStoryComponent) => CollectedDocs;
+//# sourceMappingURL=collectDocs.d.ts.map

package/dist/bin/forgebook-docs/collectDocs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collectDocs.d.ts","sourceRoot":"","sources":["../../../bin/forgebook-docs/collectDocs.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAGvE,OAAO,KAAK,EAEV,aAAa,EAId,MAAM,0BAA0B,CAAC;AAIlC,4CAA4C;AAC5C,MAAM,MAAM,aAAa,GAAG;IAC1B,4BAA4B;IAC5B,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,mDAAmD;IACnD,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC,CAAC;AA+EF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GACtB,YAAY,MAAM,EAClB,uBAAuB,qBAAqB,KAC3C,aA8BF,CAAC"}