@forsakringskassan/docs-generator 3.12.1 → 3.14.0

package/dist/index.mjs

@@ -3,22 +3,24 @@ import { createRequire as $createRequire } from "node:module";
 const require = $createRequire(import.meta.url);
 
 import { ApiItemKind, ApiModel } from '@microsoft/api-extractor-model';
-import { t as ts, Z as Ze, M as MarkdownItCallable, g as fm, s as strToU8, z as zlibSync, h as strFromU8, d as dedent, i as closest, j as distance, k as isCI, m as moduleImporter, l as cliProgress, n as tinylr, w as watch, o as createInstance, p as fse, q as inter } from './vendor-BesEHnwj.mjs';
+import { t as ts, Z as Ze, M as MarkdownItCallable, g as fm, s as strToU8, z as zlibSync, h as strFromU8, d as dedent, i as closest, j as distance, k as isCI, m as moduleImporter, l as cliProgress, n as tinylr, w as watch, o as createInstance, p as fse, q as inter } from './vendor-BLfCdre8.mjs';
 import path__default from 'node:path';
 import crypto from 'node:crypto';
 import path from 'node:path/posix';
 import { exec, execSync } from 'node:child_process';
-import { g as generateId, f as formatCode, p as parseInfostring, a as getFingerprint, h as hasTag, b as parseImport, d as findTag, e as getOutputFilePath, i as isDocumentPage, j as findDocument, k as getDocumentBody, n as normalizePath, l as htmlencode, m as filePath, c as createMarkdownRenderer, o as generateExample } from './create-markdown-renderer-C7-7Tads.mjs';
+import { g as generateId, f as formatCode, p as parseImport, a as getFingerprint, b as parseInfostring, h as hasTag, d as findTag, e as getOutputFilePath, i as isDocumentPage, j as findDocument, k as getDocumentBody, n as normalizePath, l as htmlencode, c as createMarkdownRenderer } from './create-markdown-renderer-BlUpDhJP.mjs';
 import { DocExcerpt } from '@microsoft/tsdoc';
 import fs from 'node:fs/promises';
+import fs__default, { existsSync, readFileSync, copyFileSync } from 'node:fs';
+import { version } from 'vue';
+import { g as generateCode } from './vue3-DbJPWpmQ.mjs';
+import { fileURLToPath } from 'node:url';
 import util, { promisify, styleText } from 'node:util';
 import { codeFrameColumns } from '@babel/code-frame';
 import { parse as parse$1 } from '@babel/parser';
 import traverseModule from '@babel/traverse';
 import { parse, compileScript as compileScript$1, compileTemplate } from 'vue/compiler-sfc';
 import { parse as parse$2 } from 'vue-docgen-api';
-import fs__default, { existsSync, readFileSync, copyFileSync } from 'node:fs';
-import { fileURLToPath } from 'node:url';
 import { compileAsync, NodePackageImporter } from 'sass';
 import { t as tsconfigPath } from './tsconfig-path-bG7G_cK8.mjs';
 import esbuild$1, { build } from 'esbuild';
@@ -50,8 +52,6 @@ import 'module';
 import 'fs/promises';
 import 'process';
 import 'v8';
-import 'vue';
-import './vue3-DbJPWpmQ.mjs';
 
 function toArray$2(value) {
   return Array.isArray(value) ? value : [value];
@@ -230,6 +230,16 @@ function haveOutput(doc) {
   return Boolean(fileInfo.outputName);
 }
 
+function hasPrettyError(value) {
+  if (!value) {
+    return false;
+  }
+  if (typeof value !== "object") {
+    return false;
+  }
+  return "prettyError" in value && typeof value.prettyError === "function";
+}
+
 function interpolate(value, data) {
   return value.replaceAll(/\{\{([^{}]+)\}\}/g, (match, raw) => {
     const key = raw.trim();
@@ -630,6 +640,108 @@ function isDocumentPartial(doc) {
   return doc.kind === "partial";
 }
 
+function getExampleName(filename) {
+  return path__default.parse(filename).name;
+}
+
+const vueMajor = Number(version.split(".", 2)[0]);
+function vueGenerator() {
+  switch (vueMajor) {
+    case 2:
+      throw new Error(
+        "Vue 2 is no longer supported, upgrade to Vue 3 or downgrade docs-generator"
+      );
+    case 3:
+      return generateCode;
+  }
+}
+function generateExample(options) {
+  const { language, fileMatcher } = options;
+  if (language === "import") {
+    const parsed = parseImport(options.source);
+    const filename = fileMatcher(parsed.filename, "when importing example");
+    const language2 = parsed.extension;
+    const comments = parsed.comments;
+    const content = fs__default.readFileSync(filename, "utf8");
+    const example = generateExample({
+      ...options,
+      source: content,
+      language: language2,
+      filename
+    });
+    return { ...example, comments };
+  }
+  switch (language) {
+    case "vue":
+      return generateVueExample(options);
+    case "html":
+      return generateStaticExample(options);
+    default:
+      return generateStaticExample(options);
+  }
+}
+function generateVueExample(options) {
+  const { filename, source, parent, setupPath, tags } = options;
+  const fn = vueGenerator();
+  const slug = getExampleName(filename);
+  const fingerprint = getFingerprint(source);
+  const { markup, sourcecode, output } = fn({
+    filename,
+    slug,
+    fingerprint,
+    code: source,
+    setupPath
+  });
+  if (output) {
+    return {
+      source,
+      language: options.language,
+      comments: [],
+      tags,
+      markup,
+      output,
+      runtime: true,
+      task: {
+        outputFile: output,
+        sourcecode,
+        sourceFile: filename,
+        parent
+      }
+    };
+  }
+  return {
+    source: sourcecode,
+    language: "plaintext",
+    comments: [],
+    tags,
+    markup,
+    output: null,
+    runtime: true,
+    task: null
+  };
+}
+function generateStaticExample(options) {
+  const { filename, source, language, tags } = options;
+  const slug = getExampleName(filename);
+  const fingerprint = getFingerprint(source);
+  const asset = `${slug}-${fingerprint}.${language}`;
+  const runtimeLanguages = ["html"];
+  const runtime = runtimeLanguages.includes(language);
+  return {
+    source,
+    language: options.language,
+    comments: [],
+    tags,
+    markup: source,
+    output: runtime ? asset : null,
+    runtime,
+    task: null
+  };
+}
+
+const url = new URL("./worker--TrTGmqL.mjs", import.meta.url);
+const filePath = fileURLToPath(url);
+
 const md$6 = MarkdownItCallable();
 md$6.renderer.rules.fence = (tokens, idx, _options, env) => {
   const { collected, exampleFileMatcher } = env;
@@ -4156,7 +4268,7 @@ class Generator {
     this.scripts = [];
     this.styles = [];
     this.resources = [];
-    this.sourceFiles = [];
+    this.sourceFiles = options.sourceFiles ?? [];
     this.markdownOptions = options.markdown;
     const bootstrapUrl = new URL("runtime-bootstrap.mjs", import.meta.url);
     this.compileScript(
@@ -4246,16 +4358,14 @@ class Generator {
       to: dst
     });
   }
-  /**
-   * Generate a manifest listing all generated documents that will be present
-   * in `outputFolder`.
-   *
-   * Note: this only collects documents from the `generate-docs` stage,
-   * potential documents generated at later stages will not be present.
-   *
-   * @public
-   */
-  async manifest(sourceFiles) {
+  async manifest(explicitSourceFiles) {
+    if (explicitSourceFiles) {
+      this.sourceFiles = explicitSourceFiles;
+      console.error(
+        "[docs-generator] deprecated: passing in `sourceFiles` as a parameter to `Generator.manifest()` is deprecated, should be passed into the constructor options instead."
+      );
+    }
+    const { sourceFiles } = this;
     const processors = [
       fileReaderProcessor(sourceFiles),
       redirectProcessor(),
@@ -4276,8 +4386,13 @@ class Generator {
     });
     return { pages };
   }
-  async build(sourceFiles) {
-    this.sourceFiles = sourceFiles;
+  async build(explicitSourceFiles) {
+    if (explicitSourceFiles) {
+      this.sourceFiles = explicitSourceFiles;
+      console.error(
+        "[docs-generator] deprecated: passing in `sourceFiles` as a parameter to `Generator.build()` is deprecated, should be passed into the constructor options instead."
+      );
+    }
     const {
       site,
       outputFolder,
@@ -4286,6 +4401,7 @@ class Generator {
       exampleFolders,
       templateFolders,
       setupPath,
+      sourceFiles,
       markdownOptions
     } = this;
     const examplePatterns = this.exampleFolders.map((it) => `${it}/**/*`);
@@ -4350,7 +4466,7 @@ class Generator {
       outputFolder,
       watch,
       rebuild: (_filePath) => {
-        return this.build(sourceFiles);
+        return this.build();
       }
     });
   }
@@ -4382,5 +4498,5 @@ class Generator {
   }
 }
 
-export { Generator, apiExtractorProcessor, availableProcessors, cookieProcessor, defineSources, extractExamplesProcessor, extractMarkdownProcessor, frontMatterFileReader, htmlRedirectProcessor, isRelease, livereloadProcessor, manifestProcessor, matomoProcessor, motdProcessor, navigationFileReader, partialFileReader, playgroundProcessor, processorRuntimeName, redirectFileProcessor, searchProcessor, selectableVersionProcessor, sourceUrlProcessor, topnavProcessor, versionBannerProcessor, versionProcessor, vueFileReader };
+export { Generator, apiExtractorProcessor, availableProcessors, cookieProcessor, defineSources, extractExamplesProcessor, extractMarkdownProcessor, frontMatterFileReader, hasPrettyError, htmlRedirectProcessor, isRelease, livereloadProcessor, manifestProcessor, matomoProcessor, motdProcessor, navigationFileReader, partialFileReader, playgroundProcessor, processorRuntimeName, redirectFileProcessor, searchProcessor, selectableVersionProcessor, sourceUrlProcessor, topnavProcessor, versionBannerProcessor, versionProcessor, vueFileReader };
 //# sourceMappingURL=index.mjs.map