forgebook 0.1.3 → 0.1.4

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

@@ -0,0 +1,76 @@
+/**
+ * How a package sets its `CATALOG.md`: the `forgebook.catalog` key of its `package.json`, checked. A library has no
+ * catalogue configuration of its own, and the key travels with the package.
+ *
+ * @module
+ */
+/** The kinds of entries the file lists, in the order they are written by default. */
+export const CATALOGUE_SECTIONS = ["components", "modules", "sassModules", "styleSheets"];
+/** The options of a package that sets none. */
+export const DEFAULT_CATALOGUE_OPTIONS = {
+    file: "CATALOG.md",
+    sections: CATALOGUE_SECTIONS,
+    exclude: []
+};
+/** Whether a value is a plain object. */
+const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+/** Whether a value is a list of strings. */
+const isStringList = (value) => Array.isArray(value) && value.every((item) => typeof item === "string");
+/** Whether a text names a kind of entries. */
+const isSection = (value) => CATALOGUE_SECTIONS.some((section) => section === value);
+/** The file's name, or the default with a problem when it is set wrongly. */
+const fileOf = (value, problems) => {
+    if (value === undefined)
+        return DEFAULT_CATALOGUE_OPTIONS.file;
+    if (typeof value === "string" && value !== "" && !value.includes("/"))
+        return value;
+    problems.push("forgebook.catalog.file must be a file name in the package's folder");
+    return DEFAULT_CATALOGUE_OPTIONS.file;
+};
+/** The sections, or the default with a problem when they are set wrongly. */
+const sectionsOf = (value, problems) => {
+    if (value === undefined)
+        return DEFAULT_CATALOGUE_OPTIONS.sections;
+    if (isStringList(value) && value.every(isSection))
+        return value.filter(isSection);
+    problems.push(`forgebook.catalog.sections must list some of: ${CATALOGUE_SECTIONS.join(", ")}`);
+    return DEFAULT_CATALOGUE_OPTIONS.sections;
+};
+/** The exclusions, or none with a problem when they are set wrongly. */
+const excludeOf = (value, problems) => {
+    if (value === undefined)
+        return [];
+    if (isStringList(value))
+        return value;
+    problems.push("forgebook.catalog.exclude must list export subpaths");
+    return [];
+};
+/**
+ * A package's catalogue options, from its manifest, with what is wrong in them.
+ *
+ * @param manifest - the package's `package.json`, parsed.
+ * @returns the options (the defaults where it sets none or sets them wrongly) and one message per mistake.
+ */
+export const catalogueOptionsOf = (manifest) => {
+    const forgebook = isRecord(manifest) ? manifest["forgebook"] : undefined;
+    const catalog = isRecord(forgebook) ? forgebook["catalog"] : undefined;
+    if (catalog === undefined)
+        return { options: DEFAULT_CATALOGUE_OPTIONS, problems: [] };
+    if (!isRecord(catalog))
+        return { options: DEFAULT_CATALOGUE_OPTIONS, problems: ["forgebook.catalog is not an object"] };
+    const problems = [];
+    const options = {
+        file: fileOf(catalog["file"], problems),
+        sections: sectionsOf(catalog["sections"], problems),
+        exclude: excludeOf(catalog["exclude"], problems)
+    };
+    return { options, problems };
+};
+/**
+ * Whether an export subpath is left out by the options.
+ *
+ * @param subpath - the subpath (`./internal/tokens`).
+ * @param exclude - the options' `exclude`.
+ */
+export const isExcluded = (subpath, exclude) => exclude.some((pattern) => pattern.endsWith("*") ? subpath.startsWith(pattern.slice(0, -1)) : subpath === pattern);
+//# sourceMappingURL=catalogueOptions.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"catalogueOptions.js","sourceRoot":"","sources":["../../../bin/forgebook-docs/catalogueOptions.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,qFAAqF;AACrF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,aAAa,CAAU,CAAC;AAenG,+CAA+C;AAC/C,MAAM,CAAC,MAAM,yBAAyB,GAAqB;IACzD,IAAI,EAAE,YAAY;IAClB,QAAQ,EAAE,kBAAkB;IAC5B,OAAO,EAAE,EAAE;CACZ,CAAC;AAEF,yCAAyC;AACzC,MAAM,QAAQ,GAAG,CAAC,KAAc,EAA8C,EAAE,CAC9E,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAEvE,4CAA4C;AAC5C,MAAM,YAAY,GAAG,CAAC,KAAc,EAA8B,EAAE,CAClE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC;AAE1E,8CAA8C;AAC9C,MAAM,SAAS,GAAG,CAAC,KAAa,EAA6B,EAAE,CAC7D,kBAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC;AAE1D,6EAA6E;AAC7E,MAAM,MAAM,GAAG,CAAC,KAAc,EAAE,QAAkB,EAAU,EAAE;IAC5D,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,yBAAyB,CAAC,IAAI,CAAC;IAC/D,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IACpF,QAAQ,CAAC,IAAI,CAAC,oEAAoE,CAAC,CAAC;IACpF,OAAO,yBAAyB,CAAC,IAAI,CAAC;AACxC,CAAC,CAAC;AAEF,6EAA6E;AAC7E,MAAM,UAAU,GAAG,CAAC,KAAc,EAAE,QAAkB,EAA+B,EAAE;IACrF,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,yBAAyB,CAAC,QAAQ,CAAC;IACnE,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC;QAAE,OAAO,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAClF,QAAQ,CAAC,IAAI,CAAC,iDAAiD,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChG,OAAO,yBAAyB,CAAC,QAAQ,CAAC;AAC5C,CAAC,CAAC;AAEF,wEAAwE;AACxE,MAAM,SAAS,GAAG,CAAC,KAAc,EAAE,QAAkB,EAAqB,EAAE;IAC1E,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IACnC,IAAI,YAAY,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACtC,QAAQ,CAAC,IAAI,CAAC,qDAAqD,CAAC,CAAC;IACrE,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,QAAiB,EAC6D,EAAE;IAChF,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACzE,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvE,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IACvF,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QACpB,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,QAAQ,EAAE,CAAC,oCAAoC,CAAC,EAAE,CAAC;IAClG,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,OAAO,GAAqB;QAChC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC;QACvC,QAAQ,EAAE,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC;QACnD,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC;KACjD,CAAC;IACF,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;AAC/B,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,OAAe,EAAE,OAA0B,EAAW,EAAE,CACjF,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CACvB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CACvF,CAAC"}

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

@@ -1,5 +1,6 @@
 import type { ExtractStoryComponent } from "../../src/vite/adapter.ts";
 import type { CatalogueData } from "./catalogueDocs.types.ts";
+import { type CatalogueOptions } from "./catalogueOptions.ts";
 /** What was read, and what could not be. */
 export type CollectedDocs = {
     /** The catalogue's data. */
@@ -12,6 +13,7 @@ export type CollectedDocs = {
  *
  * @param packageDir - the package's folder.
  * @param extractStoryComponent - the framework's reading of a story file's component (its docs module).
+ * @param options - the package's catalogue options: the subpaths it leaves out.
  */
-export declare const collectDocs: (packageDir: string, extractStoryComponent: ExtractStoryComponent) => CollectedDocs;
+export declare const collectDocs: (packageDir: string, extractStoryComponent: ExtractStoryComponent, options: Pick<CatalogueOptions, "exclude">) => CollectedDocs;
 //# sourceMappingURL=collectDocs.d.ts.map

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

@@ -1 +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"}
+{"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;AAClC,OAAO,EAAE,KAAK,gBAAgB,EAAc,MAAM,uBAAuB,CAAC;AAK1E,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;AAoGF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GACtB,YAAY,MAAM,EAClB,uBAAuB,qBAAqB,EAC5C,SAAS,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,KACzC,aA+BF,CAAC"}

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

@@ -13,8 +13,10 @@ import { globSync, readFileSync } from "node:fs";
 import { join, resolve } from "node:path";
 import { autoTitle, STORY_FILE } from "../../src/vite/autoTitle.js";
 import { indexStoryFile } from "../../src/vite/indexStoryFile.js";
+import { isExcluded } from "./catalogueOptions.js";
 import { moduleDocs } from "./moduleDocs.js";
 import { sassMembers, styleSheetSummary } from "./sassDocs.js";
+import { sourceIdOf } from "./sourceId.js";
 /** The subpath that is never published: the package's stories for a catalogue. */
 const STORIES_SUBPATH = "./stories";
 /** A package's `exports`, as written: subpath → source. */
@@ -27,7 +29,7 @@ const sourceExports = (manifest) => {
     return Object.fromEntries(Object.entries(exports).filter((entry) => typeof entry[1] === "string"));
 };
 /** The components of the package's story files, read by the framework's extractor. */
-const collectComponents = (packageDir, exports, problems, extractStoryComponent) => {
+const collectComponents = (packageDir, exports, problems, extractStoryComponent, exclude) => {
     const components = [];
     const componentFiles = new Set();
     const storyFiles = globSync("**/*.stories.*", { cwd: packageDir })
@@ -49,14 +51,15 @@ const collectComponents = (packageDir, exports, problems, extractStoryComponent)
             continue;
         const subpath = Object.entries(exports).find(([, source]) => resolve(packageDir, source) === component.file)?.[0];
         // a component no subpath exports is a story's own (a foundations page), not part of the package
-        if (subpath === undefined)
+        if (subpath === undefined || isExcluded(subpath, exclude))
             continue;
         componentFiles.add(component.file);
         components.push({
             title: index.title,
             subpath,
             docs: component.docs,
-            stories: index.stories.map((story) => story.name ?? story.exportName)
+            stories: index.stories.map((story) => story.name ?? story.exportName),
+            mainStory: (index.stories.find((story) => story.isMain === true) ?? index.stories[0])?.exportName
         });
     }
     return { components, componentFiles };
@@ -76,29 +79,45 @@ const readExport = (subpath, source, file) => {
         ? { kind: "problem", message: docs }
         : { kind: "module", docs: { subpath, exports: docs } };
 };
+/** A text field of the package's manifest (`name`, `description`), or none. */
+const manifestText = (manifest, key) => {
+    if (typeof manifest !== "object" || manifest === null || !(key in manifest))
+        return undefined;
+    const value = Reflect.get(manifest, key);
+    return typeof value === "string" ? value : undefined;
+};
+/** The id the package's stories carry, from its `./stories` export's module, when it writes it plainly. */
+const sourceIdIn = (packageDir, exports) => {
+    const source = exports[STORIES_SUBPATH];
+    if (source === undefined)
+        return undefined;
+    const file = resolve(packageDir, source);
+    try {
+        return sourceIdOf(file, readFileSync(file, "utf8"));
+    }
+    catch {
+        return undefined;
+    }
+};
 /**
  * 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).
+ * @param options - the package's catalogue options: the subpaths it leaves out.
  */
-export const collectDocs = (packageDir, extractStoryComponent) => {
+export const collectDocs = (packageDir, extractStoryComponent, options) => {
     const manifest = JSON.parse(readFileSync(join(packageDir, "package.json"), "utf8"));
-    const packageName = typeof manifest === "object" &&
-        manifest !== null &&
-        "name" in manifest &&
-        typeof manifest.name === "string"
-        ? manifest.name
-        : packageDir;
+    const packageName = manifestText(manifest, "name") ?? packageDir;
     const exports = sourceExports(manifest);
     const problems = [];
-    const { components, componentFiles } = collectComponents(packageDir, exports, problems, extractStoryComponent);
+    const { components, componentFiles } = collectComponents(packageDir, exports, problems, extractStoryComponent, options.exclude);
     const modules = [];
     const sassModules = [];
     const styleSheets = [];
     for (const [subpath, source] of Object.entries(exports)) {
         const file = resolve(packageDir, source);
-        if (subpath === STORIES_SUBPATH || componentFiles.has(file))
+        if (subpath === STORIES_SUBPATH || componentFiles.has(file) || isExcluded(subpath, options.exclude))
             continue;
         const entry = readExport(subpath, source, file);
         if (entry.kind === "sass")
@@ -110,6 +129,11 @@ export const collectDocs = (packageDir, extractStoryComponent) => {
         if (entry.kind === "problem")
             problems.push(entry.message);
     }
-    return { data: { packageName, components, modules, sassModules, styleSheets }, problems };
+    const description = manifestText(manifest, "description");
+    const sourceId = sourceIdIn(packageDir, exports);
+    return {
+        data: { packageName, description, sourceId, components, modules, sassModules, styleSheets },
+        problems
+    };
 };
 //# sourceMappingURL=collectDocs.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"collectDocs.js","sourceRoot":"","sources":["../../../bin/forgebook-docs/collectDocs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAK1C,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAQlE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAU/D,kFAAkF;AAClF,MAAM,eAAe,GAAG,WAAW,CAAC;AAEpC,2DAA2D;AAC3D,MAAM,aAAa,GAAG,CAAC,QAAiB,EAAoC,EAAE;IAC5E,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,IAAI,CAAC,CAAC,SAAS,IAAI,QAAQ,CAAC;QAAE,OAAO,EAAE,CAAC;IAC7F,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;IACjC,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,EAAE,CAAC;IAC/D,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAA6B,EAAE,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CACnG,CAAC;AACJ,CAAC,CAAC;AAEF,sFAAsF;AACtF,MAAM,iBAAiB,GAAG,CACxB,UAAkB,EAClB,OAAyC,EACzC,QAAkB,EAClB,qBAA4C,EACuB,EAAE;IACrE,MAAM,UAAU,GAAyB,EAAE,CAAC;IAC5C,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;IACzC,MAAM,UAAU,GAAG,QAAQ,CAAC,gBAAgB,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC;SAC/D,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACvC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,cAAc,IAAI,OAAO,KAAK,MAAM,CAAC,CAAC;SACtG,IAAI,EAAE,CAAC;IACV,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACxC,iHAAiH;QACjH,MAAM,KAAK,GAAG,SAAS,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;QACtC,MAAM,OAAO,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;QAChE,MAAM,KAAK,GAA4B,cAAc,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;QACjG,MAAM,SAAS,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC/D,QAAQ,CAAC,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,KAAK,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YACvF,SAAS;QACX,CAAC;QACD,IAAI,CAAC,CAAC,MAAM,IAAI,SAAS,CAAC;YAAE,SAAS;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAC1C,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,KAAK,SAAS,CAAC,IAAI,CAC/D,EAAE,CAAC,CAAC,CAAC,CAAC;QACP,gGAAgG;QAChG,IAAI,OAAO,KAAK,SAAS;YAAE,SAAS;QACpC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACnC,UAAU,CAAC,IAAI,CAAC;YACd,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,OAAO;YACP,IAAI,EAAE,SAAS,CAAC,IAAI;YACpB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,UAAU,CAAC;SACtE,CAAC,CAAC;IACL,CAAC;IACD,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC;AACxC,CAAC,CAAC;AAUF,kEAAkE;AAClE,MAAM,UAAU,GAAG,CAAC,OAAe,EAAE,MAAc,EAAE,IAAY,EAAc,EAAE;IAC/E,IAAI,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;QACrC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC;IAC/F,CAAC;IACD,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7B,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAiB,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC;IACtG,CAAC;IACD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IACtD,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9B,OAAO,OAAO,IAAI,KAAK,QAAQ;QAC7B,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE;QACpC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC;AAC3D,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,UAAkB,EAClB,qBAA4C,EAC7B,EAAE;IACjB,MAAM,QAAQ,GAAY,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAC7F,MAAM,WAAW,GACf,OAAO,QAAQ,KAAK,QAAQ;QAC5B,QAAQ,KAAK,IAAI;QACjB,MAAM,IAAI,QAAQ;QAClB,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ;QAC/B,CAAC,CAAC,QAAQ,CAAC,IAAI;QACf,CAAC,CAAC,UAAU,CAAC;IACjB,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IACxC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,iBAAiB,CACtD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,qBAAqB,CACtB,CAAC;IACF,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,MAAM,WAAW,GAAqB,EAAE,CAAC;IACzC,MAAM,WAAW,GAAqB,EAAE,CAAC;IACzC,KAAK,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACxD,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,eAAe,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,SAAS;QACtE,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAChD,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM;YAAE,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO;YAAE,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACzD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;YAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,EAAE,QAAQ,EAAE,CAAC;AAC5F,CAAC,CAAC"}
+{"version":3,"file":"collectDocs.js","sourceRoot":"","sources":["../../../bin/forgebook-docs/collectDocs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAK1C,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAQlE,OAAO,EAAyB,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAU3C,kFAAkF;AAClF,MAAM,eAAe,GAAG,WAAW,CAAC;AAEpC,2DAA2D;AAC3D,MAAM,aAAa,GAAG,CAAC,QAAiB,EAAoC,EAAE;IAC5E,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,IAAI,CAAC,CAAC,SAAS,IAAI,QAAQ,CAAC;QAAE,OAAO,EAAE,CAAC;IAC7F,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;IACjC,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,EAAE,CAAC;IAC/D,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAA6B,EAAE,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CACnG,CAAC;AACJ,CAAC,CAAC;AAEF,sFAAsF;AACtF,MAAM,iBAAiB,GAAG,CACxB,UAAkB,EAClB,OAAyC,EACzC,QAAkB,EAClB,qBAA4C,EAC5C,OAA0B,EACyC,EAAE;IACrE,MAAM,UAAU,GAAyB,EAAE,CAAC;IAC5C,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;IACzC,MAAM,UAAU,GAAG,QAAQ,CAAC,gBAAgB,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC;SAC/D,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACvC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,cAAc,IAAI,OAAO,KAAK,MAAM,CAAC,CAAC;SACtG,IAAI,EAAE,CAAC;IACV,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACxC,iHAAiH;QACjH,MAAM,KAAK,GAAG,SAAS,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;QACtC,MAAM,OAAO,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;QAChE,MAAM,KAAK,GAA4B,cAAc,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;QACjG,MAAM,SAAS,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC/D,QAAQ,CAAC,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,KAAK,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YACvF,SAAS;QACX,CAAC;QACD,IAAI,CAAC,CAAC,MAAM,IAAI,SAAS,CAAC;YAAE,SAAS;QACrC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAC1C,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,KAAK,SAAS,CAAC,IAAI,CAC/D,EAAE,CAAC,CAAC,CAAC,CAAC;QACP,gGAAgG;QAChG,IAAI,OAAO,KAAK,SAAS,IAAI,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC;YAAE,SAAS;QACpE,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACnC,UAAU,CAAC,IAAI,CAAC;YACd,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,OAAO;YACP,IAAI,EAAE,SAAS,CAAC,IAAI;YACpB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,UAAU,CAAC;YACrE,SAAS,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU;SAClG,CAAC,CAAC;IACL,CAAC;IACD,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC;AACxC,CAAC,CAAC;AAUF,kEAAkE;AAClE,MAAM,UAAU,GAAG,CAAC,OAAe,EAAE,MAAc,EAAE,IAAY,EAAc,EAAE;IAC/E,IAAI,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;QACrC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC;IAC/F,CAAC;IACD,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7B,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAiB,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC;IACtG,CAAC;IACD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IACtD,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9B,OAAO,OAAO,IAAI,KAAK,QAAQ;QAC7B,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE;QACpC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC;AAC3D,CAAC,CAAC;AAEF,+EAA+E;AAC/E,MAAM,YAAY,GAAG,CAAC,QAAiB,EAAE,GAAW,EAAsB,EAAE;IAC1E,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,QAAQ,CAAC;QAAE,OAAO,SAAS,CAAC;IAC9F,MAAM,KAAK,GAAY,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IAClD,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACvD,CAAC,CAAC;AAEF,2GAA2G;AAC3G,MAAM,UAAU,GAAG,CAAC,UAAkB,EAAE,OAAyC,EAAsB,EAAE;IACvG,MAAM,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC3C,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACzC,IAAI,CAAC;QACH,OAAO,UAAU,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IACtD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,UAAkB,EAClB,qBAA4C,EAC5C,OAA0C,EAC3B,EAAE;IACjB,MAAM,QAAQ,GAAY,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IAC7F,MAAM,WAAW,GAAG,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,UAAU,CAAC;IACjE,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IACxC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,iBAAiB,CACtD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,qBAAqB,EACrB,OAAO,CAAC,OAAO,CAChB,CAAC;IACF,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,MAAM,WAAW,GAAqB,EAAE,CAAC;IACzC,MAAM,WAAW,GAAqB,EAAE,CAAC;IACzC,KAAK,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACxD,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,eAAe,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC;YACjG,SAAS;QACX,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAChD,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM;YAAE,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO;YAAE,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACzD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;YAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7D,CAAC;IACD,MAAM,WAAW,GAAG,YAAY,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IAC1D,MAAM,QAAQ,GAAG,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACjD,OAAO;QACL,IAAI,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE;QAC3F,QAAQ;KACT,CAAC;AACJ,CAAC,CAAC"}

package/dist/bin/forgebook-docs/forgebook-docs.mjs

@@ -1,64 +1,23 @@
 #!/usr/bin/env node
-var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
-    if (typeof path === "string" && /^\.\.?\//.test(path)) {
-        return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
-            return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
-        });
-    }
-    return path;
-};
 /**
- * The `forgebook-docs` command: writes a package's `CATALOG.md` from its exports, their TSDoc and its stories, or
- * checks that it is up to date.
- *
- * @remarks
- * Usage: `forgebook-docs --help` (generated by `@ensiria/cli-kit`). A package with stories declares
- * `forgebook` as a development dependency and runs it on itself (`"catalog": "forgebook-docs --package ."`).
+ * The `forgebook-docs` command, the former name of `forgebook docs`: writes a package's `CATALOG.md` and `llms.txt`, or
+ * checks them, and says where the command moved. Kept for one release so a package's `catalog` script keeps working
+ * after an update.
  *
  * @module
  */
-import { createRequire } from "node:module";
-import { join, relative, resolve } from "node:path";
-import { pathToFileURL } from "node:url";
-import { readFileSafe, writeIfChanged } from "@ensiria/cli-kit/files";
-import { plural } from "@ensiria/cli-kit/format";
-import { defineScript, ScriptError } from "@ensiria/cli-kit/script";
-import { isDocsModule } from "../../src/vite/adapter.js";
-import { catalogueMarkdown } from "./catalogueMarkdown.js";
-import { collectDocs } from "./collectDocs.js";
+import { resolve } from "node:path";
+import { defineScript } from "@ensiria/cli-kit/script";
+import { catalogueDocs } from "./catalogueDocs.js";
 /** The command, as the hints print it. */
 const COMMAND = "forgebook-docs";
-/**
- * The framework's reading of a story file's component: the docs module of `@forgebook/<framework>`, resolved from the
- * package, which declares that framework package.
- *
- * @param packageDir - the package's folder.
- * @param framework - the framework's name (`react`).
- * @throws a `ScriptError` when the package cannot resolve it or the module is not a docs module.
- */
-const extractorOf = async (packageDir, framework) => {
-    const specifier = `@forgebook/${framework}/docs`;
-    let file;
-    try {
-        file = createRequire(join(packageDir, "package.json")).resolve(specifier);
-    }
-    catch {
-        throw new ScriptError(`${specifier} is not installed in this package`, {
-            hint: `Add @forgebook/${framework} to its devDependencies`
-        });
-    }
-    const module = await import(__rewriteRelativeImportExtension(pathToFileURL(file).href));
-    if (!isDocsModule(module))
-        throw new ScriptError(`${specifier} exports no extractStoryComponent`);
-    return module.extractStoryComponent;
-};
 await defineScript({
     name: "forgebook-docs",
     command: COMMAND,
-    summary: "Write a package's CATALOG.md from its exports, their TSDoc and its stories.",
+    summary: "Write a package's CATALOG.md and llms.txt (moved to forgebook docs).",
     icon: "docs",
     json: true,
-    description: "Reads the package's exports (components from its stories, modules with TypeScript 6, Sass modules and style sheets from their text) and writes CATALOG.md in its folder: one dense line per entry, for agents to read before writing a component, hook or helper.",
+    description: "The former name of forgebook docs, kept for one release: reads the package's exports, their TSDoc and its stories, and writes CATALOG.md and llms.txt in its folder.",
     options: {
         package: {
             type: "string",
@@ -75,40 +34,18 @@ await defineScript({
         check: {
             type: "boolean",
             short: "c",
-            description: "Change nothing; fail when CATALOG.md is stale or a file cannot be read (CI)."
+            description: "Change nothing; fail when a file is stale or a file cannot be read (CI)."
         }
     },
-    examples: [
-        { command: `${COMMAND} --package .`, description: "Rewrite the CATALOG.md of the package you are in." },
-        { command: `${COMMAND} --package . --check`, description: "Check it in CI." }
-    ],
+    examples: [{ command: `${COMMAND} --package .`, description: "Now: forgebook docs." }],
     run: async ({ options, log }) => {
-        const packageDir = resolve(options.package);
-        const file = join(packageDir, "CATALOG.md");
-        const shownFile = relative(process.cwd(), file);
-        const { data, problems } = collectDocs(packageDir, await extractorOf(packageDir, options.framework));
-        for (const problem of problems)
-            log.error(problem);
-        const text = catalogueMarkdown(data);
-        const counts = {
-            components: data.components.length,
-            modules: data.modules.length,
-            sassModules: data.sassModules.length,
-            styleSheets: data.styleSheets.length
-        };
-        if (options.check) {
-            if (problems.length > 0)
-                throw new ScriptError(`${plural(problems.length, "file")} could not be read`);
-            if (readFileSafe(file) !== text)
-                throw new ScriptError(`${shownFile} is stale`, {
-                    hint: `Run ${COMMAND} --package ${relative(process.cwd(), packageDir)}`
-                });
-            log.success(`${shownFile} is up to date`);
-            return { status: "valid", file: shownFile, counts, problems };
-        }
-        const isWritten = writeIfChanged(file, text);
-        log.success(`${shownFile} ${isWritten ? "written" : "already up to date"}`);
-        return { status: isWritten ? "written" : "up-to-date", file: shownFile, counts, problems };
+        log.warn("forgebook-docs is now forgebook docs: change the package's script, this name goes in the next release");
+        return catalogueDocs({
+            packageDir: resolve(options.package),
+            framework: options.framework,
+            isCheck: options.check,
+            fixCommand: "forgebook docs"
+        }, log);
     }
 }).run();
 //# sourceMappingURL=forgebook-docs.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"forgebook-docs.mjs","sourceRoot":"","sources":["../../../bin/forgebook-docs/forgebook-docs.mts"],"names":[],"mappings":";;;;;;;;;AACA;;;;;;;;;GASG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEpE,OAAO,EAA8B,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAErF,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,0CAA0C;AAC1C,MAAM,OAAO,GAAG,gBAAgB,CAAC;AAEjC;;;;;;;GAOG;AACH,MAAM,WAAW,GAAG,KAAK,EAAE,UAAkB,EAAE,SAAiB,EAAkC,EAAE;IAClG,MAAM,SAAS,GAAG,cAAc,SAAS,OAAO,CAAC;IACjD,IAAI,IAAY,CAAC;IACjB,IAAI,CAAC;QACH,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5E,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,WAAW,CAAC,GAAG,SAAS,mCAAmC,EAAE;YACrE,IAAI,EAAE,kBAAkB,SAAS,yBAAyB;SAC3D,CAAC,CAAC;IACL,CAAC;IACD,MAAM,MAAM,GAAY,MAAM,MAAM,kCAAC,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,EAAC,CAAC;IAC/D,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,GAAG,SAAS,mCAAmC,CAAC,CAAC;IAClG,OAAO,MAAM,CAAC,qBAAqB,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,YAAY,CAAC;IACjB,IAAI,EAAE,gBAAgB;IACtB,OAAO,EAAE,OAAO;IAChB,OAAO,EAAE,6EAA6E;IACtF,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,IAAI;IACV,WAAW,EACT,mQAAmQ;IACrQ,OAAO,EAAE;QACP,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,QAAQ;YACnB,WAAW,EAAE,gDAAgD;SAC9D;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,MAAM;YACjB,WAAW,EACT,yGAAyG;SAC5G;QACD,KAAK,EAAE;YACL,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,WAAW,EAAE,8EAA8E;SAC5F;KACF;IACD,QAAQ,EAAE;QACR,EAAE,OAAO,EAAE,GAAG,OAAO,cAAc,EAAE,WAAW,EAAE,mDAAmD,EAAE;QACvG,EAAE,OAAO,EAAE,GAAG,OAAO,sBAAsB,EAAE,WAAW,EAAE,iBAAiB,EAAE;KAC9E;IACD,GAAG,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAgC,EAAE;QAC5D,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QAC5C,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC;QAChD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,UAAU,EAAE,MAAM,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;QACrG,KAAK,MAAM,OAAO,IAAI,QAAQ;YAAE,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACnD,MAAM,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,MAAM,GAAG;YACb,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM;YAClC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;YAC5B,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;YACpC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;SACrC,CAAC;QACF,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;gBAAE,MAAM,IAAI,WAAW,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,oBAAoB,CAAC,CAAC;YACvG,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,IAAI;gBAC7B,MAAM,IAAI,WAAW,CAAC,GAAG,SAAS,WAAW,EAAE;oBAC7C,IAAI,EAAE,OAAO,OAAO,cAAc,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,UAAU,CAAC,EAAE;iBACxE,CAAC,CAAC;YACL,GAAG,CAAC,OAAO,CAAC,GAAG,SAAS,gBAAgB,CAAC,CAAC;YAC1C,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QAChE,CAAC;QACD,MAAM,SAAS,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC7C,GAAG,CAAC,OAAO,CAAC,GAAG,SAAS,IAAI,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,oBAAoB,EAAE,CAAC,CAAC;QAC5E,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAC7F,CAAC;CACF,CAAC,CAAC,GAAG,EAAE,CAAC"}
+{"version":3,"file":"forgebook-docs.mjs","sourceRoot":"","sources":["../../../bin/forgebook-docs/forgebook-docs.mts"],"names":[],"mappings":";AACA;;;;;;GAMG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGnD,0CAA0C;AAC1C,MAAM,OAAO,GAAG,gBAAgB,CAAC;AAEjC,MAAM,YAAY,CAAC;IACjB,IAAI,EAAE,gBAAgB;IACtB,OAAO,EAAE,OAAO;IAChB,OAAO,EAAE,sEAAsE;IAC/E,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,IAAI;IACV,WAAW,EACT,sKAAsK;IACxK,OAAO,EAAE;QACP,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,SAAS,EAAE,QAAQ;YACnB,WAAW,EAAE,gDAAgD;SAC9D;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,OAAO;YAChB,SAAS,EAAE,MAAM;YACjB,WAAW,EACT,yGAAyG;SAC5G;QACD,KAAK,EAAE;YACL,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,WAAW,EAAE,0EAA0E;SACxF;KACF;IACD,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,cAAc,EAAE,WAAW,EAAE,sBAAsB,EAAE,CAAC;IACtF,GAAG,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,EAAgC,EAAE;QAC5D,GAAG,CAAC,IAAI,CACN,uGAAuG,CACxG,CAAC;QACF,OAAO,aAAa,CAClB;YACE,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;YACpC,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,OAAO,EAAE,OAAO,CAAC,KAAK;YACtB,UAAU,EAAE,gBAAgB;SAC7B,EACD,GAAG,CACJ,CAAC;IACJ,CAAC;CACF,CAAC,CAAC,GAAG,EAAE,CAAC"}

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

@@ -0,0 +1,24 @@
+/**
+ * A package's `llms.txt`, beside its `CATALOG.md`, in the llms.txt format (a title, a one-paragraph summary, sections of
+ * links): what an agent that lands on the package reads first, pointing it to the catalogue and to the commands that
+ * show a real use of each component. Pure: values in, text out.
+ *
+ * @module
+ */
+/** What the file says. */
+export type LlmsTextInput = {
+    /** The package's name. */
+    readonly packageName: string;
+    /** The package's description; none leaves the summary to the catalogue. */
+    readonly description: string | undefined;
+    /** The catalogue's file name (`CATALOG.md`). */
+    readonly catalogueFile: string;
+};
+/**
+ * The text of `llms.txt`.
+ *
+ * @param input - the package's name and description, and the catalogue's file name.
+ * @returns the text, ending with a newline.
+ */
+export declare const llmsText: (input: LlmsTextInput) => string;
+//# sourceMappingURL=llmsText.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"llmsText.d.ts","sourceRoot":"","sources":["../../../bin/forgebook-docs/llmsText.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,0BAA0B;AAC1B,MAAM,MAAM,aAAa,GAAG;IAC1B,0BAA0B;IAC1B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,2EAA2E;IAC3E,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,gDAAgD;IAChD,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,GAAI,OAAO,aAAa,KAAG,MAmBlC,CAAC"}

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

@@ -0,0 +1,33 @@
+/**
+ * A package's `llms.txt`, beside its `CATALOG.md`, in the llms.txt format (a title, a one-paragraph summary, sections of
+ * links): what an agent that lands on the package reads first, pointing it to the catalogue and to the commands that
+ * show a real use of each component. Pure: values in, text out.
+ *
+ * @module
+ */
+/**
+ * The text of `llms.txt`.
+ *
+ * @param input - the package's name and description, and the catalogue's file name.
+ * @returns the text, ending with a newline.
+ */
+export const llmsText = (input) => [
+    `# ${input.packageName}`,
+    "",
+    `> ${input.description ?? `The components, hooks, helpers and style modules of ${input.packageName}.`}`,
+    "",
+    "<!-- GENERATED by forgebook docs: do not edit. -->",
+    "",
+    "## Docs",
+    "",
+    `- [${input.catalogueFile}](${input.catalogueFile}): every component, hook, helper and style module, one line each: what it is, how to import it, its props, and the id of a story that shows it`,
+    "",
+    "## Optional",
+    "",
+    "Where the package's own catalogue runs (its repository, with Forgebook):",
+    "",
+    "- `npx forgebook story <id> --json`: a story's args and its component's props",
+    "- `npx forgebook mcp`: the same for an agent, over the Model Context Protocol (`list_stories`, `get_story`)",
+    ""
+].join("\n");
+//# sourceMappingURL=llmsText.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"llmsText.js","sourceRoot":"","sources":["../../../bin/forgebook-docs/llmsText.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAYH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,KAAoB,EAAU,EAAE,CACvD;IACE,KAAK,KAAK,CAAC,WAAW,EAAE;IACxB,EAAE;IACF,KAAK,KAAK,CAAC,WAAW,IAAI,uDAAuD,KAAK,CAAC,WAAW,GAAG,EAAE;IACvG,EAAE;IACF,oDAAoD;IACpD,EAAE;IACF,SAAS;IACT,EAAE;IACF,MAAM,KAAK,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa,gJAAgJ;IACjM,EAAE;IACF,aAAa;IACb,EAAE;IACF,0EAA0E;IAC1E,EAAE;IACF,+EAA+E;IAC/E,6GAA6G;IAC7G,EAAE;CACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC"}

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

@@ -0,0 +1,9 @@
+/**
+ * The source's id, from the declaring module's text.
+ *
+ * @param file - the module's path, for the parser (its extension says TypeScript or JSX).
+ * @param text - the module's text.
+ * @returns the id, or none when the module does not write it plainly.
+ */
+export declare const sourceIdOf: (file: string, text: string) => string | undefined;
+//# sourceMappingURL=sourceId.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sourceId.d.ts","sourceRoot":"","sources":["../../../bin/forgebook-docs/sourceId.ts"],"names":[],"mappings":"AA6BA;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GAAI,MAAM,MAAM,EAAE,MAAM,MAAM,KAAG,MAAM,GAAG,SAShE,CAAC"}

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

@@ -0,0 +1,45 @@
+/**
+ * The id a package's stories carry in a catalogue, read from the module that declares its source (its `./stories`
+ * export) without running it: the `id` of the exported `source`, when written plainly.
+ *
+ * @remarks
+ * A story's id starts with its source's id (`kit:inputs-select--overview`), so `CATALOG.md` can name a component's
+ * main story only when it knows it. A source built by code gives none, and the lines then name no story.
+ *
+ * @module
+ */
+import { parseSync } from "vite";
+import { propertyValue, unwrapped } from "../../src/vite/indexStoryFile.js";
+/** The object a top-level `export const source = …` holds, if it is written as one. */
+const sourceObject = (statement) => {
+    if (statement.type !== "ExportNamedDeclaration" || statement.declaration?.type !== "VariableDeclaration")
+        return undefined;
+    for (const declarator of statement.declaration.declarations) {
+        if (declarator.id.type !== "Identifier" || declarator.id.name !== "source" || declarator.init === null)
+            continue;
+        const init = unwrapped(declarator.init);
+        if (init.type === "ObjectExpression")
+            return init;
+    }
+    return undefined;
+};
+/**
+ * The source's id, from the declaring module's text.
+ *
+ * @param file - the module's path, for the parser (its extension says TypeScript or JSX).
+ * @param text - the module's text.
+ * @returns the id, or none when the module does not write it plainly.
+ */
+export const sourceIdOf = (file, text) => {
+    const { program, errors } = parseSync(file, text);
+    if (errors.length > 0)
+        return undefined;
+    for (const statement of program.body) {
+        const object = sourceObject(statement);
+        const id = object === undefined ? undefined : propertyValue(object, "id");
+        if (id?.type === "Literal" && typeof id.value === "string")
+            return id.value;
+    }
+    return undefined;
+};
+//# sourceMappingURL=sourceId.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sourceId.js","sourceRoot":"","sources":["../../../bin/forgebook-docs/sourceId.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAe,SAAS,EAAE,MAAM,MAAM,CAAC;AAE9C,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAE5E,uFAAuF;AACvF,MAAM,YAAY,GAAG,CACnB,SAAsD,EACjB,EAAE;IACvC,IAAI,SAAS,CAAC,IAAI,KAAK,wBAAwB,IAAI,SAAS,CAAC,WAAW,EAAE,IAAI,KAAK,qBAAqB;QACtG,OAAO,SAAS,CAAC;IACnB,KAAK,MAAM,UAAU,IAAI,SAAS,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC;QAC5D,IAAI,UAAU,CAAC,EAAE,CAAC,IAAI,KAAK,YAAY,IAAI,UAAU,CAAC,EAAE,CAAC,IAAI,KAAK,QAAQ,IAAI,UAAU,CAAC,IAAI,KAAK,IAAI;YACpG,SAAS;QACX,MAAM,IAAI,GAAG,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB;YAAE,OAAO,IAAI,CAAC;IACpD,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,IAAY,EAAsB,EAAE;IAC3E,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IACxC,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;QACvC,MAAM,EAAE,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC1E,IAAI,EAAE,EAAE,IAAI,KAAK,SAAS,IAAI,OAAO,EAAE,CAAC,KAAK,KAAK,QAAQ;YAAE,OAAO,EAAE,CAAC,KAAK,CAAC;IAC9E,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC"}

package/dist/bin/frameworkDocs.d.ts

@@ -0,0 +1,10 @@
+import { type DocsModule } from "../src/vite/adapter.ts";
+/**
+ * The framework's docs module, from the package that declares the framework package.
+ *
+ * @param packageDir - the package's folder.
+ * @param framework - the framework's name (`react`).
+ * @throws a `ScriptError` when the package cannot resolve it or the module is not a docs module.
+ */
+export declare const frameworkDocsModule: (packageDir: string, framework: string) => Promise<DocsModule>;
+//# sourceMappingURL=frameworkDocs.d.ts.map

package/dist/bin/frameworkDocs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"frameworkDocs.d.ts","sourceRoot":"","sources":["../../bin/frameworkDocs.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,KAAK,UAAU,EAAgB,MAAM,wBAAwB,CAAC;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAAU,YAAY,MAAM,EAAE,WAAW,MAAM,KAAG,OAAO,CAAC,UAAU,CAanG,CAAC"}

package/dist/bin/frameworkDocs.js

@@ -0,0 +1,43 @@
+var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
+    if (typeof path === "string" && /^\.\.?\//.test(path)) {
+        return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
+            return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
+        });
+    }
+    return path;
+};
+/**
+ * The framework's docs module (`@forgebook/<framework>/docs`), resolved from a package as that package resolves it:
+ * what `forgebook docs` and `forgebook new` read components with, in a library that has no catalogue configuration.
+ *
+ * @module
+ */
+import { createRequire } from "node:module";
+import { join } from "node:path";
+import { pathToFileURL } from "node:url";
+import { ScriptError } from "@ensiria/cli-kit/script";
+import { isDocsModule } from "../src/vite/adapter.js";
+/**
+ * The framework's docs module, from the package that declares the framework package.
+ *
+ * @param packageDir - the package's folder.
+ * @param framework - the framework's name (`react`).
+ * @throws a `ScriptError` when the package cannot resolve it or the module is not a docs module.
+ */
+export const frameworkDocsModule = async (packageDir, framework) => {
+    const specifier = `@forgebook/${framework}/docs`;
+    let file;
+    try {
+        file = createRequire(join(packageDir, "package.json")).resolve(specifier);
+    }
+    catch {
+        throw new ScriptError(`${specifier} is not installed in this package`, {
+            hint: `Add @forgebook/${framework} to its devDependencies`
+        });
+    }
+    const module = await import(__rewriteRelativeImportExtension(pathToFileURL(file).href));
+    if (!isDocsModule(module))
+        throw new ScriptError(`${specifier} exports no extractStoryComponent`);
+    return module;
+};
+//# sourceMappingURL=frameworkDocs.js.map

package/dist/bin/frameworkDocs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"frameworkDocs.js","sourceRoot":"","sources":["../../bin/frameworkDocs.ts"],"names":[],"mappings":";;;;;;;;AAAA;;;;;GAKG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD,OAAO,EAAmB,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEvE;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EAAE,UAAkB,EAAE,SAAiB,EAAuB,EAAE;IACtG,MAAM,SAAS,GAAG,cAAc,SAAS,OAAO,CAAC;IACjD,IAAI,IAAY,CAAC;IACjB,IAAI,CAAC;QACH,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5E,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,WAAW,CAAC,GAAG,SAAS,mCAAmC,EAAE;YACrE,IAAI,EAAE,kBAAkB,SAAS,yBAAyB;SAC3D,CAAC,CAAC;IACL,CAAC;IACD,MAAM,MAAM,GAAY,MAAM,MAAM,kCAAC,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,EAAC,CAAC;IAC/D,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,GAAG,SAAS,mCAAmC,CAAC,CAAC;IAClG,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/dist/src/argTypes.d.ts

@@ -14,6 +14,7 @@
  */
 import type { StoryControlsSetting } from "@forgebook/story-format/source";
 import type { PropDocs } from "./componentDocs.ts";
+import type { NamedValues } from "./namedValues.ts";
 /** A control as the panel draws it; `none` for an arg the panel lists without a control. */
 export type PanelControl = "select" | "radio" | "check" | "multi-select" | "boolean" | "text" | "number" | "range" | "color" | "date" | "none";
 /** How the panel shows one arg, from its `argTypes` entry: what crosses from the frame to the shell. */
@@ -54,6 +55,28 @@ export type PanelProp = PropDocs & {
     /** A range's or a number's step. */
     readonly step?: number;
 };
+/**
+ * Whether a prop is a colour: named so by its `argTypes`, or by the name convention (`color`, `accentColor`).
+ *
+ * @param prop - the prop.
+ */
+export declare const isColorProp: (prop: PanelProp) => boolean;
+/**
+ * Whether a prop is chosen among the values the source names for its type (`IconComponent`).
+ *
+ * @param prop - the prop.
+ * @param namedValues - the source's named values.
+ */
+export declare const isNamedProp: (prop: PanelProp, namedValues: NamedValues) => boolean;
+/**
+ * The props the panel can set: a prop of a type the source names values for is chosen among them, a node that takes a
+ * text is set as one; any other `other` prop, and an event, cannot be set; nor a prop the story's controls leave out.
+ *
+ * @param props - the component's props, with the story's `argTypes` laid over them.
+ * @param controls - the props the story lets the panel set.
+ * @param namedValues - the source's named values.
+ */
+export declare const settableProps: (props: readonly PanelProp[], controls: StoryControlsSetting, namedValues: NamedValues) => PanelProp[];
 /**
  * The `argTypes` of the meta and the story, merged: each arg's entry from both, the story's fields over the meta's.
  *