@mnaoumov/typescript-dev-toolkit 1.3.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (172) hide show
  1. package/assets/docs-site/components/ConstructorBlock.astro +16 -0
  2. package/assets/docs-site/components/ImportStatement.astro +12 -0
  3. package/assets/docs-site/components/MemberDetail.astro +101 -0
  4. package/assets/docs-site/components/MethodTable.astro +45 -0
  5. package/assets/docs-site/components/PropertyTable.astro +45 -0
  6. package/assets/docs-site/components/SiteTitle.astro +43 -0
  7. package/assets/docs-site/components/TypeSignature.astro +20 -0
  8. package/assets/docs-site/fonts/inter-latin-400-normal.ttf +0 -0
  9. package/assets/docs-site/fonts/inter-latin-700-normal.ttf +0 -0
  10. package/assets/docs-site/styles/global.css +221 -0
  11. package/dist/lib/cjs/build.cjs +1 -1
  12. package/dist/lib/cjs/build.d.cts +1 -1
  13. package/dist/lib/cjs/commitlint-forbidden-patterns.cjs +2 -2
  14. package/dist/lib/cjs/commitlint-forbidden-patterns.d.cts +1 -1
  15. package/dist/lib/cjs/commitlint-spellcheck-header.cjs +2 -2
  16. package/dist/lib/cjs/commitlint-spellcheck-header.d.cts +1 -1
  17. package/dist/lib/cjs/docs-site/api-doc-constants.cjs +171 -0
  18. package/dist/lib/cjs/docs-site/api-doc-constants.d.cts +18 -0
  19. package/dist/lib/cjs/docs-site/api-doc-jsdoc.cjs +414 -0
  20. package/dist/lib/cjs/docs-site/api-doc-jsdoc.d.cts +149 -0
  21. package/dist/lib/cjs/docs-site/api-doc-link-rendering.cjs +377 -0
  22. package/dist/lib/cjs/docs-site/api-doc-link-rendering.d.cts +185 -0
  23. package/dist/lib/cjs/docs-site/api-doc-package-sites.cjs +118 -0
  24. package/dist/lib/cjs/docs-site/api-doc-package-sites.d.cts +36 -0
  25. package/dist/lib/cjs/docs-site/api-doc-page-generation.cjs +561 -0
  26. package/dist/lib/cjs/docs-site/api-doc-page-generation.d.cts +159 -0
  27. package/dist/lib/cjs/docs-site/api-doc-route-segments.cjs +42 -0
  28. package/dist/lib/cjs/docs-site/api-doc-route-segments.d.cts +25 -0
  29. package/dist/lib/cjs/docs-site/api-doc-settings.cjs +47 -0
  30. package/dist/lib/cjs/docs-site/api-doc-settings.d.cts +53 -0
  31. package/dist/lib/cjs/docs-site/api-doc-source-processing.cjs +288 -0
  32. package/dist/lib/cjs/docs-site/api-doc-source-processing.d.cts +75 -0
  33. package/dist/lib/cjs/docs-site/api-doc-text-utils.cjs +281 -0
  34. package/dist/lib/cjs/docs-site/api-doc-text-utils.d.cts +178 -0
  35. package/dist/lib/cjs/docs-site/api-doc-type-merging.cjs +157 -0
  36. package/dist/lib/cjs/docs-site/api-doc-type-merging.d.cts +51 -0
  37. package/dist/lib/cjs/docs-site/api-doc-types.cjs +22 -0
  38. package/dist/lib/cjs/docs-site/api-doc-types.d.cts +157 -0
  39. package/dist/lib/cjs/docs-site/api-docs.cjs +143 -0
  40. package/dist/lib/cjs/docs-site/api-docs.d.cts +34 -0
  41. package/dist/lib/cjs/docs-site/astro-config.cjs +169 -0
  42. package/dist/lib/cjs/docs-site/astro-config.d.cts +23 -0
  43. package/dist/lib/cjs/docs-site/docs-links.cjs +123 -0
  44. package/dist/lib/cjs/docs-site/docs-links.d.cts +32 -0
  45. package/dist/lib/cjs/docs-site/docs-site-assets.cjs +64 -0
  46. package/dist/lib/cjs/docs-site/docs-site-assets.d.cts +23 -0
  47. package/dist/lib/cjs/docs-site/docs-site-commands.cjs +72 -0
  48. package/dist/lib/cjs/docs-site/docs-site-commands.d.cts +29 -0
  49. package/dist/lib/cjs/docs-site/docs-site-config.cjs +122 -0
  50. package/dist/lib/cjs/docs-site/docs-site-config.d.cts +162 -0
  51. package/dist/lib/cjs/docs-site/index.cjs +116 -0
  52. package/dist/lib/cjs/docs-site/index.d.cts +26 -0
  53. package/dist/lib/cjs/docs-site/link-check.cjs +197 -0
  54. package/dist/lib/cjs/docs-site/link-check.d.cts +163 -0
  55. package/dist/lib/cjs/docs-site/og-image-page.cjs +45 -0
  56. package/dist/lib/cjs/docs-site/og-image-page.d.cts +15 -0
  57. package/dist/lib/cjs/docs-site/og-image.cjs +326 -0
  58. package/dist/lib/cjs/docs-site/og-image.d.cts +70 -0
  59. package/dist/lib/cjs/docs-site/og-images.cjs +170 -0
  60. package/dist/lib/cjs/docs-site/og-images.d.cts +41 -0
  61. package/dist/lib/cjs/docs-site/route-data.cjs +47 -0
  62. package/dist/lib/cjs/docs-site/route-data.d.cts +14 -0
  63. package/dist/lib/cjs/docs-site/satteri-github-alerts.cjs +97 -0
  64. package/dist/lib/cjs/docs-site/satteri-github-alerts.d.cts +31 -0
  65. package/dist/lib/cjs/docs-site/satteri-relative-links.cjs +87 -0
  66. package/dist/lib/cjs/docs-site/satteri-relative-links.d.cts +29 -0
  67. package/dist/lib/cjs/docs-site/unrendered-alerts.cjs +51 -0
  68. package/dist/lib/cjs/docs-site/unrendered-alerts.d.cts +38 -0
  69. package/dist/lib/cjs/index.cjs +4 -1
  70. package/dist/lib/cjs/index.d.cts +1 -0
  71. package/dist/lib/cjs/library-build.cjs +1 -1
  72. package/dist/lib/cjs/library-build.d.cts +2 -2
  73. package/dist/lib/cjs/linters/eslint-config.cjs +17 -17
  74. package/dist/lib/cjs/linters/eslint-config.d.cts +1 -7
  75. package/dist/lib/cjs/linters/eslint-rules/in-house-plugin.cjs +2 -2
  76. package/dist/lib/cjs/linters/eslint-rules/in-house-plugin.d.cts +5 -8
  77. package/dist/lib/cjs/package-manager.cjs +2 -2
  78. package/dist/lib/esm/build.d.mts +1 -1
  79. package/dist/lib/esm/build.mjs +1 -1
  80. package/dist/lib/esm/commitlint-forbidden-patterns.d.mts +1 -1
  81. package/dist/lib/esm/commitlint-forbidden-patterns.mjs +2 -2
  82. package/dist/lib/esm/commitlint-spellcheck-header.d.mts +1 -1
  83. package/dist/lib/esm/commitlint-spellcheck-header.mjs +2 -2
  84. package/dist/lib/esm/docs-site/api-doc-constants.d.mts +18 -0
  85. package/dist/lib/esm/docs-site/api-doc-constants.mjs +143 -0
  86. package/dist/lib/esm/docs-site/api-doc-jsdoc.d.mts +149 -0
  87. package/dist/lib/esm/docs-site/api-doc-jsdoc.mjs +377 -0
  88. package/dist/lib/esm/docs-site/api-doc-link-rendering.d.mts +185 -0
  89. package/dist/lib/esm/docs-site/api-doc-link-rendering.mjs +356 -0
  90. package/dist/lib/esm/docs-site/api-doc-package-sites.d.mts +36 -0
  91. package/dist/lib/esm/docs-site/api-doc-package-sites.mjs +91 -0
  92. package/dist/lib/esm/docs-site/api-doc-page-generation.d.mts +159 -0
  93. package/dist/lib/esm/docs-site/api-doc-page-generation.mjs +548 -0
  94. package/dist/lib/esm/docs-site/api-doc-route-segments.d.mts +25 -0
  95. package/dist/lib/esm/docs-site/api-doc-route-segments.mjs +17 -0
  96. package/dist/lib/esm/docs-site/api-doc-settings.d.mts +53 -0
  97. package/dist/lib/esm/docs-site/api-doc-settings.mjs +22 -0
  98. package/dist/lib/esm/docs-site/api-doc-source-processing.d.mts +75 -0
  99. package/dist/lib/esm/docs-site/api-doc-source-processing.mjs +274 -0
  100. package/dist/lib/esm/docs-site/api-doc-text-utils.d.mts +178 -0
  101. package/dist/lib/esm/docs-site/api-doc-text-utils.mjs +239 -0
  102. package/dist/lib/esm/docs-site/api-doc-type-merging.d.mts +51 -0
  103. package/dist/lib/esm/docs-site/api-doc-type-merging.mjs +129 -0
  104. package/dist/lib/esm/docs-site/api-doc-types.d.mts +157 -0
  105. package/dist/lib/esm/docs-site/api-doc-types.mjs +6 -0
  106. package/dist/lib/esm/docs-site/api-docs.d.mts +34 -0
  107. package/dist/lib/esm/docs-site/api-docs.mjs +139 -0
  108. package/dist/lib/esm/docs-site/astro-config.d.mts +23 -0
  109. package/dist/lib/esm/docs-site/astro-config.mjs +135 -0
  110. package/dist/lib/esm/docs-site/docs-links.d.mts +32 -0
  111. package/dist/lib/esm/docs-site/docs-links.mjs +113 -0
  112. package/dist/lib/esm/docs-site/docs-site-assets.d.mts +23 -0
  113. package/dist/lib/esm/docs-site/docs-site-assets.mjs +32 -0
  114. package/dist/lib/esm/docs-site/docs-site-commands.d.mts +29 -0
  115. package/dist/lib/esm/docs-site/docs-site-commands.mjs +46 -0
  116. package/dist/lib/esm/docs-site/docs-site-config.d.mts +162 -0
  117. package/dist/lib/esm/docs-site/docs-site-config.mjs +98 -0
  118. package/dist/lib/esm/docs-site/index.d.mts +26 -0
  119. package/dist/lib/esm/docs-site/index.mjs +58 -0
  120. package/dist/lib/esm/docs-site/link-check.d.mts +163 -0
  121. package/dist/lib/esm/docs-site/link-check.mjs +166 -0
  122. package/dist/lib/esm/docs-site/og-image-page.d.mts +15 -0
  123. package/dist/lib/esm/docs-site/og-image-page.mjs +21 -0
  124. package/dist/lib/esm/docs-site/og-image.d.mts +70 -0
  125. package/dist/lib/esm/docs-site/og-image.mjs +292 -0
  126. package/dist/lib/esm/docs-site/og-images.d.mts +41 -0
  127. package/dist/lib/esm/docs-site/og-images.mjs +156 -0
  128. package/dist/lib/esm/docs-site/route-data.d.mts +14 -0
  129. package/dist/lib/esm/docs-site/route-data.mjs +23 -0
  130. package/dist/lib/esm/docs-site/satteri-github-alerts.d.mts +31 -0
  131. package/dist/lib/esm/docs-site/satteri-github-alerts.mjs +72 -0
  132. package/dist/lib/esm/docs-site/satteri-relative-links.d.mts +29 -0
  133. package/dist/lib/esm/docs-site/satteri-relative-links.mjs +63 -0
  134. package/dist/lib/esm/docs-site/unrendered-alerts.d.mts +38 -0
  135. package/dist/lib/esm/docs-site/unrendered-alerts.mjs +26 -0
  136. package/dist/lib/esm/index.d.mts +1 -0
  137. package/dist/lib/esm/index.mjs +3 -1
  138. package/dist/lib/esm/library-build.d.mts +2 -2
  139. package/dist/lib/esm/library-build.mjs +1 -1
  140. package/dist/lib/esm/linters/eslint-config.d.mts +1 -7
  141. package/dist/lib/esm/linters/eslint-config.mjs +17 -17
  142. package/dist/lib/esm/linters/eslint-rules/in-house-plugin.d.mts +5 -8
  143. package/dist/lib/esm/linters/eslint-rules/in-house-plugin.mjs +2 -2
  144. package/dist/lib/esm/package-manager.mjs +2 -2
  145. package/docs-site/api-doc-constants/package.json +6 -0
  146. package/docs-site/api-doc-jsdoc/package.json +6 -0
  147. package/docs-site/api-doc-link-rendering/package.json +6 -0
  148. package/docs-site/api-doc-package-sites/package.json +6 -0
  149. package/docs-site/api-doc-page-generation/package.json +6 -0
  150. package/docs-site/api-doc-route-segments/package.json +6 -0
  151. package/docs-site/api-doc-settings/package.json +6 -0
  152. package/docs-site/api-doc-source-processing/package.json +6 -0
  153. package/docs-site/api-doc-text-utils/package.json +6 -0
  154. package/docs-site/api-doc-type-merging/package.json +6 -0
  155. package/docs-site/api-doc-types/package.json +6 -0
  156. package/docs-site/api-docs/package.json +6 -0
  157. package/docs-site/astro-config/package.json +6 -0
  158. package/docs-site/docs-links/package.json +6 -0
  159. package/docs-site/docs-site-assets/package.json +6 -0
  160. package/docs-site/docs-site-commands/package.json +6 -0
  161. package/docs-site/docs-site-config/package.json +6 -0
  162. package/docs-site/index/package.json +6 -0
  163. package/docs-site/link-check/package.json +6 -0
  164. package/docs-site/og-image/package.json +6 -0
  165. package/docs-site/og-image-page/package.json +6 -0
  166. package/docs-site/og-images/package.json +6 -0
  167. package/docs-site/package.json +6 -0
  168. package/docs-site/route-data/package.json +6 -0
  169. package/docs-site/satteri-github-alerts/package.json +6 -0
  170. package/docs-site/satteri-relative-links/package.json +6 -0
  171. package/docs-site/unrendered-alerts/package.json +6 -0
  172. package/package.json +74 -4
@@ -0,0 +1,122 @@
1
+ /*
2
+ THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
3
+ if you want to view the source, please visit the github repository of this plugin
4
+ */
5
+ (function () {
6
+ function ensureBrowserProcess() {
7
+ const browserProcess = {
8
+ browser: true,
9
+ cwd() {
10
+ return '/';
11
+ },
12
+ env: {},
13
+ platform: 'android'
14
+ };
15
+
16
+ const existingProcess = globalThis.process;
17
+
18
+ if (!existingProcess) {
19
+ globalThis.process = browserProcess;
20
+ return;
21
+ }
22
+
23
+ if (existingProcess.versions?.node) {
24
+ return;
25
+ }
26
+
27
+ const existingProcessRecord = existingProcess;
28
+
29
+ for (const [key, value] of Object.entries(browserProcess)) {
30
+ existingProcessRecord[key] ??= value;
31
+ }
32
+
33
+ existingProcessRecord['browser'] = true;
34
+ }
35
+
36
+ ensureBrowserProcess();
37
+ })();
38
+
39
+ "use strict";
40
+ var __defProp = Object.defineProperty;
41
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
42
+ var __getOwnPropNames = Object.getOwnPropertyNames;
43
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
44
+ var __export = (target, all) => {
45
+ for (var name in all)
46
+ __defProp(target, name, { get: all[name], enumerable: true });
47
+ };
48
+ var __copyProps = (to, from, except, desc) => {
49
+ if (from && typeof from === "object" || typeof from === "function") {
50
+ for (let key of __getOwnPropNames(from))
51
+ if (!__hasOwnProp.call(to, key) && key !== except)
52
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
53
+ }
54
+ return to;
55
+ };
56
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
57
+ var docs_site_config_exports = {};
58
+ __export(docs_site_config_exports, {
59
+ resolveDocsSiteConfig: () => resolveDocsSiteConfig
60
+ });
61
+ module.exports = __toCommonJS(docs_site_config_exports);
62
+ var import_node_fs = require('node:fs');
63
+ var import_node_path = require('node:path');
64
+ var import_api_doc_package_sites = require('./api-doc-package-sites.cjs');
65
+ function resolveDocsSiteConfig(config) {
66
+ const {
67
+ docsDirectory = "docs",
68
+ externalTypeLinks = /* @__PURE__ */ new Map(),
69
+ guidesDirectory = "guides",
70
+ owner = "mnaoumov",
71
+ packageSites = import_api_doc_package_sites.DEFAULT_PACKAGE_SITES,
72
+ repo,
73
+ rootDirectory = process.cwd(),
74
+ siteOrigin = "https://mnaoumov.dev",
75
+ sourceDirectory = "src",
76
+ title
77
+ } = config;
78
+ const packageJson = JSON.parse((0, import_node_fs.readFileSync)((0, import_node_path.join)(rootDirectory, "package.json"), "utf-8"));
79
+ if (packageJson.name === void 0 || packageJson.version === void 0) {
80
+ throw new Error(`${(0, import_node_path.join)(rootDirectory, "package.json")} has no name or no version.`);
81
+ }
82
+ const absoluteDocsDirectory = (0, import_node_path.join)(rootDirectory, docsDirectory);
83
+ const docsSourceDirectory = (0, import_node_path.join)(absoluteDocsDirectory, "src");
84
+ const contentDocsDirectory = (0, import_node_path.join)(docsSourceDirectory, "content", "docs");
85
+ const publicDirectory = (0, import_node_path.join)(absoluteDocsDirectory, "public");
86
+ const githubUrl = `https://github.com/${owner}/${repo}`;
87
+ const basePath = `/${repo}`;
88
+ return {
89
+ apiDocSettings: {
90
+ basePath,
91
+ externalTypeLinks,
92
+ outputDirectory: (0, import_node_path.join)(contentDocsDirectory, "api"),
93
+ packageName: packageJson.name,
94
+ packageSites,
95
+ sidebarFile: (0, import_node_path.join)(docsSourceDirectory, "generated-sidebar.json")
96
+ },
97
+ basePath,
98
+ contentDocsDirectory,
99
+ distDirectory: (0, import_node_path.join)(absoluteDocsDirectory, "dist"),
100
+ docsDirectory: absoluteDocsDirectory,
101
+ docsSourceDirectory,
102
+ editLinkBaseUrl: `${githubUrl}/edit/main/`,
103
+ faviconPath: (0, import_node_path.join)(publicDirectory, "favicon.svg"),
104
+ githubUrl,
105
+ guidesDirectory,
106
+ ogOutputDirectory: (0, import_node_path.join)(publicDirectory, "og"),
107
+ packageName: packageJson.name,
108
+ packageVersion: packageJson.version,
109
+ publicDirectory,
110
+ repo,
111
+ rootDirectory,
112
+ siteBaseUrl: `${siteOrigin}/${repo}/`,
113
+ siteOrigin,
114
+ sourceDirectory: (0, import_node_path.join)(rootDirectory, sourceDirectory),
115
+ title
116
+ };
117
+ }
118
+ // Annotate the CommonJS export names for ESM import in node:
119
+ 0 && (module.exports = {
120
+ resolveDocsSiteConfig
121
+ });
122
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["../../../../src/docs-site/docs-site-config.ts"],"sourcesContent":["/**\n * @file\n *\n * The one description of a documentation site that its Astro config and its build commands share: which repository\n * it documents, where its sources and pages live, and which other sites it links to.\n */\n\nimport { readFileSync } from 'node:fs';\nimport { join } from 'node:path';\n\nimport type { ApiDocSettings } from './api-doc-settings.ts';\n\nimport { DEFAULT_PACKAGE_SITES } from './api-doc-package-sites.ts';\n\n/**\n * Describes a documentation site. Every path is relative to {@link DocsSiteConfig.rootDirectory}.\n */\nexport interface DocsSiteConfig {\n  /**\n   * The folder holding the site: its `src` (pages, `content.config.ts`), `public` and build output `dist`.\n   *\n   * @default 'docs'\n   */\n  readonly docsDirectory?: string;\n\n  /**\n   * Type names mapped to the URL their references link to, for types no documented package declares. The layer\n   * documenting an ecosystem's packages fills it with that ecosystem's references.\n   */\n  readonly externalTypeLinks?: ReadonlyMap<string, string>;\n\n  /**\n   * The folder under `<docs>/src/content/docs` the guides sidebar group is generated from.\n   *\n   * @default 'guides'\n   */\n  readonly guidesDirectory?: string;\n\n  /**\n   * The GitHub account the repository belongs to.\n   *\n   * @default 'mnaoumov'\n   */\n  readonly owner?: string;\n\n  /**\n   * Package names mapped to the root URL of their documentation site, with a trailing slash. A type declared in one\n   * of them links to its page there. The documented package itself is never linked this way.\n   *\n   * @default DEFAULT_PACKAGE_SITES\n   */\n  readonly packageSites?: ReadonlyMap<string, string>;\n\n  /**\n   * The repository's name. The site is served under it: `<siteOrigin>/<repo>/`.\n   */\n  readonly repo: string;\n\n  /**\n   * The repository root, holding `package.json`, `tsconfig.json` and `node_modules`.\n   *\n   * @default process.cwd()\n   */\n  readonly rootDirectory?: string;\n\n  /**\n   * The origin every site of the account is served from.\n   *\n   * @default 'https://mnaoumov.dev'\n   */\n  readonly siteOrigin?: string;\n\n  /**\n   * The folder whose modules the API reference documents.\n   *\n   * @default 'src'\n   */\n  readonly sourceDirectory?: string;\n\n  /**\n   * The site's title, shown in its header.\n   */\n  readonly title: string;\n}\n\n/**\n * {@link DocsSiteConfig} with every default applied, every path absolute, and the values derived from them.\n */\nexport interface ResolvedDocsSiteConfig {\n  /**\n   * The API documentation generator's settings for the site.\n   */\n  readonly apiDocSettings: ApiDocSettings;\n\n  /**\n   * The base path, e.g. `/typescript-lib`.\n   */\n  readonly basePath: string;\n\n  /**\n   * The documentation content root, `<docs>/src/content/docs`.\n   */\n  readonly contentDocsDirectory: string;\n\n  /**\n   * The build output folder, `<docs>/dist`.\n   */\n  readonly distDirectory: string;\n\n  /**\n   * The site folder.\n   */\n  readonly docsDirectory: string;\n\n  /**\n   * The site's source folder, `<docs>/src`.\n   */\n  readonly docsSourceDirectory: string;\n\n  /**\n   * The URL a page's edit link starts with: the repository's `edit/main/` tree.\n   */\n  readonly editLinkBaseUrl: string;\n\n  /**\n   * The site's SVG logo, `<docs>/public/favicon.svg`.\n   */\n  readonly faviconPath: string;\n\n  /**\n   * The repository's GitHub URL.\n   */\n  readonly githubUrl: string;\n\n  /**\n   * See {@link DocsSiteConfig.guidesDirectory}.\n   */\n  readonly guidesDirectory: string;\n\n  /**\n   * The folder the Open Graph cards are written to, `<docs>/public/og`.\n   */\n  readonly ogOutputDirectory: string;\n\n  /**\n   * The documented package's name, read from the root `package.json`.\n   */\n  readonly packageName: string;\n\n  /**\n   * The documented package's version, read from the root `package.json`.\n   */\n  readonly packageVersion: string;\n\n  /**\n   * The site's static folder, `<docs>/public`.\n   */\n  readonly publicDirectory: string;\n\n  /**\n   * See {@link DocsSiteConfig.repo}.\n   */\n  readonly repo: string;\n\n  /**\n   * See {@link DocsSiteConfig.rootDirectory}.\n   */\n  readonly rootDirectory: string;\n\n  /**\n   * The absolute URL the site is served from, with a trailing slash.\n   */\n  readonly siteBaseUrl: string;\n\n  /**\n   * See {@link DocsSiteConfig.siteOrigin}.\n   */\n  readonly siteOrigin: string;\n\n  /**\n   * See {@link DocsSiteConfig.sourceDirectory}.\n   */\n  readonly sourceDirectory: string;\n\n  /**\n   * See {@link DocsSiteConfig.title}.\n   */\n  readonly title: string;\n}\n\ninterface PackageJsonFields {\n  readonly name?: string;\n  readonly version?: string;\n}\n\n/**\n * Applies the defaults to a site's options and derives every path and URL from them.\n *\n * @param config - The site's configuration.\n * @returns The resolved configuration.\n * @throws If the root `package.json` has no `name` or `version`.\n */\nexport function resolveDocsSiteConfig(config: DocsSiteConfig): ResolvedDocsSiteConfig {\n  const {\n    docsDirectory = 'docs',\n    externalTypeLinks = new Map<string, string>(),\n    guidesDirectory = 'guides',\n    owner = 'mnaoumov',\n    packageSites = DEFAULT_PACKAGE_SITES,\n    repo,\n    rootDirectory = process.cwd(),\n    siteOrigin = 'https://mnaoumov.dev',\n    sourceDirectory = 'src',\n    title\n  } = config;\n\n  const packageJson = JSON.parse(readFileSync(join(rootDirectory, 'package.json'), 'utf-8')) as PackageJsonFields;\n  if (packageJson.name === undefined || packageJson.version === undefined) {\n    throw new Error(`${join(rootDirectory, 'package.json')} has no name or no version.`);\n  }\n\n  const absoluteDocsDirectory = join(rootDirectory, docsDirectory);\n  const docsSourceDirectory = join(absoluteDocsDirectory, 'src');\n  const contentDocsDirectory = join(docsSourceDirectory, 'content', 'docs');\n  const publicDirectory = join(absoluteDocsDirectory, 'public');\n  const githubUrl = `https://github.com/${owner}/${repo}`;\n\n  const basePath = `/${repo}`;\n  return {\n    apiDocSettings: {\n      basePath,\n      externalTypeLinks,\n      outputDirectory: join(contentDocsDirectory, 'api'),\n      packageName: packageJson.name,\n      packageSites,\n      sidebarFile: join(docsSourceDirectory, 'generated-sidebar.json')\n    },\n    basePath,\n    contentDocsDirectory,\n    distDirectory: join(absoluteDocsDirectory, 'dist'),\n    docsDirectory: absoluteDocsDirectory,\n    docsSourceDirectory,\n    editLinkBaseUrl: `${githubUrl}/edit/main/`,\n    faviconPath: join(publicDirectory, 'favicon.svg'),\n    githubUrl,\n    guidesDirectory,\n    ogOutputDirectory: join(publicDirectory, 'og'),\n    packageName: packageJson.name,\n    packageVersion: packageJson.version,\n    publicDirectory,\n    repo,\n    rootDirectory,\n    siteBaseUrl: `${siteOrigin}/${repo}/`,\n    siteOrigin,\n    sourceDirectory: join(rootDirectory, sourceDirectory),\n    title\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAOA,qBAA6B;AAC7B,uBAAqB;AAIrB,mCAAsC;AA8L/B,SAAS,sBAAsB,QAAgD;AACpF,QAAM;AAAA,IACJ,gBAAgB;AAAA,IAChB,oBAAoB,oBAAI,IAAoB;AAAA,IAC5C,kBAAkB;AAAA,IAClB,QAAQ;AAAA,IACR,eAAe;AAAA,IACf;AAAA,IACA,gBAAgB,QAAQ,IAAI;AAAA,IAC5B,aAAa;AAAA,IACb,kBAAkB;AAAA,IAClB;AAAA,EACF,IAAI;AAEJ,QAAM,cAAc,KAAK,UAAM,iCAAa,uBAAK,eAAe,cAAc,GAAG,OAAO,CAAC;AACzF,MAAI,YAAY,SAAS,UAAa,YAAY,YAAY,QAAW;AACvE,UAAM,IAAI,MAAM,OAAG,uBAAK,eAAe,cAAc,CAAC,6BAA6B;AAAA,EACrF;AAEA,QAAM,4BAAwB,uBAAK,eAAe,aAAa;AAC/D,QAAM,0BAAsB,uBAAK,uBAAuB,KAAK;AAC7D,QAAM,2BAAuB,uBAAK,qBAAqB,WAAW,MAAM;AACxE,QAAM,sBAAkB,uBAAK,uBAAuB,QAAQ;AAC5D,QAAM,YAAY,sBAAsB,KAAK,IAAI,IAAI;AAErD,QAAM,WAAW,IAAI,IAAI;AACzB,SAAO;AAAA,IACL,gBAAgB;AAAA,MACd;AAAA,MACA;AAAA,MACA,qBAAiB,uBAAK,sBAAsB,KAAK;AAAA,MACjD,aAAa,YAAY;AAAA,MACzB;AAAA,MACA,iBAAa,uBAAK,qBAAqB,wBAAwB;AAAA,IACjE;AAAA,IACA;AAAA,IACA;AAAA,IACA,mBAAe,uBAAK,uBAAuB,MAAM;AAAA,IACjD,eAAe;AAAA,IACf;AAAA,IACA,iBAAiB,GAAG,SAAS;AAAA,IAC7B,iBAAa,uBAAK,iBAAiB,aAAa;AAAA,IAChD;AAAA,IACA;AAAA,IACA,uBAAmB,uBAAK,iBAAiB,IAAI;AAAA,IAC7C,aAAa,YAAY;AAAA,IACzB,gBAAgB,YAAY;AAAA,IAC5B;AAAA,IACA;AAAA,IACA;AAAA,IACA,aAAa,GAAG,UAAU,IAAI,IAAI;AAAA,IAClC;AAAA,IACA,qBAAiB,uBAAK,eAAe,eAAe;AAAA,IACpD;AAAA,EACF;AACF;","names":[]}
@@ -0,0 +1,162 @@
1
+ /// <reference path="../library-references.d.cts" />
2
+ /**
3
+ * @file
4
+ *
5
+ * The one description of a documentation site that its Astro config and its build commands share: which repository
6
+ * it documents, where its sources and pages live, and which other sites it links to.
7
+ */
8
+ import type { ApiDocSettings } from './api-doc-settings.cjs';
9
+ /**
10
+ * Describes a documentation site. Every path is relative to {@link DocsSiteConfig.rootDirectory}.
11
+ */
12
+ export interface DocsSiteConfig {
13
+ /**
14
+ * The folder holding the site: its `src` (pages, `content.config.ts`), `public` and build output `dist`.
15
+ *
16
+ * @default 'docs'
17
+ */
18
+ readonly docsDirectory?: string;
19
+ /**
20
+ * Type names mapped to the URL their references link to, for types no documented package declares. The layer
21
+ * documenting an ecosystem's packages fills it with that ecosystem's references.
22
+ */
23
+ readonly externalTypeLinks?: ReadonlyMap<string, string>;
24
+ /**
25
+ * The folder under `<docs>/src/content/docs` the guides sidebar group is generated from.
26
+ *
27
+ * @default 'guides'
28
+ */
29
+ readonly guidesDirectory?: string;
30
+ /**
31
+ * The GitHub account the repository belongs to.
32
+ *
33
+ * @default 'mnaoumov'
34
+ */
35
+ readonly owner?: string;
36
+ /**
37
+ * Package names mapped to the root URL of their documentation site, with a trailing slash. A type declared in one
38
+ * of them links to its page there. The documented package itself is never linked this way.
39
+ *
40
+ * @default DEFAULT_PACKAGE_SITES
41
+ */
42
+ readonly packageSites?: ReadonlyMap<string, string>;
43
+ /**
44
+ * The repository's name. The site is served under it: `<siteOrigin>/<repo>/`.
45
+ */
46
+ readonly repo: string;
47
+ /**
48
+ * The repository root, holding `package.json`, `tsconfig.json` and `node_modules`.
49
+ *
50
+ * @default process.cwd()
51
+ */
52
+ readonly rootDirectory?: string;
53
+ /**
54
+ * The origin every site of the account is served from.
55
+ *
56
+ * @default 'https://mnaoumov.dev'
57
+ */
58
+ readonly siteOrigin?: string;
59
+ /**
60
+ * The folder whose modules the API reference documents.
61
+ *
62
+ * @default 'src'
63
+ */
64
+ readonly sourceDirectory?: string;
65
+ /**
66
+ * The site's title, shown in its header.
67
+ */
68
+ readonly title: string;
69
+ }
70
+ /**
71
+ * {@link DocsSiteConfig} with every default applied, every path absolute, and the values derived from them.
72
+ */
73
+ export interface ResolvedDocsSiteConfig {
74
+ /**
75
+ * The API documentation generator's settings for the site.
76
+ */
77
+ readonly apiDocSettings: ApiDocSettings;
78
+ /**
79
+ * The base path, e.g. `/typescript-lib`.
80
+ */
81
+ readonly basePath: string;
82
+ /**
83
+ * The documentation content root, `<docs>/src/content/docs`.
84
+ */
85
+ readonly contentDocsDirectory: string;
86
+ /**
87
+ * The build output folder, `<docs>/dist`.
88
+ */
89
+ readonly distDirectory: string;
90
+ /**
91
+ * The site folder.
92
+ */
93
+ readonly docsDirectory: string;
94
+ /**
95
+ * The site's source folder, `<docs>/src`.
96
+ */
97
+ readonly docsSourceDirectory: string;
98
+ /**
99
+ * The URL a page's edit link starts with: the repository's `edit/main/` tree.
100
+ */
101
+ readonly editLinkBaseUrl: string;
102
+ /**
103
+ * The site's SVG logo, `<docs>/public/favicon.svg`.
104
+ */
105
+ readonly faviconPath: string;
106
+ /**
107
+ * The repository's GitHub URL.
108
+ */
109
+ readonly githubUrl: string;
110
+ /**
111
+ * See {@link DocsSiteConfig.guidesDirectory}.
112
+ */
113
+ readonly guidesDirectory: string;
114
+ /**
115
+ * The folder the Open Graph cards are written to, `<docs>/public/og`.
116
+ */
117
+ readonly ogOutputDirectory: string;
118
+ /**
119
+ * The documented package's name, read from the root `package.json`.
120
+ */
121
+ readonly packageName: string;
122
+ /**
123
+ * The documented package's version, read from the root `package.json`.
124
+ */
125
+ readonly packageVersion: string;
126
+ /**
127
+ * The site's static folder, `<docs>/public`.
128
+ */
129
+ readonly publicDirectory: string;
130
+ /**
131
+ * See {@link DocsSiteConfig.repo}.
132
+ */
133
+ readonly repo: string;
134
+ /**
135
+ * See {@link DocsSiteConfig.rootDirectory}.
136
+ */
137
+ readonly rootDirectory: string;
138
+ /**
139
+ * The absolute URL the site is served from, with a trailing slash.
140
+ */
141
+ readonly siteBaseUrl: string;
142
+ /**
143
+ * See {@link DocsSiteConfig.siteOrigin}.
144
+ */
145
+ readonly siteOrigin: string;
146
+ /**
147
+ * See {@link DocsSiteConfig.sourceDirectory}.
148
+ */
149
+ readonly sourceDirectory: string;
150
+ /**
151
+ * See {@link DocsSiteConfig.title}.
152
+ */
153
+ readonly title: string;
154
+ }
155
+ /**
156
+ * Applies the defaults to a site's options and derives every path and URL from them.
157
+ *
158
+ * @param config - The site's configuration.
159
+ * @returns The resolved configuration.
160
+ * @throws If the root `package.json` has no `name` or `version`.
161
+ */
162
+ export declare function resolveDocsSiteConfig(config: DocsSiteConfig): ResolvedDocsSiteConfig;
@@ -0,0 +1,116 @@
1
+ /*
2
+ THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
3
+ if you want to view the source, please visit the github repository of this plugin
4
+ */
5
+
6
+ "use strict";
7
+ var __create = Object.create;
8
+ var __defProp = Object.defineProperty;
9
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
10
+ var __getOwnPropNames = Object.getOwnPropertyNames;
11
+ var __getProtoOf = Object.getPrototypeOf;
12
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
13
+ var __export = (target, all) => {
14
+ for (var name in all)
15
+ __defProp(target, name, { get: all[name], enumerable: true });
16
+ };
17
+ var __copyProps = (to, from, except, desc) => {
18
+ if (from && typeof from === "object" || typeof from === "function") {
19
+ for (let key of __getOwnPropNames(from))
20
+ if (!__hasOwnProp.call(to, key) && key !== except)
21
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
22
+ }
23
+ return to;
24
+ };
25
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
26
+ // If the importer is in node compatibility mode or this is not an ESM
27
+ // file that has been converted to a CommonJS file using a Babel-
28
+ // compatible transform (i.e. "__esModule" has not been set), then set
29
+ // "default" to the CommonJS "module.exports" for node compatibility.
30
+ isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
31
+ mod
32
+ ));
33
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
34
+ var docs_site_exports = {};
35
+ __export(docs_site_exports, {
36
+ "api-doc-constants": () => api_doc_constants,
37
+ "api-doc-jsdoc": () => api_doc_jsdoc,
38
+ "api-doc-link-rendering": () => api_doc_link_rendering,
39
+ "api-doc-package-sites": () => api_doc_package_sites,
40
+ "api-doc-page-generation": () => api_doc_page_generation,
41
+ "api-doc-route-segments": () => api_doc_route_segments,
42
+ "api-doc-settings": () => api_doc_settings,
43
+ "api-doc-source-processing": () => api_doc_source_processing,
44
+ "api-doc-text-utils": () => api_doc_text_utils,
45
+ "api-doc-type-merging": () => api_doc_type_merging,
46
+ "api-doc-types": () => api_doc_types,
47
+ "api-docs": () => api_docs,
48
+ "astro-config": () => astro_config,
49
+ "docs-links": () => docs_links,
50
+ "docs-site-assets": () => docs_site_assets,
51
+ "docs-site-commands": () => docs_site_commands,
52
+ "docs-site-config": () => docs_site_config,
53
+ "link-check": () => link_check,
54
+ "og-image": () => og_image,
55
+ "og-image-page": () => og_image_page,
56
+ "og-images": () => og_images,
57
+ "route-data": () => route_data,
58
+ "satteri-github-alerts": () => satteri_github_alerts,
59
+ "satteri-relative-links": () => satteri_relative_links,
60
+ "unrendered-alerts": () => unrendered_alerts
61
+ });
62
+ module.exports = __toCommonJS(docs_site_exports);
63
+ var api_doc_constants = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./api-doc-constants.cjs')), 1);
64
+ var api_doc_jsdoc = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./api-doc-jsdoc.cjs')), 1);
65
+ var api_doc_link_rendering = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./api-doc-link-rendering.cjs')), 1);
66
+ var api_doc_package_sites = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./api-doc-package-sites.cjs')), 1);
67
+ var api_doc_page_generation = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./api-doc-page-generation.cjs')), 1);
68
+ var api_doc_route_segments = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./api-doc-route-segments.cjs')), 1);
69
+ var api_doc_settings = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./api-doc-settings.cjs')), 1);
70
+ var api_doc_source_processing = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./api-doc-source-processing.cjs')), 1);
71
+ var api_doc_text_utils = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./api-doc-text-utils.cjs')), 1);
72
+ var api_doc_type_merging = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./api-doc-type-merging.cjs')), 1);
73
+ var api_doc_types = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./api-doc-types.cjs')), 1);
74
+ var api_docs = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./api-docs.cjs')), 1);
75
+ var astro_config = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./astro-config.cjs')), 1);
76
+ var docs_links = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./docs-links.cjs')), 1);
77
+ var docs_site_assets = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./docs-site-assets.cjs')), 1);
78
+ var docs_site_commands = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./docs-site-commands.cjs')), 1);
79
+ var docs_site_config = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./docs-site-config.cjs')), 1);
80
+ var link_check = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./link-check.cjs')), 1);
81
+ var og_image_page = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./og-image-page.cjs')), 1);
82
+ var og_image = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./og-image.cjs')), 1);
83
+ var og_images = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./og-images.cjs')), 1);
84
+ var route_data = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./route-data.cjs')), 1);
85
+ var satteri_github_alerts = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./satteri-github-alerts.cjs')), 1);
86
+ var satteri_relative_links = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./satteri-relative-links.cjs')), 1);
87
+ var unrendered_alerts = __toESM(((module) => module && module.__esModule && 'default' in module ? module.default : module)(require('./unrendered-alerts.cjs')), 1);
88
+ // Annotate the CommonJS export names for ESM import in node:
89
+ 0 && (module.exports = {
90
+ "api-doc-constants": null,
91
+ "api-doc-jsdoc": null,
92
+ "api-doc-link-rendering": null,
93
+ "api-doc-package-sites": null,
94
+ "api-doc-page-generation": null,
95
+ "api-doc-route-segments": null,
96
+ "api-doc-settings": null,
97
+ "api-doc-source-processing": null,
98
+ "api-doc-text-utils": null,
99
+ "api-doc-type-merging": null,
100
+ "api-doc-types": null,
101
+ "api-docs": null,
102
+ "astro-config": null,
103
+ "docs-links": null,
104
+ "docs-site-assets": null,
105
+ "docs-site-commands": null,
106
+ "docs-site-config": null,
107
+ "link-check": null,
108
+ "og-image": null,
109
+ "og-image-page": null,
110
+ "og-images": null,
111
+ "route-data": null,
112
+ "satteri-github-alerts": null,
113
+ "satteri-relative-links": null,
114
+ "unrendered-alerts": null
115
+ });
116
+ //# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vLi4vc3JjL2RvY3Mtc2l0ZS9pbmRleC50cyJdLAogICJzb3VyY2VzQ29udGVudCI6IFsiLyogVEhJUyBJUyBBIEdFTkVSQVRFRC9CVU5ETEVEIEZJTEUgQlkgQlVJTEQgU0NSSVBUICovXG5cbmV4cG9ydCAqIGFzICdhcGktZG9jLWNvbnN0YW50cycgZnJvbSAnLi9hcGktZG9jLWNvbnN0YW50cy50cyc7XG5leHBvcnQgKiBhcyAnYXBpLWRvYy1qc2RvYycgZnJvbSAnLi9hcGktZG9jLWpzZG9jLnRzJztcbmV4cG9ydCAqIGFzICdhcGktZG9jLWxpbmstcmVuZGVyaW5nJyBmcm9tICcuL2FwaS1kb2MtbGluay1yZW5kZXJpbmcudHMnO1xuZXhwb3J0ICogYXMgJ2FwaS1kb2MtcGFja2FnZS1zaXRlcycgZnJvbSAnLi9hcGktZG9jLXBhY2thZ2Utc2l0ZXMudHMnO1xuZXhwb3J0ICogYXMgJ2FwaS1kb2MtcGFnZS1nZW5lcmF0aW9uJyBmcm9tICcuL2FwaS1kb2MtcGFnZS1nZW5lcmF0aW9uLnRzJztcbmV4cG9ydCAqIGFzICdhcGktZG9jLXJvdXRlLXNlZ21lbnRzJyBmcm9tICcuL2FwaS1kb2Mtcm91dGUtc2VnbWVudHMudHMnO1xuZXhwb3J0ICogYXMgJ2FwaS1kb2Mtc2V0dGluZ3MnIGZyb20gJy4vYXBpLWRvYy1zZXR0aW5ncy50cyc7XG5leHBvcnQgKiBhcyAnYXBpLWRvYy1zb3VyY2UtcHJvY2Vzc2luZycgZnJvbSAnLi9hcGktZG9jLXNvdXJjZS1wcm9jZXNzaW5nLnRzJztcbmV4cG9ydCAqIGFzICdhcGktZG9jLXRleHQtdXRpbHMnIGZyb20gJy4vYXBpLWRvYy10ZXh0LXV0aWxzLnRzJztcbmV4cG9ydCAqIGFzICdhcGktZG9jLXR5cGUtbWVyZ2luZycgZnJvbSAnLi9hcGktZG9jLXR5cGUtbWVyZ2luZy50cyc7XG5leHBvcnQgKiBhcyAnYXBpLWRvYy10eXBlcycgZnJvbSAnLi9hcGktZG9jLXR5cGVzLnRzJztcbmV4cG9ydCAqIGFzICdhcGktZG9jcycgZnJvbSAnLi9hcGktZG9jcy50cyc7XG5leHBvcnQgKiBhcyAnYXN0cm8tY29uZmlnJyBmcm9tICcuL2FzdHJvLWNvbmZpZy50cyc7XG5leHBvcnQgKiBhcyAnZG9jcy1saW5rcycgZnJvbSAnLi9kb2NzLWxpbmtzLnRzJztcbmV4cG9ydCAqIGFzICdkb2NzLXNpdGUtYXNzZXRzJyBmcm9tICcuL2RvY3Mtc2l0ZS1hc3NldHMudHMnO1xuZXhwb3J0ICogYXMgJ2RvY3Mtc2l0ZS1jb21tYW5kcycgZnJvbSAnLi9kb2NzLXNpdGUtY29tbWFuZHMudHMnO1xuZXhwb3J0ICogYXMgJ2RvY3Mtc2l0ZS1jb25maWcnIGZyb20gJy4vZG9jcy1zaXRlLWNvbmZpZy50cyc7XG5leHBvcnQgKiBhcyAnbGluay1jaGVjaycgZnJvbSAnLi9saW5rLWNoZWNrLnRzJztcbmV4cG9ydCAqIGFzICdvZy1pbWFnZS1wYWdlJyBmcm9tICcuL29nLWltYWdlLXBhZ2UudHMnO1xuZXhwb3J0ICogYXMgJ29nLWltYWdlJyBmcm9tICcuL29nLWltYWdlLnRzJztcbmV4cG9ydCAqIGFzICdvZy1pbWFnZXMnIGZyb20gJy4vb2ctaW1hZ2VzLnRzJztcbmV4cG9ydCAqIGFzICdyb3V0ZS1kYXRhJyBmcm9tICcuL3JvdXRlLWRhdGEudHMnO1xuZXhwb3J0ICogYXMgJ3NhdHRlcmktZ2l0aHViLWFsZXJ0cycgZnJvbSAnLi9zYXR0ZXJpLWdpdGh1Yi1hbGVydHMudHMnO1xuZXhwb3J0ICogYXMgJ3NhdHRlcmktcmVsYXRpdmUtbGlua3MnIGZyb20gJy4vc2F0dGVyaS1yZWxhdGl2ZS1saW5rcy50cyc7XG5leHBvcnQgKiBhcyAndW5yZW5kZXJlZC1hbGVydHMnIGZyb20gJy4vdW5yZW5kZXJlZC1hbGVydHMudHMnO1xuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUE7QUFBQTtBQUFBLDZCQUFBQTtBQUFBLEVBQUEsdUJBQUFDO0FBQUEsRUFBQSxnQ0FBQUM7QUFBQSxFQUFBLCtCQUFBQztBQUFBLEVBQUEsaUNBQUFDO0FBQUEsRUFBQSxnQ0FBQUM7QUFBQSxFQUFBLDBCQUFBQztBQUFBLEVBQUEsbUNBQUFDO0FBQUEsRUFBQSw0QkFBQUM7QUFBQSxFQUFBLDhCQUFBQztBQUFBLEVBQUEsdUJBQUFDO0FBQUEsRUFBQSxrQkFBQUM7QUFBQSxFQUFBLHNCQUFBQztBQUFBLEVBQUEsb0JBQUFDO0FBQUEsRUFBQSwwQkFBQUM7QUFBQSxFQUFBLDRCQUFBQztBQUFBLEVBQUEsMEJBQUFDO0FBQUEsRUFBQSxvQkFBQUM7QUFBQSxFQUFBLGtCQUFBQztBQUFBLEVBQUEsdUJBQUFDO0FBQUEsRUFBQSxtQkFBQUM7QUFBQSxFQUFBLG9CQUFBQztBQUFBLEVBQUEsK0JBQUFDO0FBQUEsRUFBQSxnQ0FBQUM7QUFBQSxFQUFBLDJCQUFBQztBQUFBO0FBQUE7QUFFQSxJQUFBeEIsb0JBQXFDO0FBQ3JDLElBQUFDLGdCQUFpQztBQUNqQyxJQUFBQyx5QkFBMEM7QUFDMUMsSUFBQUMsd0JBQXlDO0FBQ3pDLElBQUFDLDBCQUEyQztBQUMzQyxJQUFBQyx5QkFBMEM7QUFDMUMsSUFBQUMsbUJBQW9DO0FBQ3BDLElBQUFDLDRCQUE2QztBQUM3QyxJQUFBQyxxQkFBc0M7QUFDdEMsSUFBQUMsdUJBQXdDO0FBQ3hDLElBQUFDLGdCQUFpQztBQUNqQyxJQUFBQyxXQUE0QjtBQUM1QixJQUFBQyxlQUFnQztBQUNoQyxJQUFBQyxhQUE4QjtBQUM5QixJQUFBQyxtQkFBb0M7QUFDcEMsSUFBQUMscUJBQXNDO0FBQ3RDLElBQUFDLG1CQUFvQztBQUNwQyxJQUFBQyxhQUE4QjtBQUM5QixJQUFBRSxnQkFBaUM7QUFDakMsSUFBQUQsV0FBNEI7QUFDNUIsSUFBQUUsWUFBNkI7QUFDN0IsSUFBQUMsYUFBOEI7QUFDOUIsSUFBQUMsd0JBQXlDO0FBQ3pDLElBQUFDLHlCQUEwQztBQUMxQyxJQUFBQyxvQkFBcUM7IiwKICAibmFtZXMiOiBbImFwaS1kb2MtY29uc3RhbnRzIiwgImFwaS1kb2MtanNkb2MiLCAiYXBpLWRvYy1saW5rLXJlbmRlcmluZyIsICJhcGktZG9jLXBhY2thZ2Utc2l0ZXMiLCAiYXBpLWRvYy1wYWdlLWdlbmVyYXRpb24iLCAiYXBpLWRvYy1yb3V0ZS1zZWdtZW50cyIsICJhcGktZG9jLXNldHRpbmdzIiwgImFwaS1kb2Mtc291cmNlLXByb2Nlc3NpbmciLCAiYXBpLWRvYy10ZXh0LXV0aWxzIiwgImFwaS1kb2MtdHlwZS1tZXJnaW5nIiwgImFwaS1kb2MtdHlwZXMiLCAiYXBpLWRvY3MiLCAiYXN0cm8tY29uZmlnIiwgImRvY3MtbGlua3MiLCAiZG9jcy1zaXRlLWFzc2V0cyIsICJkb2NzLXNpdGUtY29tbWFuZHMiLCAiZG9jcy1zaXRlLWNvbmZpZyIsICJsaW5rLWNoZWNrIiwgIm9nLWltYWdlIiwgIm9nLWltYWdlLXBhZ2UiLCAib2ctaW1hZ2VzIiwgInJvdXRlLWRhdGEiLCAic2F0dGVyaS1naXRodWItYWxlcnRzIiwgInNhdHRlcmktcmVsYXRpdmUtbGlua3MiLCAidW5yZW5kZXJlZC1hbGVydHMiXQp9Cg==
@@ -0,0 +1,26 @@
1
+ /// <reference path="../library-references.d.cts" />
2
+ export * as 'api-doc-constants' from './api-doc-constants.cjs';
3
+ export * as 'api-doc-jsdoc' from './api-doc-jsdoc.cjs';
4
+ export * as 'api-doc-link-rendering' from './api-doc-link-rendering.cjs';
5
+ export * as 'api-doc-package-sites' from './api-doc-package-sites.cjs';
6
+ export * as 'api-doc-page-generation' from './api-doc-page-generation.cjs';
7
+ export * as 'api-doc-route-segments' from './api-doc-route-segments.cjs';
8
+ export * as 'api-doc-settings' from './api-doc-settings.cjs';
9
+ export * as 'api-doc-source-processing' from './api-doc-source-processing.cjs';
10
+ export * as 'api-doc-text-utils' from './api-doc-text-utils.cjs';
11
+ export * as 'api-doc-type-merging' from './api-doc-type-merging.cjs';
12
+ export * as 'api-doc-types' from './api-doc-types.cjs';
13
+ export * as 'api-docs' from './api-docs.cjs';
14
+ export * as 'astro-config' from './astro-config.cjs';
15
+ export * as 'docs-links' from './docs-links.cjs';
16
+ export * as 'docs-site-assets' from './docs-site-assets.cjs';
17
+ export * as 'docs-site-commands' from './docs-site-commands.cjs';
18
+ export * as 'docs-site-config' from './docs-site-config.cjs';
19
+ export * as 'link-check' from './link-check.cjs';
20
+ export * as 'og-image-page' from './og-image-page.cjs';
21
+ export * as 'og-image' from './og-image.cjs';
22
+ export * as 'og-images' from './og-images.cjs';
23
+ export * as 'route-data' from './route-data.cjs';
24
+ export * as 'satteri-github-alerts' from './satteri-github-alerts.cjs';
25
+ export * as 'satteri-relative-links' from './satteri-relative-links.cjs';
26
+ export * as 'unrendered-alerts' from './unrendered-alerts.cjs';