@mnaoumov/typescript-dev-toolkit 1.3.0 → 2.0.0

package/dist/lib/cjs/docs-site/astro-config.cjs

@@ -0,0 +1,169 @@
+/*
+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();
+})();
+
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var astro_config_exports = {};
+__export(astro_config_exports, {
+  defineDocsSiteConfig: () => defineDocsSiteConfig
+});
+module.exports = __toCommonJS(astro_config_exports);
+var import_markdown_satteri = require('@astrojs/markdown-satteri');
+var import_starlight = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('@astrojs/starlight')), 1);
+var import_path = require('@mnaoumov/typescript-lib/path');
+var import_config = require('astro/config');
+var import_node_fs = require('node:fs');
+var import_node_url = require('node:url');
+var import_docs_site_assets = require('./docs-site-assets.cjs');
+var import_docs_site_config = require('./docs-site-config.cjs');
+var import_satteri_github_alerts = require('./satteri-github-alerts.cjs');
+var import_satteri_relative_links = require('./satteri-relative-links.cjs');
+var __import_meta_url = globalThis["import.meta.url"] ?? (function getCjsImportMetaUrl() {
+  if (typeof __filename === "string") {
+    const localRequire = require;
+    const url = localRequire("node:url");
+    if (typeof url.pathToFileURL === "function") {
+      return url.pathToFileURL(__filename).href;
+    }
+  }
+  return globalThis.location?.href ?? "";
+})();
+function defineDocsSiteConfig(config) {
+  const resolved = (0, import_docs_site_config.resolveDocsSiteConfig)(config);
+  const assetsDirectory = (0, import_path.toPosixPath)((0, import_docs_site_assets.getDocsSiteAssetsDirectory)());
+  return (0, import_config.defineConfig)({
+    base: resolved.basePath,
+    integrations: [
+      (0, import_starlight.default)({
+        components: {
+          SiteTitle: (0, import_path.join)(assetsDirectory, "components", "SiteTitle.astro")
+        },
+        customCss: [
+          (0, import_path.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: (0, import_markdown_satteri.satteri)({ mdastPlugins: [(0, import_satteri_github_alerts.satteriGitHubAlerts)(), (0, import_satteri_relative_links.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: import_docs_site_assets.API_COMPONENTS_IMPORT_PREFIX, replacement: (0, import_path.join)(assetsDirectory, "components") }
+        ]
+      }
+    }
+  });
+}
+function getRouteDataModulePath() {
+  const thisModulePath = (0, import_path.toPosixPath)((0, import_node_url.fileURLToPath)(__import_meta_url));
+  return (0, import_path.join)(thisModulePath, "..", `route-data${(0, import_path.extname)(thisModulePath)}`);
+}
+function readApiSidebar(sidebarFile) {
+  if (!(0, import_node_fs.existsSync)(sidebarFile)) {
+    console.warn(`[astro.config] ${sidebarFile} not found. Generate the API reference first (npm run docs:build).`);
+    return [];
+  }
+  const parsed = JSON.parse((0, import_node_fs.readFileSync)(sidebarFile, "utf-8"));
+  return Array.isArray(parsed) ? parsed : [];
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  defineDocsSiteConfig
+});
+//# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["../../../../src/docs-site/astro-config.ts"],"sourcesContent":["var __import_meta_url = globalThis['import.meta.url'] ?? (function getCjsImportMetaUrl() {\n  if (typeof __filename === 'string') {\n    const localRequire = require;\n    const url = localRequire('node:url');\n    if (typeof url.pathToFileURL === 'function') {\n      return url.pathToFileURL(__filename).href;\n    }\n  }\n\n  // Fallback to the page URL, or an empty string if the environment is unknown.\n  return globalThis.location?.href ?? '';\n})();\n/**\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;AAAA;AAAA;AAAA;AAAA;AAyBA,8BAAwB;AAExB,uBAAsB;AACtB,kBAIO;AACP,oBAA6B;AAC7B,qBAGO;AACP,sBAA8B;AAI9B,8BAGO;AACP,8BAAsC;AACtC,mCAAoC;AACpC,oCAAqC;AAhDrC,IAAI,oBAAoB,WAAW,iBAAiB,MAAM,SAAS,sBAAsB;AACvF,MAAI,OAAO,eAAe,UAAU;AAClC,UAAM,eAAe;AACrB,UAAM,MAAM,aAAa,UAAU;AACnC,QAAI,OAAO,IAAI,kBAAkB,YAAY;AAC3C,aAAO,IAAI,cAAc,UAAU,EAAE;AAAA,IACvC;AAAA,EACF;AAGA,SAAO,WAAW,UAAU,QAAQ;AACtC,GAAG;AAmDI,SAAS,qBAAqB,QAAyC;AAC5E,QAAM,eAAW,+CAAsB,MAAM;AAC7C,QAAM,sBAAkB,6BAAY,oDAA2B,CAAC;AAEhE,aAAO,4BAAa;AAAA,IAClB,MAAM,SAAS;AAAA,IACf,cAAc;AAAA,UACZ,iBAAAA,SAAU;AAAA,QACR,YAAY;AAAA,UACV,eAAW,kBAAK,iBAAiB,cAAc,iBAAiB;AAAA,QAClE;AAAA,QACA,WAAW;AAAA,cACT,kBAAK,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,eAAW,iCAAQ,EAAE,cAAc,KAAC,kDAAoB,OAAG,oDAAqB,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,sDAA8B,iBAAa,kBAAK,iBAAiB,YAAY,EAAE;AAAA,QACzF;AAAA,MACF;AAAA,IACF;AAAA,EACF,CAAC;AACH;AAIA,SAAS,yBAAiC;AACxC,QAAM,qBAAiB,6BAAY,+BAAc,iBAAe,CAAC;AACjE,aAAO,kBAAK,gBAAgB,MAAM,iBAAa,qBAAQ,cAAc,CAAC,EAAE;AAC1E;AAEA,SAAS,eAAe,aAAmC;AACzD,MAAI,KAAC,2BAAW,WAAW,GAAG;AAC5B,YAAQ,KAAK,kBAAkB,WAAW,oEAAoE;AAC9G,WAAO,CAAC;AAAA,EACV;AAEA,QAAM,SAAkB,KAAK,UAAM,6BAAa,aAAa,OAAO,CAAC;AACrE,SAAO,MAAM,QAAQ,MAAM,IAAI,SAAyB,CAAC;AAC3D;","names":["starlight"]}

package/dist/lib/cjs/docs-site/astro-config.d.cts

@@ -0,0 +1,23 @@
+/// <reference path="../library-references.d.cts" />
+/**
+ * @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' with { 'resolution-mode': 'import' };
+import type { DocsSiteConfig } from './docs-site-config.cjs';
+/**
+ * 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/cjs/docs-site/docs-links.cjs

@@ -0,0 +1,123 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var docs_links_exports = {};
+__export(docs_links_exports, {
+  assertDocsLinksResolve: () => assertDocsLinksResolve
+});
+module.exports = __toCommonJS(docs_links_exports);
+var import_promises = require('node:fs/promises');
+var import_node_path = require('node:path');
+var import_link_check = require('./link-check.cjs');
+var import_unrendered_alerts = require('./unrendered-alerts.cjs');
+const EXTERNAL_LINK_TIMEOUT_IN_MILLISECONDS = 1e4;
+const EXTERNAL_LINK_CONCURRENCY = 20;
+const HTML_FILE_EXTENSION = ".html";
+const FALLBACK_PAGE_RELATIVE_PATH = "404.html";
+async function assertDocsLinksResolve(options) {
+  const outputDirectory = (0, import_node_path.resolve)(options.outputDirectory).replaceAll("\\", "/");
+  const allFiles = await getAllFiles(outputDirectory);
+  const pages = await readPages(outputDirectory, allFiles);
+  const unrenderedAlerts = (0, import_unrendered_alerts.collectUnrenderedAlerts)(pages);
+  if (unrenderedAlerts.length > 0) {
+    throw new Error(
+      `Detected ${String(unrenderedAlerts.length)} GitHub alert(s) rendered as a plain blockquote instead of an aside:
+${(0, import_unrendered_alerts.formatUnrenderedAlerts)(unrenderedAlerts)}`
+    );
+  }
+  const internalBrokenLinks = (0, import_link_check.collectBrokenLinks)(pages, createFileSystem({ allFiles, outputDirectory, pages }), options.siteBaseUrl);
+  const externalTargets = (0, import_link_check.collectExternalTargets)(pages, options.siteBaseUrl);
+  const externalBrokenLinks = await (0, import_link_check.collectBrokenExternalLinks)(externalTargets, fetchUrlStatus, EXTERNAL_LINK_CONCURRENCY);
+  const brokenLinks = [...internalBrokenLinks, ...externalBrokenLinks];
+  if (brokenLinks.length > 0) {
+    throw new Error(`Detected ${String(brokenLinks.length)} broken documentation link(s):
+${(0, import_link_check.formatBrokenLinks)(brokenLinks)}`);
+  }
+}
+function createFileSystem(params) {
+  const { allFiles, outputDirectory, pages } = params;
+  const htmlByRelativePath = new Map(pages.map((page) => [page.relativePath, page.html]));
+  const idsCache = /* @__PURE__ */ new Map();
+  return {
+    readIds: (pageKey) => {
+      let ids = idsCache.get(pageKey);
+      if (ids === void 0) {
+        const html = htmlByRelativePath.get(pageKey);
+        ids = html === void 0 ? /* @__PURE__ */ new Set() : (0, import_link_check.extractIds)(html);
+        idsCache.set(pageKey, ids);
+      }
+      return ids;
+    },
+    resolveExistingPage: (outputRelativePath) => {
+      if ((0, import_link_check.resolveWithinRoot)(outputDirectory, outputRelativePath) === null) {
+        return null;
+      }
+      const trimmed = outputRelativePath.replace(/\/$/u, "");
+      const candidates = trimmed === "" ? ["index.html"] : [trimmed, `${trimmed}/index.html`];
+      return candidates.find((candidate) => allFiles.has(candidate)) ?? null;
+    }
+  };
+}
+async function fetchUrlStatus(url) {
+  const controller = new AbortController();
+  const timeoutId = globalThis.setTimeout(() => {
+    controller.abort();
+  }, EXTERNAL_LINK_TIMEOUT_IN_MILLISECONDS);
+  try {
+    const response = await fetch(url, { signal: controller.signal });
+    await response.body?.cancel();
+    return response.status;
+  } catch {
+    return import_link_check.NETWORK_FAILURE_STATUS;
+  } finally {
+    globalThis.clearTimeout(timeoutId);
+  }
+}
+async function getAllFiles(outputRootPath) {
+  const entries = await (0, import_promises.readdir)(outputRootPath, { recursive: true, withFileTypes: true });
+  const files = /* @__PURE__ */ new Set();
+  for (const entry of entries) {
+    if (!entry.isFile()) {
+      continue;
+    }
+    const absolutePath = (0, import_node_path.resolve)(entry.parentPath, entry.name).replaceAll("\\", "/");
+    files.add(absolutePath.slice(`${outputRootPath}/`.length));
+  }
+  return files;
+}
+async function readPages(outputRootPath, allFiles) {
+  const pages = [];
+  for (const relativePath of allFiles) {
+    if (!relativePath.endsWith(HTML_FILE_EXTENSION) || relativePath === FALLBACK_PAGE_RELATIVE_PATH) {
+      continue;
+    }
+    const html = await (0, import_promises.readFile)((0, import_node_path.resolve)(outputRootPath, relativePath), "utf-8");
+    pages.push({ html, relativePath });
+  }
+  return pages;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  assertDocsLinksResolve
+});
+//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../src/docs-site/docs-links.ts"],
  "sourcesContent": ["/**\n * @file\n *\n * Validates the links emitted by a built documentation site.\n *\n * Internal links are resolved offline against the build output; external links are validated over the network,\n * deduplicated so each unique URL is fetched at most once. See {@link ./link-check.ts} for the decision logic.\n *\n * It also fails on a GitHub alert that reached a page as a plain blockquote (see {@link ./unrendered-alerts.ts}),\n * since nothing else notices when the conversion stops.\n */\n\nimport {\n  readdir,\n  readFile\n} from 'node:fs/promises';\nimport { resolve } from 'node:path';\n\nimport type {\n  DocumentationPage,\n  LinkCheckFileSystem\n} from './link-check.ts';\n\nimport {\n  collectBrokenExternalLinks,\n  collectBrokenLinks,\n  collectExternalTargets,\n  extractIds,\n  formatBrokenLinks,\n  NETWORK_FAILURE_STATUS,\n  resolveWithinRoot\n} from './link-check.ts';\nimport {\n  collectUnrenderedAlerts,\n  formatUnrenderedAlerts\n} from './unrendered-alerts.ts';\n\n/**\n * Options for {@link assertDocsLinksResolve}.\n */\nexport interface AssertDocsLinksResolveParams {\n  /**\n   * The build output folder, normally `<docs>/dist`.\n   */\n  readonly outputDirectory: string;\n\n  /**\n   * The absolute URL the site is served from, with a trailing slash, e.g. `https://mnaoumov.dev/typescript-lib/`.\n   */\n  readonly siteBaseUrl: string;\n}\n\nconst EXTERNAL_LINK_TIMEOUT_IN_MILLISECONDS = 10_000;\nconst EXTERNAL_LINK_CONCURRENCY = 20;\nconst HTML_FILE_EXTENSION = '.html';\n\n// The host serves this page as the fallback for any missing path (with a 404 status), so it is not a\n// real navigable route: Starlight gives it a self-`rel=\"canonical\"` of `/404/` that inherently cannot\n// resolve, and its body links (nav, logo) are identical to every real page we already validate.\nconst FALLBACK_PAGE_RELATIVE_PATH = '404.html';\n\ninterface CreateFileSystemParams {\n  readonly allFiles: Set<string>;\n  readonly outputDirectory: string;\n  readonly pages: DocumentationPage[];\n}\n\n/**\n * Checks every link of the built site, and that every GitHub alert rendered as an aside.\n *\n * @param options - The options.\n * @throws If an alert rendered as a plain blockquote, or a link does not resolve.\n */\nexport async function assertDocsLinksResolve(options: AssertDocsLinksResolveParams): Promise<void> {\n  const outputDirectory = resolve(options.outputDirectory).replaceAll('\\\\', '/');\n  const allFiles = await getAllFiles(outputDirectory);\n  const pages = await readPages(outputDirectory, allFiles);\n\n  // Offline and instant, so it runs before the network half and fails first.\n  const unrenderedAlerts = collectUnrenderedAlerts(pages);\n  if (unrenderedAlerts.length > 0) {\n    throw new Error(\n      `Detected ${String(unrenderedAlerts.length)} GitHub alert(s) rendered as a plain blockquote instead of an aside:\\n${formatUnrenderedAlerts(unrenderedAlerts)}`\n    );\n  }\n\n  const internalBrokenLinks = collectBrokenLinks(pages, createFileSystem({ allFiles, outputDirectory, pages }), options.siteBaseUrl);\n\n  const externalTargets = collectExternalTargets(pages, options.siteBaseUrl);\n  const externalBrokenLinks = await collectBrokenExternalLinks(externalTargets, fetchUrlStatus, EXTERNAL_LINK_CONCURRENCY);\n\n  const brokenLinks = [...internalBrokenLinks, ...externalBrokenLinks];\n  if (brokenLinks.length > 0) {\n    throw new Error(`Detected ${String(brokenLinks.length)} broken documentation link(s):\\n${formatBrokenLinks(brokenLinks)}`);\n  }\n}\n\nfunction createFileSystem(params: CreateFileSystemParams): LinkCheckFileSystem {\n  const { allFiles, outputDirectory, pages } = params;\n  const htmlByRelativePath = new Map(pages.map((page) => [page.relativePath, page.html]));\n  const idsCache = new Map<string, Set<string>>();\n\n  return {\n    readIds: (pageKey): Set<string> => {\n      let ids = idsCache.get(pageKey);\n      if (ids === undefined) {\n        const html = htmlByRelativePath.get(pageKey);\n        ids = html === undefined ? new Set<string>() : extractIds(html);\n        idsCache.set(pageKey, ids);\n      }\n\n      return ids;\n    },\n    resolveExistingPage: (outputRelativePath): null | string => {\n      if (resolveWithinRoot(outputDirectory, outputRelativePath) === null) {\n        return null;\n      }\n\n      const trimmed = outputRelativePath.replace(/\\/$/u, '');\n      const candidates = trimmed === '' ? ['index.html'] : [trimmed, `${trimmed}/index.html`];\n      return candidates.find((candidate) => allFiles.has(candidate)) ?? null;\n    }\n  };\n}\n\nasync function fetchUrlStatus(url: string): Promise<number> {\n  const controller = new AbortController();\n  const timeoutId = globalThis.setTimeout(() => {\n    controller.abort();\n  }, EXTERNAL_LINK_TIMEOUT_IN_MILLISECONDS);\n\n  try {\n    const response = await fetch(url, { signal: controller.signal });\n    // Cancel the unread body so undici releases the connection immediately.\n    // Without this the per-host connection pool stalls and same-host requests\n    // serialize, turning a ~3s run into minutes.\n    await response.body?.cancel();\n    return response.status;\n  } catch {\n    return NETWORK_FAILURE_STATUS;\n  } finally {\n    globalThis.clearTimeout(timeoutId);\n  }\n}\n\nasync function getAllFiles(outputRootPath: string): Promise<Set<string>> {\n  const entries = await readdir(outputRootPath, { recursive: true, withFileTypes: true });\n  const files = new Set<string>();\n  for (const entry of entries) {\n    if (!entry.isFile()) {\n      continue;\n    }\n\n    const absolutePath = resolve(entry.parentPath, entry.name).replaceAll('\\\\', '/');\n    files.add(absolutePath.slice(`${outputRootPath}/`.length));\n  }\n\n  return files;\n}\n\nasync function readPages(outputRootPath: string, allFiles: Set<string>): Promise<DocumentationPage[]> {\n  const pages: DocumentationPage[] = [];\n  for (const relativePath of allFiles) {\n    if (!relativePath.endsWith(HTML_FILE_EXTENSION) || relativePath === FALLBACK_PAGE_RELATIVE_PATH) {\n      continue;\n    }\n\n    const html = await readFile(resolve(outputRootPath, relativePath), 'utf-8');\n    pages.push({ html, relativePath });\n  }\n\n  return pages;\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAYA,sBAGO;AACP,uBAAwB;AAOxB,wBAQO;AACP,+BAGO;AAiBP,MAAM,wCAAwC;AAC9C,MAAM,4BAA4B;AAClC,MAAM,sBAAsB;AAK5B,MAAM,8BAA8B;AAcpC,eAAsB,uBAAuB,SAAsD;AACjG,QAAM,sBAAkB,0BAAQ,QAAQ,eAAe,EAAE,WAAW,MAAM,GAAG;AAC7E,QAAM,WAAW,MAAM,YAAY,eAAe;AAClD,QAAM,QAAQ,MAAM,UAAU,iBAAiB,QAAQ;AAGvD,QAAM,uBAAmB,kDAAwB,KAAK;AACtD,MAAI,iBAAiB,SAAS,GAAG;AAC/B,UAAM,IAAI;AAAA,MACR,YAAY,OAAO,iBAAiB,MAAM,CAAC;AAAA,MAAyE,iDAAuB,gBAAgB,CAAC;AAAA,IAC9J;AAAA,EACF;AAEA,QAAM,0BAAsB,sCAAmB,OAAO,iBAAiB,EAAE,UAAU,iBAAiB,MAAM,CAAC,GAAG,QAAQ,WAAW;AAEjI,QAAM,sBAAkB,0CAAuB,OAAO,QAAQ,WAAW;AACzE,QAAM,sBAAsB,UAAM,8CAA2B,iBAAiB,gBAAgB,yBAAyB;AAEvH,QAAM,cAAc,CAAC,GAAG,qBAAqB,GAAG,mBAAmB;AACnE,MAAI,YAAY,SAAS,GAAG;AAC1B,UAAM,IAAI,MAAM,YAAY,OAAO,YAAY,MAAM,CAAC;AAAA,MAAmC,qCAAkB,WAAW,CAAC,EAAE;AAAA,EAC3H;AACF;AAEA,SAAS,iBAAiB,QAAqD;AAC7E,QAAM,EAAE,UAAU,iBAAiB,MAAM,IAAI;AAC7C,QAAM,qBAAqB,IAAI,IAAI,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,cAAc,KAAK,IAAI,CAAC,CAAC;AACtF,QAAM,WAAW,oBAAI,IAAyB;AAE9C,SAAO;AAAA,IACL,SAAS,CAAC,YAAyB;AACjC,UAAI,MAAM,SAAS,IAAI,OAAO;AAC9B,UAAI,QAAQ,QAAW;AACrB,cAAM,OAAO,mBAAmB,IAAI,OAAO;AAC3C,cAAM,SAAS,SAAY,oBAAI,IAAY,QAAI,8BAAW,IAAI;AAC9D,iBAAS,IAAI,SAAS,GAAG;AAAA,MAC3B;AAEA,aAAO;AAAA,IACT;AAAA,IACA,qBAAqB,CAAC,uBAAsC;AAC1D,cAAI,qCAAkB,iBAAiB,kBAAkB,MAAM,MAAM;AACnE,eAAO;AAAA,MACT;AAEA,YAAM,UAAU,mBAAmB,QAAQ,QAAQ,EAAE;AACrD,YAAM,aAAa,YAAY,KAAK,CAAC,YAAY,IAAI,CAAC,SAAS,GAAG,OAAO,aAAa;AACtF,aAAO,WAAW,KAAK,CAAC,cAAc,SAAS,IAAI,SAAS,CAAC,KAAK;AAAA,IACpE;AAAA,EACF;AACF;AAEA,eAAe,eAAe,KAA8B;AAC1D,QAAM,aAAa,IAAI,gBAAgB;AACvC,QAAM,YAAY,WAAW,WAAW,MAAM;AAC5C,eAAW,MAAM;AAAA,EACnB,GAAG,qCAAqC;AAExC,MAAI;AACF,UAAM,WAAW,MAAM,MAAM,KAAK,EAAE,QAAQ,WAAW,OAAO,CAAC;AAI/D,UAAM,SAAS,MAAM,OAAO;AAC5B,WAAO,SAAS;AAAA,EAClB,QAAQ;AACN,WAAO;AAAA,EACT,UAAE;AACA,eAAW,aAAa,SAAS;AAAA,EACnC;AACF;AAEA,eAAe,YAAY,gBAA8C;AACvE,QAAM,UAAU,UAAM,yBAAQ,gBAAgB,EAAE,WAAW,MAAM,eAAe,KAAK,CAAC;AACtF,QAAM,QAAQ,oBAAI,IAAY;AAC9B,aAAW,SAAS,SAAS;AAC3B,QAAI,CAAC,MAAM,OAAO,GAAG;AACnB;AAAA,IACF;AAEA,UAAM,mBAAe,0BAAQ,MAAM,YAAY,MAAM,IAAI,EAAE,WAAW,MAAM,GAAG;AAC/E,UAAM,IAAI,aAAa,MAAM,GAAG,cAAc,IAAI,MAAM,CAAC;AAAA,EAC3D;AAEA,SAAO;AACT;AAEA,eAAe,UAAU,gBAAwB,UAAqD;AACpG,QAAM,QAA6B,CAAC;AACpC,aAAW,gBAAgB,UAAU;AACnC,QAAI,CAAC,aAAa,SAAS,mBAAmB,KAAK,iBAAiB,6BAA6B;AAC/F;AAAA,IACF;AAEA,UAAM,OAAO,UAAM,8BAAS,0BAAQ,gBAAgB,YAAY,GAAG,OAAO;AAC1E,UAAM,KAAK,EAAE,MAAM,aAAa,CAAC;AAAA,EACnC;AAEA,SAAO;AACT;",
  "names": []
}


package/dist/lib/cjs/docs-site/docs-links.d.cts

@@ -0,0 +1,32 @@
+/// <reference path="../library-references.d.cts" />
+/**
+ * @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>;

package/dist/lib/cjs/docs-site/docs-site-assets.cjs

@@ -0,0 +1,64 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var docs_site_assets_exports = {};
+__export(docs_site_assets_exports, {
+  API_COMPONENTS_IMPORT_PREFIX: () => API_COMPONENTS_IMPORT_PREFIX,
+  getDocsSiteAssetsDirectory: () => getDocsSiteAssetsDirectory
+});
+module.exports = __toCommonJS(docs_site_assets_exports);
+var import_node_fs = require('node:fs');
+var import_node_path = require('node:path');
+var import_node_url = require('node:url');
+var __import_meta_url = globalThis["import.meta.url"] ?? (function getCjsImportMetaUrl() {
+  if (typeof __filename === "string") {
+    const localRequire = require;
+    const url = localRequire("node:url");
+    if (typeof url.pathToFileURL === "function") {
+      return url.pathToFileURL(__filename).href;
+    }
+  }
+  return globalThis.location?.href ?? "";
+})();
+const ASSETS_RELATIVE_PATH = (0, import_node_path.join)("assets", "docs-site");
+const API_COMPONENTS_IMPORT_PREFIX = "@mnaoumov/typescript-dev-toolkit/docs-site-components";
+function getDocsSiteAssetsDirectory(moduleUrl = __import_meta_url) {
+  let directory = (0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(moduleUrl));
+  for (; ; ) {
+    const candidate = (0, import_node_path.join)(directory, ASSETS_RELATIVE_PATH);
+    if ((0, import_node_fs.existsSync)(candidate)) {
+      return candidate;
+    }
+    const parent = (0, import_node_path.dirname)(directory);
+    if (parent === directory) {
+      throw new Error(`No ${ASSETS_RELATIVE_PATH} folder above ${(0, import_node_url.fileURLToPath)(moduleUrl)}.`);
+    }
+    directory = parent;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  API_COMPONENTS_IMPORT_PREFIX,
+  getDocsSiteAssetsDirectory
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL2RvY3Mtc2l0ZS9kb2NzLXNpdGUtYXNzZXRzLnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyJ2YXIgX19pbXBvcnRfbWV0YV91cmwgPSBnbG9iYWxUaGlzWydpbXBvcnQubWV0YS51cmwnXSA/PyAoZnVuY3Rpb24gZ2V0Q2pzSW1wb3J0TWV0YVVybCgpIHtcbiAgaWYgKHR5cGVvZiBfX2ZpbGVuYW1lID09PSAnc3RyaW5nJykge1xuICAgIGNvbnN0IGxvY2FsUmVxdWlyZSA9IHJlcXVpcmU7XG4gICAgY29uc3QgdXJsID0gbG9jYWxSZXF1aXJlKCdub2RlOnVybCcpO1xuICAgIGlmICh0eXBlb2YgdXJsLnBhdGhUb0ZpbGVVUkwgPT09ICdmdW5jdGlvbicpIHtcbiAgICAgIHJldHVybiB1cmwucGF0aFRvRmlsZVVSTChfX2ZpbGVuYW1lKS5ocmVmO1xuICAgIH1cbiAgfVxuXG4gIC8vIEZhbGxiYWNrIHRvIHRoZSBwYWdlIFVSTCwgb3IgYW4gZW1wdHkgc3RyaW5nIGlmIHRoZSBlbnZpcm9ubWVudCBpcyB1bmtub3duLlxuICByZXR1cm4gZ2xvYmFsVGhpcy5sb2NhdGlvbj8uaHJlZiA/PyAnJztcbn0pKCk7XG4vKipcbiAqIEBmaWxlXG4gKlxuICogTG9jYXRlcyB0aGUgZmlsZXMgZXZlcnkgZG9jdW1lbnRhdGlvbiBzaXRlIHNoYXJlcyBcdTIwMTQgdGhlIEFQSSBwYWdlIGNvbXBvbmVudHMsIHRoZSBzaXRlIHRpdGxlLCB0aGUgc3R5bGVzaGVldCBhbmRcbiAqIHRoZSBPcGVuIEdyYXBoIGZvbnRzIFx1MjAxNCB3aGljaCB0aGlzIHBhY2thZ2Ugc2hpcHMgdW5kZXIgYGFzc2V0cy9kb2NzLXNpdGVgIHJhdGhlciB0aGFuIGNvbXBpbGluZy5cbiAqL1xuXG5pbXBvcnQgeyBleGlzdHNTeW5jIH0gZnJvbSAnbm9kZTpmcyc7XG5pbXBvcnQge1xuICBkaXJuYW1lLFxuICBqb2luXG59IGZyb20gJ25vZGU6cGF0aCc7XG5pbXBvcnQgeyBmaWxlVVJMVG9QYXRoIH0gZnJvbSAnbm9kZTp1cmwnO1xuXG5jb25zdCBBU1NFVFNfUkVMQVRJVkVfUEFUSCA9IGpvaW4oJ2Fzc2V0cycsICdkb2NzLXNpdGUnKTtcblxuLyoqXG4gKiBUaGUgc3BlY2lmaWVyIGdlbmVyYXRlZCBBUEkgcGFnZXMgaW1wb3J0IHRoZWlyIGNvbXBvbmVudHMgdGhyb3VnaC4ge0BsaW5rIGdldERvY3NTaXRlQXNzZXRzRGlyZWN0b3J5fSdzIGBjb21wb25lbnRzYFxuICogZm9sZGVyIGlzIGFsaWFzZWQgdG8gaXQsIHNvIGV2ZXJ5IHNpdGUgcmVuZGVycyBpdHMgQVBJIHBhZ2VzIHdpdGggdGhlIHNhbWUgY29tcG9uZW50cy5cbiAqL1xuZXhwb3J0IGNvbnN0IEFQSV9DT01QT05FTlRTX0lNUE9SVF9QUkVGSVggPSAnQG1uYW91bW92L3R5cGVzY3JpcHQtZGV2LXRvb2xraXQvZG9jcy1zaXRlLWNvbXBvbmVudHMnO1xuXG4vKipcbiAqIEdldHMgdGhlIGZvbGRlciBob2xkaW5nIHRoZSBzaGFyZWQgc2l0ZSBmaWxlcy5cbiAqXG4gKiBUaGUgbW9kdWxlIHJ1bnMgZnJvbSBgc3JjL2RvY3Mtc2l0ZWAgaW4gdGhpcyByZXBvc2l0b3J5IGFuZCBmcm9tIGBkaXN0L2xpYi88Zm9ybWF0Pi9kb2NzLXNpdGVgIG9uY2UgaW5zdGFsbGVkLCBzb1xuICogdGhlIGZvbGRlciBpcyBmb3VuZCBieSB3YWxraW5nIHVwIHRvIHRoZSBwYWNrYWdlIHJvb3QgdGhhdCBob2xkcyBpdCByYXRoZXIgdGhhbiBieSBhIGZpeGVkIHJlbGF0aXZlIHBhdGguXG4gKlxuICogQHBhcmFtIG1vZHVsZVVybCAtIFRoZSBVUkwgb2YgYSBtb2R1bGUgb2YgdGhpcyBwYWNrYWdlIHRvIHN0YXJ0IGZyb20uXG4gKiBAcmV0dXJucyBUaGUgZm9sZGVyJ3MgYWJzb2x1dGUgcGF0aC5cbiAqIEB0aHJvd3MgSWYgbm8gZm9sZGVyIGFib3ZlIHRoZSBtb2R1bGUgaG9sZHMgdGhlIGFzc2V0cy5cbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIGdldERvY3NTaXRlQXNzZXRzRGlyZWN0b3J5KG1vZHVsZVVybDogc3RyaW5nID0gaW1wb3J0Lm1ldGEudXJsKTogc3RyaW5nIHtcbiAgbGV0IGRpcmVjdG9yeSA9IGRpcm5hbWUoZmlsZVVSTFRvUGF0aChtb2R1bGVVcmwpKTtcbiAgZm9yICg7Oykge1xuICAgIGNvbnN0IGNhbmRpZGF0ZSA9IGpvaW4oZGlyZWN0b3J5LCBBU1NFVFNfUkVMQVRJVkVfUEFUSCk7XG4gICAgaWYgKGV4aXN0c1N5bmMoY2FuZGlkYXRlKSkge1xuICAgICAgcmV0dXJuIGNhbmRpZGF0ZTtcbiAgICB9XG5cbiAgICBjb25zdCBwYXJlbnQgPSBkaXJuYW1lKGRpcmVjdG9yeSk7XG4gICAgaWYgKHBhcmVudCA9PT0gZGlyZWN0b3J5KSB7XG4gICAgICB0aHJvdyBuZXcgRXJyb3IoYE5vICR7QVNTRVRTX1JFTEFUSVZFX1BBVEh9IGZvbGRlciBhYm92ZSAke2ZpbGVVUkxUb1BhdGgobW9kdWxlVXJsKX0uYCk7XG4gICAgfVxuXG4gICAgZGlyZWN0b3J5ID0gcGFyZW50O1xuICB9XG59XG4iXSwKICAibWFwcGluZ3MiOiAiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQW1CQSxxQkFBMkI7QUFDM0IsdUJBR087QUFDUCxzQkFBOEI7QUF4QjlCLElBQUksb0JBQW9CLFdBQVcsaUJBQWlCLE1BQU0sU0FBUyxzQkFBc0I7QUFDdkYsTUFBSSxPQUFPLGVBQWUsVUFBVTtBQUNsQyxVQUFNLGVBQWU7QUFDckIsVUFBTSxNQUFNLGFBQWEsVUFBVTtBQUNuQyxRQUFJLE9BQU8sSUFBSSxrQkFBa0IsWUFBWTtBQUMzQyxhQUFPLElBQUksY0FBYyxVQUFVLEVBQUU7QUFBQSxJQUN2QztBQUFBLEVBQ0Y7QUFHQSxTQUFPLFdBQVcsVUFBVSxRQUFRO0FBQ3RDLEdBQUc7QUFlSCxNQUFNLDJCQUF1Qix1QkFBSyxVQUFVLFdBQVc7QUFNaEQsTUFBTSwrQkFBK0I7QUFZckMsU0FBUywyQkFBMkIsWUFBb0IsbUJBQXlCO0FBQ3RGLE1BQUksZ0JBQVksOEJBQVEsK0JBQWMsU0FBUyxDQUFDO0FBQ2hELGFBQVM7QUFDUCxVQUFNLGdCQUFZLHVCQUFLLFdBQVcsb0JBQW9CO0FBQ3RELFlBQUksMkJBQVcsU0FBUyxHQUFHO0FBQ3pCLGFBQU87QUFBQSxJQUNUO0FBRUEsVUFBTSxhQUFTLDBCQUFRLFNBQVM7QUFDaEMsUUFBSSxXQUFXLFdBQVc7QUFDeEIsWUFBTSxJQUFJLE1BQU0sTUFBTSxvQkFBb0IscUJBQWlCLCtCQUFjLFNBQVMsQ0FBQyxHQUFHO0FBQUEsSUFDeEY7QUFFQSxnQkFBWTtBQUFBLEVBQ2Q7QUFDRjsiLAogICJuYW1lcyI6IFtdCn0K

package/dist/lib/cjs/docs-site/docs-site-assets.d.cts

@@ -0,0 +1,23 @@
+/// <reference path="../library-references.d.cts" />
+/**
+ * @file
+ *
+ * Locates the files every documentation site shares — the API page components, the site title, the stylesheet and
+ * the Open Graph fonts — which this package ships under `assets/docs-site` rather than compiling.
+ */
+/**
+ * The specifier generated API pages import their components through. {@link getDocsSiteAssetsDirectory}'s `components`
+ * folder is aliased to it, so every site renders its API pages with the same components.
+ */
+export declare const API_COMPONENTS_IMPORT_PREFIX = "@mnaoumov/typescript-dev-toolkit/docs-site-components";
+/**
+ * Gets the folder holding the shared site files.
+ *
+ * The module runs from `src/docs-site` in this repository and from `dist/lib/<format>/docs-site` once installed, so
+ * the folder is found by walking up to the package root that holds it rather than by a fixed relative path.
+ *
+ * @param moduleUrl - The URL of a module of this package to start from.
+ * @returns The folder's absolute path.
+ * @throws If no folder above the module holds the assets.
+ */
+export declare function getDocsSiteAssetsDirectory(moduleUrl?: string): string;

package/dist/lib/cjs/docs-site/docs-site-commands.cjs

@@ -0,0 +1,72 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var docs_site_commands_exports = {};
+__export(docs_site_commands_exports, {
+  buildDocsSite: () => buildDocsSite,
+  devDocsSite: () => devDocsSite,
+  previewDocsSite: () => previewDocsSite
+});
+module.exports = __toCommonJS(docs_site_commands_exports);
+var import_node_path = require('node:path');
+var import_root = require('../root.cjs');
+var import_api_docs = require('./api-docs.cjs');
+var import_docs_links = require('./docs-links.cjs');
+var import_docs_site_assets = require('./docs-site-assets.cjs');
+var import_docs_site_config = require('./docs-site-config.cjs');
+var import_og_images = require('./og-images.cjs');
+async function buildDocsSite(config) {
+  const resolved = (0, import_docs_site_config.resolveDocsSiteConfig)(config);
+  await (0, import_api_docs.generateApiDocs)({ rootDirectory: resolved.rootDirectory, settings: resolved.apiDocSettings, sourceDirectory: resolved.sourceDirectory });
+  await (0, import_og_images.generateOgImages)({
+    brandText: resolved.packageName,
+    contentDocsDirectory: resolved.contentDocsDirectory,
+    faviconPath: resolved.faviconPath,
+    fontsDirectory: (0, import_node_path.join)((0, import_docs_site_assets.getDocsSiteAssetsDirectory)(), "fonts"),
+    outputDirectory: resolved.ogOutputDirectory
+  });
+  await (0, import_root.execFromRoot)(["astro", "build"], { cwd: resolved.rootDirectory });
+  await (0, import_docs_links.assertDocsLinksResolve)({ outputDirectory: resolved.distDirectory, siteBaseUrl: resolved.siteBaseUrl });
+}
+async function devDocsSite(config) {
+  const resolved = (0, import_docs_site_config.resolveDocsSiteConfig)(config);
+  await (0, import_api_docs.generateApiDocs)({ rootDirectory: resolved.rootDirectory, settings: resolved.apiDocSettings, sourceDirectory: resolved.sourceDirectory });
+  await (0, import_root.execFromRoot)(["astro", "dev"], {
+    cwd: resolved.rootDirectory,
+    env: {
+      ASTRO_DEV_BACKGROUND: "1"
+    },
+    isInteractive: true
+  });
+}
+async function previewDocsSite(config) {
+  const resolved = (0, import_docs_site_config.resolveDocsSiteConfig)(config);
+  await (0, import_root.execFromRoot)(["astro", "preview"], { cwd: resolved.rootDirectory, isInteractive: true });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  buildDocsSite,
+  devDocsSite,
+  previewDocsSite
+});
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL2RvY3Mtc2l0ZS9kb2NzLXNpdGUtY29tbWFuZHMudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qKlxuICogQGZpbGVcbiAqXG4gKiBUaGUgYGRvY3M6YnVpbGRgLCBgZG9jczpkZXZgIGFuZCBgZG9jczpwcmV2aWV3YCBjb21tYW5kcyBvZiBhIGRvY3VtZW50YXRpb24gc2l0ZS5cbiAqXG4gKiBFYWNoIHRha2VzIHRoZSBzYW1lIHtAbGluayBEb2NzU2l0ZUNvbmZpZ30gdGhlIHNpdGUncyBgYXN0cm8uY29uZmlnLnRzYCBwYXNzZXMgdG8gYGRlZmluZURvY3NTaXRlQ29uZmlnYCwgc28gYVxuICogcmVwb3NpdG9yeSBkZXNjcmliZXMgaXRzIHNpdGUgb25jZSwgaW4gYSBtb2R1bGUgYm90aCBpbXBvcnQuXG4gKi9cblxuaW1wb3J0IHsgam9pbiB9IGZyb20gJ25vZGU6cGF0aCc7XG5cbmltcG9ydCB0eXBlIHsgRG9jc1NpdGVDb25maWcgfSBmcm9tICcuL2RvY3Mtc2l0ZS1jb25maWcudHMnO1xuXG5pbXBvcnQgeyBleGVjRnJvbVJvb3QgfSBmcm9tICcuLi9yb290LnRzJztcbmltcG9ydCB7IGdlbmVyYXRlQXBpRG9jcyB9IGZyb20gJy4vYXBpLWRvY3MudHMnO1xuaW1wb3J0IHsgYXNzZXJ0RG9jc0xpbmtzUmVzb2x2ZSB9IGZyb20gJy4vZG9jcy1saW5rcy50cyc7XG5pbXBvcnQgeyBnZXREb2NzU2l0ZUFzc2V0c0RpcmVjdG9yeSB9IGZyb20gJy4vZG9jcy1zaXRlLWFzc2V0cy50cyc7XG5pbXBvcnQgeyByZXNvbHZlRG9jc1NpdGVDb25maWcgfSBmcm9tICcuL2RvY3Mtc2l0ZS1jb25maWcudHMnO1xuaW1wb3J0IHsgZ2VuZXJhdGVPZ0ltYWdlcyB9IGZyb20gJy4vb2ctaW1hZ2VzLnRzJztcblxuLyoqXG4gKiBCdWlsZHMgdGhlIHNpdGU6IGdlbmVyYXRlcyB0aGUgQVBJIHJlZmVyZW5jZSBhbmQgdGhlIE9wZW4gR3JhcGggY2FyZHMsIHJ1bnMgYGFzdHJvIGJ1aWxkYCwgdGhlbiBjaGVja3MgZXZlcnkgbGlua1xuICogb2YgdGhlIG91dHB1dC5cbiAqXG4gKiBAcGFyYW0gY29uZmlnIC0gVGhlIHNpdGUncyBjb25maWd1cmF0aW9uLlxuICovXG5leHBvcnQgYXN5bmMgZnVuY3Rpb24gYnVpbGREb2NzU2l0ZShjb25maWc6IERvY3NTaXRlQ29uZmlnKTogUHJvbWlzZTx2b2lkPiB7XG4gIGNvbnN0IHJlc29sdmVkID0gcmVzb2x2ZURvY3NTaXRlQ29uZmlnKGNvbmZpZyk7XG4gIGF3YWl0IGdlbmVyYXRlQXBpRG9jcyh7IHJvb3REaXJlY3Rvcnk6IHJlc29sdmVkLnJvb3REaXJlY3RvcnksIHNldHRpbmdzOiByZXNvbHZlZC5hcGlEb2NTZXR0aW5ncywgc291cmNlRGlyZWN0b3J5OiByZXNvbHZlZC5zb3VyY2VEaXJlY3RvcnkgfSk7XG4gIGF3YWl0IGdlbmVyYXRlT2dJbWFnZXMoe1xuICAgIGJyYW5kVGV4dDogcmVzb2x2ZWQucGFja2FnZU5hbWUsXG4gICAgY29udGVudERvY3NEaXJlY3Rvcnk6IHJlc29sdmVkLmNvbnRlbnREb2NzRGlyZWN0b3J5LFxuICAgIGZhdmljb25QYXRoOiByZXNvbHZlZC5mYXZpY29uUGF0aCxcbiAgICBmb250c0RpcmVjdG9yeTogam9pbihnZXREb2NzU2l0ZUFzc2V0c0RpcmVjdG9yeSgpLCAnZm9udHMnKSxcbiAgICBvdXRwdXREaXJlY3Rvcnk6IHJlc29sdmVkLm9nT3V0cHV0RGlyZWN0b3J5XG4gIH0pO1xuICBhd2FpdCBleGVjRnJvbVJvb3QoWydhc3RybycsICdidWlsZCddLCB7IGN3ZDogcmVzb2x2ZWQucm9vdERpcmVjdG9yeSB9KTtcbiAgYXdhaXQgYXNzZXJ0RG9jc0xpbmtzUmVzb2x2ZSh7IG91dHB1dERpcmVjdG9yeTogcmVzb2x2ZWQuZGlzdERpcmVjdG9yeSwgc2l0ZUJhc2VVcmw6IHJlc29sdmVkLnNpdGVCYXNlVXJsIH0pO1xufVxuXG4vKipcbiAqIEdlbmVyYXRlcyB0aGUgQVBJIHJlZmVyZW5jZSwgdGhlbiBzZXJ2ZXMgdGhlIHNpdGUgd2l0aCBgYXN0cm8gZGV2YCB1bnRpbCBpdCBpcyBzdG9wcGVkLlxuICpcbiAqIEBwYXJhbSBjb25maWcgLSBUaGUgc2l0ZSdzIGNvbmZpZ3VyYXRpb24uXG4gKi9cbmV4cG9ydCBhc3luYyBmdW5jdGlvbiBkZXZEb2NzU2l0ZShjb25maWc6IERvY3NTaXRlQ29uZmlnKTogUHJvbWlzZTx2b2lkPiB7XG4gIGNvbnN0IHJlc29sdmVkID0gcmVzb2x2ZURvY3NTaXRlQ29uZmlnKGNvbmZpZyk7XG4gIGF3YWl0IGdlbmVyYXRlQXBpRG9jcyh7IHJvb3REaXJlY3Rvcnk6IHJlc29sdmVkLnJvb3REaXJlY3RvcnksIHNldHRpbmdzOiByZXNvbHZlZC5hcGlEb2NTZXR0aW5ncywgc291cmNlRGlyZWN0b3J5OiByZXNvbHZlZC5zb3VyY2VEaXJlY3RvcnkgfSk7XG4gIC8vIGBBU1RST19ERVZfQkFDS0dST1VORGAgZm9yY2VzIEFzdHJvJ3MgZm9yZWdyb3VuZCBkZXYgc2VydmVyLiBBc3RybyBvdGhlcndpc2Ugc3dpdGNoZXMgdG8gYSBiYWNrZ3JvdW5kIGxhdW5jaGVyXG4gIC8vIChoYXJkY29kZWQgMzBzIHN0YXJ0dXAgdGltZW91dCkgdW5kZXIgYW4gYWdlbnQgLyBub24taW50ZXJhY3RpdmUgZW52aXJvbm1lbnQuXG4gIGF3YWl0IGV4ZWNGcm9tUm9vdChbJ2FzdHJvJywgJ2RldiddLCB7XG4gICAgY3dkOiByZXNvbHZlZC5yb290RGlyZWN0b3J5LFxuICAgIGVudjoge1xuICAgICAgQVNUUk9fREVWX0JBQ0tHUk9VTkQ6ICcxJ1xuICAgIH0sXG4gICAgaXNJbnRlcmFjdGl2ZTogdHJ1ZVxuICB9KTtcbn1cblxuLyoqXG4gKiBTZXJ2ZXMgdGhlIGxhc3QgYnVpbGQgd2l0aCBgYXN0cm8gcHJldmlld2AgdW50aWwgaXQgaXMgc3RvcHBlZC5cbiAqXG4gKiBAcGFyYW0gY29uZmlnIC0gVGhlIHNpdGUncyBjb25maWd1cmF0aW9uLlxuICovXG5leHBvcnQgYXN5bmMgZnVuY3Rpb24gcHJldmlld0RvY3NTaXRlKGNvbmZpZzogRG9jc1NpdGVDb25maWcpOiBQcm9taXNlPHZvaWQ+IHtcbiAgY29uc3QgcmVzb2x2ZWQgPSByZXNvbHZlRG9jc1NpdGVDb25maWcoY29uZmlnKTtcbiAgYXdhaXQgZXhlY0Zyb21Sb290KFsnYXN0cm8nLCAncHJldmlldyddLCB7IGN3ZDogcmVzb2x2ZWQucm9vdERpcmVjdG9yeSwgaXNJbnRlcmFjdGl2ZTogdHJ1ZSB9KTtcbn1cbiJdLAogICJtYXBwaW5ncyI6ICI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFTQSx1QkFBcUI7QUFJckIsa0JBQTZCO0FBQzdCLHNCQUFnQztBQUNoQyx3QkFBdUM7QUFDdkMsOEJBQTJDO0FBQzNDLDhCQUFzQztBQUN0Qyx1QkFBaUM7QUFRakMsZUFBc0IsY0FBYyxRQUF1QztBQUN6RSxRQUFNLGVBQVcsK0NBQXNCLE1BQU07QUFDN0MsWUFBTSxpQ0FBZ0IsRUFBRSxlQUFlLFNBQVMsZUFBZSxVQUFVLFNBQVMsZ0JBQWdCLGlCQUFpQixTQUFTLGdCQUFnQixDQUFDO0FBQzdJLFlBQU0sbUNBQWlCO0FBQUEsSUFDckIsV0FBVyxTQUFTO0FBQUEsSUFDcEIsc0JBQXNCLFNBQVM7QUFBQSxJQUMvQixhQUFhLFNBQVM7QUFBQSxJQUN0QixvQkFBZ0IsMkJBQUssb0RBQTJCLEdBQUcsT0FBTztBQUFBLElBQzFELGlCQUFpQixTQUFTO0FBQUEsRUFDNUIsQ0FBQztBQUNELFlBQU0sMEJBQWEsQ0FBQyxTQUFTLE9BQU8sR0FBRyxFQUFFLEtBQUssU0FBUyxjQUFjLENBQUM7QUFDdEUsWUFBTSwwQ0FBdUIsRUFBRSxpQkFBaUIsU0FBUyxlQUFlLGFBQWEsU0FBUyxZQUFZLENBQUM7QUFDN0c7QUFPQSxlQUFzQixZQUFZLFFBQXVDO0FBQ3ZFLFFBQU0sZUFBVywrQ0FBc0IsTUFBTTtBQUM3QyxZQUFNLGlDQUFnQixFQUFFLGVBQWUsU0FBUyxlQUFlLFVBQVUsU0FBUyxnQkFBZ0IsaUJBQWlCLFNBQVMsZ0JBQWdCLENBQUM7QUFHN0ksWUFBTSwwQkFBYSxDQUFDLFNBQVMsS0FBSyxHQUFHO0FBQUEsSUFDbkMsS0FBSyxTQUFTO0FBQUEsSUFDZCxLQUFLO0FBQUEsTUFDSCxzQkFBc0I7QUFBQSxJQUN4QjtBQUFBLElBQ0EsZUFBZTtBQUFBLEVBQ2pCLENBQUM7QUFDSDtBQU9BLGVBQXNCLGdCQUFnQixRQUF1QztBQUMzRSxRQUFNLGVBQVcsK0NBQXNCLE1BQU07QUFDN0MsWUFBTSwwQkFBYSxDQUFDLFNBQVMsU0FBUyxHQUFHLEVBQUUsS0FBSyxTQUFTLGVBQWUsZUFBZSxLQUFLLENBQUM7QUFDL0Y7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/cjs/docs-site/docs-site-commands.d.cts

@@ -0,0 +1,29 @@
+/// <reference path="../library-references.d.cts" />
+/**
+ * @file
+ *
+ * The `docs:build`, `docs:dev` and `docs:preview` commands of a documentation site.
+ *
+ * Each takes the same {@link DocsSiteConfig} the site's `astro.config.ts` passes to `defineDocsSiteConfig`, so a
+ * repository describes its site once, in a module both import.
+ */
+import type { DocsSiteConfig } from './docs-site-config.cjs';
+/**
+ * Builds the site: generates the API reference and the Open Graph cards, runs `astro build`, then checks every link
+ * of the output.
+ *
+ * @param config - The site's configuration.
+ */
+export declare function buildDocsSite(config: DocsSiteConfig): Promise<void>;
+/**
+ * Generates the API reference, then serves the site with `astro dev` until it is stopped.
+ *
+ * @param config - The site's configuration.
+ */
+export declare function devDocsSite(config: DocsSiteConfig): Promise<void>;
+/**
+ * Serves the last build with `astro preview` until it is stopped.
+ *
+ * @param config - The site's configuration.
+ */
+export declare function previewDocsSite(config: DocsSiteConfig): Promise<void>;