@mnaoumov/typescript-dev-toolkit 1.3.1 → 2.0.0

package/dist/lib/esm/docs-site/api-doc-types.d.mts

@@ -0,0 +1,157 @@
+/// <reference path="../library-references.d.mts" />
+/**
+ * @file
+ *
+ * Shared data-model types for the API documentation generator.
+ */
+/**
+ * A fenced code block of a markdown text, with the language its fence names (empty when none).
+ */
+export interface CodeSegment {
+    lang: string;
+    text: string;
+    type: 'code';
+}
+/**
+ * A documented enum member.
+ */
+export interface EnumMemberInfo {
+    description: string;
+    name: string;
+    value: string;
+}
+/**
+ * A run of a markdown text: prose, or a fenced code block.
+ */
+export type MarkdownSegment = CodeSegment | ProseSegment;
+/**
+ * A documented property, method, constructor or function signature.
+ */
+export interface MemberInfo {
+    description: string;
+    examples: string[];
+    inheritedFrom: string;
+    isStatic: boolean;
+    name: string;
+    overloadKey: string;
+    parameters: ParameterInfo[];
+    remarks: string;
+    returnDescription: string;
+    returnType: string;
+    signature: string;
+    since: string;
+    type: string;
+}
+/**
+ * A generated page's content and the path it is written to.
+ */
+export interface PageContent {
+    content: string;
+    filePath: string;
+}
+/**
+Frontmatter shared by every generated page. `description` and `signature` are optional because not
+every page has them, but a page that HAS one must emit it: both feed the page's OG card.
+ */
+export interface PageFrontMatter {
+    description?: string | undefined;
+    sidebarLabel: string;
+    signature?: string | undefined;
+    slug: string;
+    title: string;
+}
+/**
+ * A documented parameter.
+ */
+export interface ParameterInfo {
+    description: string;
+    name: string;
+    type: string;
+}
+/**
+ * A run of markdown prose between code blocks.
+ */
+export interface ProseSegment {
+    text: string;
+    type: 'prose';
+}
+/**
+ * The part of a ts-morph method or function the declared return type is read from.
+ */
+export interface ReturnTypeProvider {
+    getReturnType: () => TextProvider;
+    getReturnTypeNode?: () => TextProvider | undefined;
+}
+/**
+ * A collapsible Starlight sidebar group.
+ */
+export interface SidebarEntry {
+    collapsed: boolean;
+    items: (SidebarEntry | SidebarLink)[];
+    label: string;
+}
+/**
+ * A Starlight sidebar link.
+ */
+export interface SidebarLink {
+    label: string;
+    link: string;
+}
+/**
+Recursive tree node for building the sidebar
+ */
+export interface SidebarTreeNode {
+    children: Map<string, SidebarTreeNode>;
+    types: TypeInfo[];
+}
+/**
+ * A ts-morph node or type whose text can be printed.
+ */
+export interface TextProvider {
+    getText: () => string;
+}
+/**
+ * A documented export: a class, interface, enum, type alias, function or variable.
+ */
+export interface TypeInfo {
+    baseTypes: string[];
+    /**
+    For classes: the constructor (public/protected), if any
+     */
+    constructorInfo?: MemberInfo | undefined;
+    description: string;
+    /**
+    For enums: the enum members
+     */
+    enumMembers: EnumMemberInfo[];
+    examples: string[];
+    /**
+    For classes: types in the `implements` clause
+     */
+    implementsTypes: string[];
+    kind: 'class' | 'enum' | 'function' | 'interface' | 'type' | 'variable';
+    methods: MemberInfo[];
+    name: string;
+    namespace: string;
+    properties: MemberInfo[];
+    remarks: string;
+    /**
+    For type aliases: the right-hand-side type text
+     */
+    typeAliasText?: string;
+    typeParameters: string[];
+    /**
+    For variables: the declaration keyword (let/const/var)
+     */
+    variableKeyword?: string;
+    /**
+    For variables: the type annotation
+     */
+    variableType?: string;
+}
+/**
+ * An object entry of the `typedoc-plugin-mdn-links` Web API data.
+ */
+export interface WebApiEntry {
+    url: string;
+}

package/dist/lib/esm/docs-site/api-doc-types.mjs

@@ -0,0 +1,6 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFtdLAogICJzb3VyY2VzQ29udGVudCI6IFtdLAogICJtYXBwaW5ncyI6ICIiLAogICJuYW1lcyI6IFtdCn0K

package/dist/lib/esm/docs-site/api-docs.d.mts

@@ -0,0 +1,34 @@
+/// <reference path="../library-references.d.mts" />
+/**
+ * @file
+ *
+ * The API documentation generator: walks a package's `src`, extracts every documentable exported declaration via
+ * ts-morph, and writes Starlight-compatible MDX pages plus a sidebar JSON. The output tree mirrors the package's
+ * module structure: a type's namespace is its source path relative to `src`, which is also its import subpath.
+ */
+import type { ApiDocSettings } from './api-doc-settings.mjs';
+/**
+ * Options for {@link generateApiDocs}.
+ */
+export interface GenerateApiDocsParams {
+    /**
+     * The repository root: the folder holding `tsconfig.json` and `node_modules`.
+     */
+    readonly rootDirectory: string;
+    /**
+     * The settings every page and link is rendered with.
+     */
+    readonly settings: ApiDocSettings;
+    /**
+     * The folder whose modules are documented, normally `<root>/src`.
+     */
+    readonly sourceDirectory: string;
+}
+/**
+ * Generates the API reference pages and the sidebar.
+ *
+ * Skips the work when neither the sources, the settings nor the generator changed since the last run.
+ *
+ * @param options - The options.
+ */
+export declare function generateApiDocs(options: GenerateApiDocsParams): Promise<void>;

package/dist/lib/esm/docs-site/api-docs.mjs

@@ -0,0 +1,139 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+(function () {
+function ensureBrowserProcess() {
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return '/';
+    },
+    env: {},
+    platform: 'android'
+  };
+
+  const existingProcess = globalThis.process;
+
+  if (!existingProcess) {
+    globalThis.process = browserProcess;
+    return;
+  }
+
+  if (existingProcess.versions?.node) {
+    return;
+  }
+
+  const existingProcessRecord = existingProcess;
+
+  for (const [key, value] of Object.entries(browserProcess)) {
+    existingProcessRecord[key] ??= value;
+  }
+
+  existingProcessRecord['browser'] = true;
+}
+
+ensureBrowserProcess();
+})();
+
+import {
+  existsSync,
+  readFileSync
+} from "node:fs";
+import {
+  mkdir,
+  rm,
+  writeFile
+} from "node:fs/promises";
+import {
+  dirname,
+  join,
+  normalize
+} from "node:path";
+import { fileURLToPath } from "node:url";
+import { Project } from "ts-morph";
+import { extractFileOverview } from "./api-doc-jsdoc.mjs";
+import {
+  loadExternalTypeMaps,
+  registerMemberPages,
+  registerRouteSegments
+} from "./api-doc-link-rendering.mjs";
+import { clearPackageDeclarations } from "./api-doc-package-sites.mjs";
+import {
+  appendBacklinksAndWrite,
+  generateMemberPages,
+  generateNamespaceIndexPages,
+  generateOverviewPage,
+  generateSidebarJson
+} from "./api-doc-page-generation.mjs";
+import { configureApiDocs } from "./api-doc-settings.mjs";
+import {
+  collectFunctions,
+  collectPackageDeclarations,
+  collectVariables,
+  computeCacheHash,
+  computeNamespace,
+  findEntryFiles,
+  processSourceFile,
+  registerGenericTypeParams
+} from "./api-doc-source-processing.mjs";
+import { resolveInheritedMembers } from "./api-doc-type-merging.mjs";
+const CACHE_FILE_NAME = ".cache-hash";
+async function generateApiDocs(options) {
+  const { rootDirectory, settings, sourceDirectory } = options;
+  configureApiDocs(settings);
+  loadExternalTypeMaps(rootDirectory);
+  const entryFiles = findEntryFiles(sourceDirectory);
+  console.warn(`Found ${String(entryFiles.length)} entry source files`);
+  const cacheFile = join(settings.outputDirectory, CACHE_FILE_NAME);
+  const currentHash = computeCacheHash(entryFiles, dirname(fileURLToPath(import.meta.url)));
+  if (existsSync(cacheFile) && existsSync(settings.sidebarFile) && readFileSync(cacheFile, "utf-8").trim() === currentHash) {
+    console.warn("Source files and generator unchanged \u2014 skipping generation.");
+    return;
+  }
+  const project = new Project({
+    skipAddingFilesFromTsConfig: true,
+    tsConfigFilePath: join(rootDirectory, "tsconfig.json")
+  });
+  const sourceFiles = project.addSourceFilesAtPaths(entryFiles);
+  const types = /* @__PURE__ */ new Map();
+  const moduleOverviews = /* @__PURE__ */ new Map();
+  clearPackageDeclarations();
+  for (const src of sourceFiles) {
+    const namespace = computeNamespace(sourceDirectory, normalize(src.getFilePath()));
+    const overview = extractFileOverview(src);
+    if (overview) {
+      moduleOverviews.set(namespace, overview);
+    }
+    collectPackageDeclarations(src);
+    processSourceFile(src, types, namespace);
+    collectFunctions(src, types, namespace);
+    collectVariables(src, types, namespace);
+  }
+  resolveInheritedMembers(types);
+  for (const info of types.values()) {
+    info.properties.sort((a, b) => a.name.localeCompare(b.name));
+    info.methods.sort((a, b) => a.name.localeCompare(b.name));
+  }
+  registerGenericTypeParams(types);
+  registerRouteSegments(types);
+  registerMemberPages(types);
+  await rm(settings.outputDirectory, { force: true, recursive: true });
+  await mkdir(settings.outputDirectory, { recursive: true });
+  await generateNamespaceIndexPages(types, types, moduleOverviews);
+  const pageContents = /* @__PURE__ */ new Map();
+  for (const [key, info] of types) {
+    pageContents.set(key, await generateOverviewPage(info.name, info, types));
+    if (info.kind === "class" || info.kind === "interface") {
+      await generateMemberPages(info.name, info, types);
+    }
+  }
+  await appendBacklinksAndWrite(pageContents, types);
+  await generateSidebarJson(types);
+  await writeFile(cacheFile, currentHash, "utf-8");
+  console.warn(`Generated docs for ${String(types.size)} types across ${String(moduleOverviews.size)} documented modules`);
+}
+export {
+  generateApiDocs
+};
+//# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["../../../../src/docs-site/api-docs.ts"],"sourcesContent":["/**\n * @file\n *\n * The API documentation generator: walks a package's `src`, extracts every documentable exported declaration via\n * ts-morph, and writes Starlight-compatible MDX pages plus a sidebar JSON. The output tree mirrors the package's\n * module structure: a type's namespace is its source path relative to `src`, which is also its import subpath.\n */\n\nimport {\n  existsSync,\n  readFileSync\n} from 'node:fs';\nimport {\n  mkdir,\n  rm,\n  writeFile\n} from 'node:fs/promises';\nimport {\n  dirname,\n  join,\n  normalize\n} from 'node:path';\nimport { fileURLToPath } from 'node:url';\nimport { Project } from 'ts-morph';\n\nimport type { ApiDocSettings } from './api-doc-settings.ts';\nimport type {\n  PageContent,\n  TypeInfo\n} from './api-doc-types.ts';\n\nimport { extractFileOverview } from './api-doc-jsdoc.ts';\nimport {\n  loadExternalTypeMaps,\n  registerMemberPages,\n  registerRouteSegments\n} from './api-doc-link-rendering.ts';\nimport { clearPackageDeclarations } from './api-doc-package-sites.ts';\nimport {\n  appendBacklinksAndWrite,\n  generateMemberPages,\n  generateNamespaceIndexPages,\n  generateOverviewPage,\n  generateSidebarJson\n} from './api-doc-page-generation.ts';\nimport { configureApiDocs } from './api-doc-settings.ts';\nimport {\n  collectFunctions,\n  collectPackageDeclarations,\n  collectVariables,\n  computeCacheHash,\n  computeNamespace,\n  findEntryFiles,\n  processSourceFile,\n  registerGenericTypeParams\n} from './api-doc-source-processing.ts';\nimport { resolveInheritedMembers } from './api-doc-type-merging.ts';\n\n/**\n * Options for {@link generateApiDocs}.\n */\nexport interface GenerateApiDocsParams {\n  /**\n   * The repository root: the folder holding `tsconfig.json` and `node_modules`.\n   */\n  readonly rootDirectory: string;\n\n  /**\n   * The settings every page and link is rendered with.\n   */\n  readonly settings: ApiDocSettings;\n\n  /**\n   * The folder whose modules are documented, normally `<root>/src`.\n   */\n  readonly sourceDirectory: string;\n}\n\nconst CACHE_FILE_NAME = '.cache-hash';\n\n/**\n * Generates the API reference pages and the sidebar.\n *\n * Skips the work when neither the sources, the settings nor the generator changed since the last run.\n *\n * @param options - The options.\n */\nexport async function generateApiDocs(options: GenerateApiDocsParams): Promise<void> {\n  const { rootDirectory, settings, sourceDirectory } = options;\n  configureApiDocs(settings);\n  loadExternalTypeMaps(rootDirectory);\n\n  const entryFiles = findEntryFiles(sourceDirectory);\n  console.warn(`Found ${String(entryFiles.length)} entry source files`);\n\n  const cacheFile = join(settings.outputDirectory, CACHE_FILE_NAME);\n  const currentHash = computeCacheHash(entryFiles, dirname(fileURLToPath(import.meta.url)));\n  if (existsSync(cacheFile) && existsSync(settings.sidebarFile) && readFileSync(cacheFile, 'utf-8').trim() === currentHash) {\n    console.warn('Source files and generator unchanged — skipping generation.');\n    return;\n  }\n\n  // Load via the repo's tsconfig so inferred types resolve.\n  const project = new Project({\n    skipAddingFilesFromTsConfig: true,\n    tsConfigFilePath: join(rootDirectory, 'tsconfig.json')\n  });\n  const sourceFiles = project.addSourceFilesAtPaths(entryFiles);\n\n  const types = new Map<string, TypeInfo>();\n  const moduleOverviews = new Map<string, string>();\n  clearPackageDeclarations();\n\n  for (const src of sourceFiles) {\n    const namespace = computeNamespace(sourceDirectory, normalize(src.getFilePath()));\n    const overview = extractFileOverview(src);\n    if (overview) {\n      moduleOverviews.set(namespace, overview);\n    }\n    collectPackageDeclarations(src);\n    processSourceFile(src, types, namespace);\n    collectFunctions(src, types, namespace);\n    collectVariables(src, types, namespace);\n  }\n\n  resolveInheritedMembers(types);\n\n  for (const info of types.values()) {\n    info.properties.sort((a, b) => a.name.localeCompare(b.name));\n    info.methods.sort((a, b) => a.name.localeCompare(b.name));\n  }\n\n  registerGenericTypeParams(types);\n  registerRouteSegments(types);\n  registerMemberPages(types);\n\n  await rm(settings.outputDirectory, { force: true, recursive: true });\n  await mkdir(settings.outputDirectory, { recursive: true });\n\n  await generateNamespaceIndexPages(types, types, moduleOverviews);\n\n  // Pass 1: generate all pages without backlinks, collect content (keyed by qualified id)\n  const pageContents = new Map<string, PageContent>();\n  for (const [key, info] of types) {\n    pageContents.set(key, await generateOverviewPage(info.name, info, types));\n    if (info.kind === 'class' || info.kind === 'interface') {\n      await generateMemberPages(info.name, info, types);\n    }\n  }\n\n  // Pass 2: scan content for links, append backlinks, write files\n  await appendBacklinksAndWrite(pageContents, types);\n\n  await generateSidebarJson(types);\n  await writeFile(cacheFile, currentHash, 'utf-8');\n\n  console.warn(`Generated docs for ${String(types.size)} types across ${String(moduleOverviews.size)} documented modules`);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQA;AAAA,EACE;AAAA,EACA;AAAA,OACK;AACP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,qBAAqB;AAC9B,SAAS,eAAe;AAQxB,SAAS,2BAA2B;AACpC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,gCAAgC;AACzC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,wBAAwB;AACjC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,+BAA+B;AAsBxC,MAAM,kBAAkB;AASxB,eAAsB,gBAAgB,SAA+C;AACnF,QAAM,EAAE,eAAe,UAAU,gBAAgB,IAAI;AACrD,mBAAiB,QAAQ;AACzB,uBAAqB,aAAa;AAElC,QAAM,aAAa,eAAe,eAAe;AACjD,UAAQ,KAAK,SAAS,OAAO,WAAW,MAAM,CAAC,qBAAqB;AAEpE,QAAM,YAAY,KAAK,SAAS,iBAAiB,eAAe;AAChE,QAAM,cAAc,iBAAiB,YAAY,QAAQ,cAAc,YAAY,GAAG,CAAC,CAAC;AACxF,MAAI,WAAW,SAAS,KAAK,WAAW,SAAS,WAAW,KAAK,aAAa,WAAW,OAAO,EAAE,KAAK,MAAM,aAAa;AACxH,YAAQ,KAAK,kEAA6D;AAC1E;AAAA,EACF;AAGA,QAAM,UAAU,IAAI,QAAQ;AAAA,IAC1B,6BAA6B;AAAA,IAC7B,kBAAkB,KAAK,eAAe,eAAe;AAAA,EACvD,CAAC;AACD,QAAM,cAAc,QAAQ,sBAAsB,UAAU;AAE5D,QAAM,QAAQ,oBAAI,IAAsB;AACxC,QAAM,kBAAkB,oBAAI,IAAoB;AAChD,2BAAyB;AAEzB,aAAW,OAAO,aAAa;AAC7B,UAAM,YAAY,iBAAiB,iBAAiB,UAAU,IAAI,YAAY,CAAC,CAAC;AAChF,UAAM,WAAW,oBAAoB,GAAG;AACxC,QAAI,UAAU;AACZ,sBAAgB,IAAI,WAAW,QAAQ;AAAA,IACzC;AACA,+BAA2B,GAAG;AAC9B,sBAAkB,KAAK,OAAO,SAAS;AACvC,qBAAiB,KAAK,OAAO,SAAS;AACtC,qBAAiB,KAAK,OAAO,SAAS;AAAA,EACxC;AAEA,0BAAwB,KAAK;AAE7B,aAAW,QAAQ,MAAM,OAAO,GAAG;AACjC,SAAK,WAAW,KAAK,CAAC,GAAG,MAAM,EAAE,KAAK,cAAc,EAAE,IAAI,CAAC;AAC3D,SAAK,QAAQ,KAAK,CAAC,GAAG,MAAM,EAAE,KAAK,cAAc,EAAE,IAAI,CAAC;AAAA,EAC1D;AAEA,4BAA0B,KAAK;AAC/B,wBAAsB,KAAK;AAC3B,sBAAoB,KAAK;AAEzB,QAAM,GAAG,SAAS,iBAAiB,EAAE,OAAO,MAAM,WAAW,KAAK,CAAC;AACnE,QAAM,MAAM,SAAS,iBAAiB,EAAE,WAAW,KAAK,CAAC;AAEzD,QAAM,4BAA4B,OAAO,OAAO,eAAe;AAG/D,QAAM,eAAe,oBAAI,IAAyB;AAClD,aAAW,CAAC,KAAK,IAAI,KAAK,OAAO;AAC/B,iBAAa,IAAI,KAAK,MAAM,qBAAqB,KAAK,MAAM,MAAM,KAAK,CAAC;AACxE,QAAI,KAAK,SAAS,WAAW,KAAK,SAAS,aAAa;AACtD,YAAM,oBAAoB,KAAK,MAAM,MAAM,KAAK;AAAA,IAClD;AAAA,EACF;AAGA,QAAM,wBAAwB,cAAc,KAAK;AAEjD,QAAM,oBAAoB,KAAK;AAC/B,QAAM,UAAU,WAAW,aAAa,OAAO;AAE/C,UAAQ,KAAK,sBAAsB,OAAO,MAAM,IAAI,CAAC,iBAAiB,OAAO,gBAAgB,IAAI,CAAC,qBAAqB;AACzH;","names":[]}

package/dist/lib/esm/docs-site/astro-config.d.mts

@@ -0,0 +1,23 @@
+/// <reference path="../library-references.d.mts" />
+/**
+ * @file
+ *
+ * The Astro + Starlight configuration every documentation site is built with.
+ *
+ * A site's own `astro.config.ts` is one call, `export default defineDocsSiteConfig({ repo, title })`: the base path,
+ * the edit and GitHub links, the sidebar, the shared components and stylesheet, the Open Graph metadata and the
+ * Markdown plugins all follow from the repository's name.
+ */
+import type { AstroUserConfig } from 'astro';
+import type { DocsSiteConfig } from './docs-site-config.mjs';
+/**
+ * Builds a documentation site's Astro configuration.
+ *
+ * The site's source lives under `<docs>/src` (`srcDir`), so it never collides with the package's own `src/` and
+ * `dist/`. The API reference is generated into `<docs>/src/content/docs/api` with a matching
+ * `<docs>/src/generated-sidebar.json`, which this reads; run the generator first.
+ *
+ * @param config - The site's configuration.
+ * @returns The Astro configuration.
+ */
+export declare function defineDocsSiteConfig(config: DocsSiteConfig): AstroUserConfig;

package/dist/lib/esm/docs-site/astro-config.mjs

@@ -0,0 +1,135 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+(function () {
+function ensureBrowserProcess() {
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return '/';
+    },
+    env: {},
+    platform: 'android'
+  };
+
+  const existingProcess = globalThis.process;
+
+  if (!existingProcess) {
+    globalThis.process = browserProcess;
+    return;
+  }
+
+  if (existingProcess.versions?.node) {
+    return;
+  }
+
+  const existingProcessRecord = existingProcess;
+
+  for (const [key, value] of Object.entries(browserProcess)) {
+    existingProcessRecord[key] ??= value;
+  }
+
+  existingProcessRecord['browser'] = true;
+}
+
+ensureBrowserProcess();
+})();
+
+import { satteri } from "@astrojs/markdown-satteri";
+import starlight from "@astrojs/starlight";
+import {
+  extname,
+  join,
+  toPosixPath
+} from "@mnaoumov/typescript-lib/path";
+import { defineConfig } from "astro/config";
+import {
+  existsSync,
+  readFileSync
+} from "node:fs";
+import { fileURLToPath } from "node:url";
+import {
+  API_COMPONENTS_IMPORT_PREFIX,
+  getDocsSiteAssetsDirectory
+} from "./docs-site-assets.mjs";
+import { resolveDocsSiteConfig } from "./docs-site-config.mjs";
+import { satteriGitHubAlerts } from "./satteri-github-alerts.mjs";
+import { satteriRelativeLinks } from "./satteri-relative-links.mjs";
+function defineDocsSiteConfig(config) {
+  const resolved = resolveDocsSiteConfig(config);
+  const assetsDirectory = toPosixPath(getDocsSiteAssetsDirectory());
+  return defineConfig({
+    base: resolved.basePath,
+    integrations: [
+      starlight({
+        components: {
+          SiteTitle: join(assetsDirectory, "components", "SiteTitle.astro")
+        },
+        customCss: [
+          join(assetsDirectory, "styles", "global.css")
+        ],
+        editLink: {
+          baseUrl: resolved.editLinkBaseUrl
+        },
+        favicon: "/favicon.svg",
+        routeMiddleware: getRouteDataModulePath(),
+        sidebar: [
+          {
+            items: [{ autogenerate: { directory: resolved.guidesDirectory } }],
+            label: "Guides"
+          },
+          ...readApiSidebar(resolved.apiDocSettings.sidebarFile)
+        ],
+        social: [
+          { href: resolved.githubUrl, icon: "github", label: "GitHub" }
+        ],
+        title: resolved.title
+      })
+    ],
+    markdown: {
+      // Astro 7.3 made Sätteri the default Markdown processor; `markdown.remarkPlugins` now runs only on the
+      // `unified` processor from `@astrojs/markdown-remark`, which Astro no longer installs. Naming the
+      // Sätteri processor here keeps the pipeline on it, carrying the link rewrite as one of its mdast plugins.
+      // The GitHub-alert conversion rides here too, ahead of the asides plugin Starlight appends after these:
+      // `starlight-github-alerts` cannot find that plugin on Starlight 0.42 and silently skipped every page.
+      processor: satteri({ mdastPlugins: [satteriGitHubAlerts(), satteriRelativeLinks(resolved.basePath)] })
+    },
+    // eslint-disable-next-line unicorn/name-replacements -- `outDir` is an Astro config key.
+    outDir: resolved.distDirectory,
+    // eslint-disable-next-line unicorn/name-replacements -- `publicDir` is an Astro config key.
+    publicDir: resolved.publicDirectory,
+    root: resolved.rootDirectory,
+    site: resolved.siteOrigin,
+    // eslint-disable-next-line unicorn/name-replacements -- `srcDir` is an Astro config key.
+    srcDir: resolved.docsSourceDirectory,
+    trailingSlash: "always",
+    vite: {
+      define: {
+        // The site title shows the documented package's version; `SiteTitle.astro` reads it from here.
+        "import.meta.env.DOCS_SITE_PACKAGE_VERSION": JSON.stringify(resolved.packageVersion)
+      },
+      resolve: {
+        alias: [
+          { find: API_COMPONENTS_IMPORT_PREFIX, replacement: join(assetsDirectory, "components") }
+        ]
+      }
+    }
+  });
+}
+function getRouteDataModulePath() {
+  const thisModulePath = toPosixPath(fileURLToPath(import.meta.url));
+  return join(thisModulePath, "..", `route-data${extname(thisModulePath)}`);
+}
+function readApiSidebar(sidebarFile) {
+  if (!existsSync(sidebarFile)) {
+    console.warn(`[astro.config] ${sidebarFile} not found. Generate the API reference first (npm run docs:build).`);
+    return [];
+  }
+  const parsed = JSON.parse(readFileSync(sidebarFile, "utf-8"));
+  return Array.isArray(parsed) ? parsed : [];
+}
+export {
+  defineDocsSiteConfig
+};
+//# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["../../../../src/docs-site/astro-config.ts"],"sourcesContent":["/**\n * @file\n *\n * The Astro + Starlight configuration every documentation site is built with.\n *\n * A site's own `astro.config.ts` is one call, `export default defineDocsSiteConfig({ repo, title })`: the base path,\n * the edit and GitHub links, the sidebar, the shared components and stylesheet, the Open Graph metadata and the\n * Markdown plugins all follow from the repository's name.\n */\n\nimport type { StarlightUserConfig } from '@astrojs/starlight/types';\nimport type { AstroUserConfig } from 'astro';\n\nimport { satteri } from '@astrojs/markdown-satteri';\n// eslint-disable-next-line import-x/no-rename-default -- The default export name `StarlightIntegration` is too verbose.\nimport starlight from '@astrojs/starlight';\nimport {\n  extname,\n  join,\n  toPosixPath\n} from '@mnaoumov/typescript-lib/path';\nimport { defineConfig } from 'astro/config';\nimport {\n  existsSync,\n  readFileSync\n} from 'node:fs';\nimport { fileURLToPath } from 'node:url';\n\nimport type { DocsSiteConfig } from './docs-site-config.ts';\n\nimport {\n  API_COMPONENTS_IMPORT_PREFIX,\n  getDocsSiteAssetsDirectory\n} from './docs-site-assets.ts';\nimport { resolveDocsSiteConfig } from './docs-site-config.ts';\nimport { satteriGitHubAlerts } from './satteri-github-alerts.ts';\nimport { satteriRelativeLinks } from './satteri-relative-links.ts';\n\ntype SidebarItems = NonNullable<StarlightUserConfig['sidebar']>;\n\n/**\n * Builds a documentation site's Astro configuration.\n *\n * The site's source lives under `<docs>/src` (`srcDir`), so it never collides with the package's own `src/` and\n * `dist/`. The API reference is generated into `<docs>/src/content/docs/api` with a matching\n * `<docs>/src/generated-sidebar.json`, which this reads; run the generator first.\n *\n * @param config - The site's configuration.\n * @returns The Astro configuration.\n */\nexport function defineDocsSiteConfig(config: DocsSiteConfig): AstroUserConfig {\n  const resolved = resolveDocsSiteConfig(config);\n  const assetsDirectory = toPosixPath(getDocsSiteAssetsDirectory());\n\n  return defineConfig({\n    base: resolved.basePath,\n    integrations: [\n      starlight({\n        components: {\n          SiteTitle: join(assetsDirectory, 'components', 'SiteTitle.astro')\n        },\n        customCss: [\n          join(assetsDirectory, 'styles', 'global.css')\n        ],\n        editLink: {\n          baseUrl: resolved.editLinkBaseUrl\n        },\n        favicon: '/favicon.svg',\n        routeMiddleware: getRouteDataModulePath(),\n        sidebar: [\n          {\n            items: [{ autogenerate: { directory: resolved.guidesDirectory } }],\n            label: 'Guides'\n          },\n          ...readApiSidebar(resolved.apiDocSettings.sidebarFile)\n        ],\n        social: [\n          { href: resolved.githubUrl, icon: 'github', label: 'GitHub' }\n        ],\n        title: resolved.title\n      })\n    ],\n    markdown: {\n      // Astro 7.3 made Sätteri the default Markdown processor; `markdown.remarkPlugins` now runs only on the\n      // `unified` processor from `@astrojs/markdown-remark`, which Astro no longer installs. Naming the\n      // Sätteri processor here keeps the pipeline on it, carrying the link rewrite as one of its mdast plugins.\n      // The GitHub-alert conversion rides here too, ahead of the asides plugin Starlight appends after these:\n      // `starlight-github-alerts` cannot find that plugin on Starlight 0.42 and silently skipped every page.\n      processor: satteri({ mdastPlugins: [satteriGitHubAlerts(), satteriRelativeLinks(resolved.basePath)] })\n    },\n    // eslint-disable-next-line unicorn/name-replacements -- `outDir` is an Astro config key.\n    outDir: resolved.distDirectory,\n    // eslint-disable-next-line unicorn/name-replacements -- `publicDir` is an Astro config key.\n    publicDir: resolved.publicDirectory,\n    root: resolved.rootDirectory,\n    site: resolved.siteOrigin,\n    // eslint-disable-next-line unicorn/name-replacements -- `srcDir` is an Astro config key.\n    srcDir: resolved.docsSourceDirectory,\n    trailingSlash: 'always',\n    vite: {\n      define: {\n        // The site title shows the documented package's version; `SiteTitle.astro` reads it from here.\n        'import.meta.env.DOCS_SITE_PACKAGE_VERSION': JSON.stringify(resolved.packageVersion)\n      },\n      resolve: {\n        alias: [\n          { find: API_COMPONENTS_IMPORT_PREFIX, replacement: join(assetsDirectory, 'components') }\n        ]\n      }\n    }\n  });\n}\n\n// `route-data` sits beside this module in every build of it, with the same extension: `.ts` in this repository,\n// `.mjs` / `.cjs` once installed.\nfunction getRouteDataModulePath(): string {\n  const thisModulePath = toPosixPath(fileURLToPath(import.meta.url));\n  return join(thisModulePath, '..', `route-data${extname(thisModulePath)}`);\n}\n\nfunction readApiSidebar(sidebarFile: string): SidebarItems {\n  if (!existsSync(sidebarFile)) {\n    console.warn(`[astro.config] ${sidebarFile} not found. Generate the API reference first (npm run docs:build).`);\n    return [];\n  }\n\n  const parsed: unknown = JSON.parse(readFileSync(sidebarFile, 'utf-8'));\n  return Array.isArray(parsed) ? parsed as SidebarItems : [];\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAaA,SAAS,eAAe;AAExB,OAAO,eAAe;AACtB;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,oBAAoB;AAC7B;AAAA,EACE;AAAA,EACA;AAAA,OACK;AACP,SAAS,qBAAqB;AAI9B;AAAA,EACE;AAAA,EACA;AAAA,OACK;AACP,SAAS,6BAA6B;AACtC,SAAS,2BAA2B;AACpC,SAAS,4BAA4B;AAc9B,SAAS,qBAAqB,QAAyC;AAC5E,QAAM,WAAW,sBAAsB,MAAM;AAC7C,QAAM,kBAAkB,YAAY,2BAA2B,CAAC;AAEhE,SAAO,aAAa;AAAA,IAClB,MAAM,SAAS;AAAA,IACf,cAAc;AAAA,MACZ,UAAU;AAAA,QACR,YAAY;AAAA,UACV,WAAW,KAAK,iBAAiB,cAAc,iBAAiB;AAAA,QAClE;AAAA,QACA,WAAW;AAAA,UACT,KAAK,iBAAiB,UAAU,YAAY;AAAA,QAC9C;AAAA,QACA,UAAU;AAAA,UACR,SAAS,SAAS;AAAA,QACpB;AAAA,QACA,SAAS;AAAA,QACT,iBAAiB,uBAAuB;AAAA,QACxC,SAAS;AAAA,UACP;AAAA,YACE,OAAO,CAAC,EAAE,cAAc,EAAE,WAAW,SAAS,gBAAgB,EAAE,CAAC;AAAA,YACjE,OAAO;AAAA,UACT;AAAA,UACA,GAAG,eAAe,SAAS,eAAe,WAAW;AAAA,QACvD;AAAA,QACA,QAAQ;AAAA,UACN,EAAE,MAAM,SAAS,WAAW,MAAM,UAAU,OAAO,SAAS;AAAA,QAC9D;AAAA,QACA,OAAO,SAAS;AAAA,MAClB,CAAC;AAAA,IACH;AAAA,IACA,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAMR,WAAW,QAAQ,EAAE,cAAc,CAAC,oBAAoB,GAAG,qBAAqB,SAAS,QAAQ,CAAC,EAAE,CAAC;AAAA,IACvG;AAAA;AAAA,IAEA,QAAQ,SAAS;AAAA;AAAA,IAEjB,WAAW,SAAS;AAAA,IACpB,MAAM,SAAS;AAAA,IACf,MAAM,SAAS;AAAA;AAAA,IAEf,QAAQ,SAAS;AAAA,IACjB,eAAe;AAAA,IACf,MAAM;AAAA,MACJ,QAAQ;AAAA;AAAA,QAEN,6CAA6C,KAAK,UAAU,SAAS,cAAc;AAAA,MACrF;AAAA,MACA,SAAS;AAAA,QACP,OAAO;AAAA,UACL,EAAE,MAAM,8BAA8B,aAAa,KAAK,iBAAiB,YAAY,EAAE;AAAA,QACzF;AAAA,MACF;AAAA,IACF;AAAA,EACF,CAAC;AACH;AAIA,SAAS,yBAAiC;AACxC,QAAM,iBAAiB,YAAY,cAAc,YAAY,GAAG,CAAC;AACjE,SAAO,KAAK,gBAAgB,MAAM,aAAa,QAAQ,cAAc,CAAC,EAAE;AAC1E;AAEA,SAAS,eAAe,aAAmC;AACzD,MAAI,CAAC,WAAW,WAAW,GAAG;AAC5B,YAAQ,KAAK,kBAAkB,WAAW,oEAAoE;AAC9G,WAAO,CAAC;AAAA,EACV;AAEA,QAAM,SAAkB,KAAK,MAAM,aAAa,aAAa,OAAO,CAAC;AACrE,SAAO,MAAM,QAAQ,MAAM,IAAI,SAAyB,CAAC;AAC3D;","names":[]}

package/dist/lib/esm/docs-site/docs-links.d.mts

@@ -0,0 +1,32 @@
+/// <reference path="../library-references.d.mts" />
+/**
+ * @file
+ *
+ * Validates the links emitted by a built documentation site.
+ *
+ * Internal links are resolved offline against the build output; external links are validated over the network,
+ * deduplicated so each unique URL is fetched at most once. See {@link ./link-check.ts} for the decision logic.
+ *
+ * It also fails on a GitHub alert that reached a page as a plain blockquote (see {@link ./unrendered-alerts.ts}),
+ * since nothing else notices when the conversion stops.
+ */
+/**
+ * Options for {@link assertDocsLinksResolve}.
+ */
+export interface AssertDocsLinksResolveParams {
+    /**
+     * The build output folder, normally `<docs>/dist`.
+     */
+    readonly outputDirectory: string;
+    /**
+     * The absolute URL the site is served from, with a trailing slash, e.g. `https://mnaoumov.dev/typescript-lib/`.
+     */
+    readonly siteBaseUrl: string;
+}
+/**
+ * Checks every link of the built site, and that every GitHub alert rendered as an aside.
+ *
+ * @param options - The options.
+ * @throws If an alert rendered as a plain blockquote, or a link does not resolve.
+ */
+export declare function assertDocsLinksResolve(options: AssertDocsLinksResolveParams): Promise<void>;