@forsakringskassan/docs-generator 3.13.0 → 3.15.0

package/dist/index.mjs

@@ -8,17 +8,20 @@ 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-DwLB6VT1.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 pkg from '../package.json' with { type: "json" };
+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 +53,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];
@@ -90,10 +91,11 @@ function memoize(callback) {
   };
 }
 
-function fileMatcher(patterns) {
+function fileMatcher(patterns, options) {
+  const { ignore } = options;
   const fileList = ts(patterns, {
     posix: true,
-    ignore: "**/node_modules/**"
+    ignore
   });
   return memoize((filename, context) => {
     const matches = fileList.filter((file) => {
@@ -230,6 +232,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 +642,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;
@@ -898,23 +1012,24 @@ async function writeIndex(options) {
     `import path from "node:path";`,
     `import { frontMatterFileReader, partialFileReader } from "@forsakringskassan/docs-generator";`,
     ``,
-    `export const basename = import.meta.dirname;`,
-    `export const exampleFolders = [path.join(basename, "files")];`,
-    `export const filesPath = path.join(basename, "files");`,
-    `export const partialsPath = [path.join(basename, "partials.json")];`,
-    `export const linksPath = [path.join(basename, "links.json")];`,
+    `export const generatorVersion = "${pkg.version}";`,
+    `export const basePath = import.meta.dirname;`,
+    `export const exampleFolders = [path.join(basePath, "files")];`,
+    `export const filesPath = path.join(basePath, "files");`,
+    `export const partialsPath = [path.join(basePath, "partials.json")];`,
+    `export const linksPath = [path.join(basePath, "links.json")];`,
     ``,
     `export function sourceFiles(src) {`,
     `    return [`,
     `        { `,
-    `            include: path.join(basename, "files/**/*.md"),`,
-    `            basename,`,
+    `            include: path.join(filesPath, "**/*.md"),`,
+    `            basePath: filesPath,`,
     `            fileReader: frontMatterFileReader,`,
     `            ...src`,
     `        },`,
     `        { `,
-    `            include: path.join(basename, "partials.json"),`,
-    `            basename,`,
+    `            include: path.join(basePath, "partials.json"),`,
+    `            basePath,`,
     `            fileReader: partialFileReader,`,
     `        }`,
     `    ];`,
@@ -928,7 +1043,8 @@ async function writeDts(options) {
   const lines = [
     `import { SourceFiles } from "@forsakringskassan/docs-generator";`,
     ``,
-    `export declare const basename: string;`,
+    `export declare const generatorVersion: string;`,
+    `export declare const basePath: string;`,
     `export declare const exampleFolders: string[];`,
     `export declare const filesPath: string;`,
     `export declare const partialsPath: string;`,
@@ -1401,7 +1517,9 @@ function sourceUrlProcessor(...args) {
     componentFileExtension = "vue"
   } = options;
   const repository = getRepositoryUrl(pkg) ?? "";
-  const matcher = fileMatcher(sourceFiles);
+  const matcher = fileMatcher(sourceFiles, {
+    ignore: ["**/node_modules/**"]
+  });
   return {
     after: "generate-docs",
     name: "source-url-processor",
@@ -2757,6 +2875,12 @@ async function vueFileReader(filePath) {
   return [vueApi, vueTranslation];
 }
 
+async function glob(pattern) {
+  const cwd = process.cwd();
+  const iterator = fs.glob(pattern, { withFileTypes: true });
+  const ents = await Array.fromAsync(iterator);
+  return ents.filter((st) => st.isFile()).map((st) => path__default.relative(cwd, path__default.join(st.parentPath, st.name)));
+}
 async function globAll(pattern) {
   if (!pattern) {
     return /* @__PURE__ */ new Set();
@@ -2764,9 +2888,7 @@ async function globAll(pattern) {
   if (!Array.isArray(pattern)) {
     pattern = [pattern];
   }
-  const results = await Promise.all(
-    pattern.map((it) => Ze(it, { nodir: true }))
-  );
+  const results = await Promise.all(pattern.map(glob));
   return new Set(results.flat());
 }
 async function getDocumentsForSource(context, src, index) {
@@ -4260,7 +4382,7 @@ class Generator {
       ...this.processors
     ];
     const examplePatterns = this.exampleFolders.map((it) => `${it}/**/*`);
-    const exampleFileMatcher = fileMatcher(examplePatterns);
+    const exampleFileMatcher = fileMatcher(examplePatterns, { ignore: [] });
     const templateLoader = createTemplateLoader([]);
     const context = createContext({
       outputFolder: "",
@@ -4333,7 +4455,7 @@ class Generator {
     const templateLoader = createTemplateLoader(templateFolders);
     const context = createContext({
       outputFolder,
-      exampleFileMatcher: fileMatcher(examplePatterns),
+      exampleFileMatcher: fileMatcher(examplePatterns, { ignore: [] }),
       templateLoader
     });
     const generatedFiles = [
@@ -4386,5 +4508,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