@forsakringskassan/docs-generator 2.35.5 → 2.35.7

package/dist/index.d.mts

@@ -156,7 +156,19 @@ export declare interface DocumentPartial {
  * @public
  */
 export declare interface ExtractExamplesOptions extends ProcessorOptions {
+    /**
+     * Folder to write examples to. The output folder would typically be git
+     * ignored except for configuration files such as `tsconfig.json.`
+     */
     outputFolder: string;
+    /**
+     * Array of languages to extract.
+     *
+     * - `"javascript"`
+     * - `"typescript"`
+     * - `"css"`
+     * - `"scss"`
+     */
     languages?: string[];
 }
 
@@ -558,6 +570,9 @@ export declare interface ProcessorHandler {
     before?: ProcessorStage;
     stage?: ProcessorStage;
     after?: ProcessorStage;
+    /**
+     * Name of this processor. Only used for logging purposes.
+     */
     name: string;
     enabled?: boolean;
     /** List of runtime client scripts required by this processor */

package/dist/index.mjs

@@ -4,9 +4,9 @@ const require = $createRequire(import.meta.url);
 
 import fs from 'node:fs/promises';
 import path from 'node:path/posix';
-import { g as globSync, m as minimatch, M as MarkdownIt, d as dedent, b as closest, e as distance, f as fm, i as isCI, h as glob, j as moduleImporter, k as cliProgress, t as tinylr, w as watch, l as createInstance, n as fse, o as inter } from './vendor-Q6b0E6UP.mjs';
-import { g as generateId, p as parseInfostring, i as isDocumentPage, n as normalizePath, a as getFingerprint, h as hasTag, f as findTag, b as getOutputFilePath, d as htmlencode, e as exampleWorkerUrl, c as createMarkdownRenderer, j as generateExample } from './create-markdown-renderer-Bx9oXbtZ.mjs';
-import sp__default from 'node:path';
+import { g as globSync, m as minimatch, M as MarkdownIt, d as dedent, h as closest, i as distance, j as fm, k as isCI, l as glob, n as moduleImporter, o as cliProgress, t as tinylr, w as watch, p as createInstance, q as fse, s as inter } from './vendor-Ct1QNfWX.mjs';
+import { g as generateId, p as parseInfostring, i as isDocumentPage, n as normalizePath, a as getFingerprint, h as hasTag, f as findTag, b as getOutputFilePath, d as htmlencode, e as exampleWorkerUrl, c as createMarkdownRenderer, j as generateExample } from './create-markdown-renderer-Dq8YIKgp.mjs';
+import path__default from 'node:path';
 import require$$1 from 'crypto';
 import 'node:crypto';
 import { exec, execSync } from 'node:child_process';
@@ -27,12 +27,12 @@ import 'fs';
 import 'node:events';
 import 'node:stream';
 import 'node:string_decoder';
+import 'node:module';
 import 'constants';
 import 'stream';
 import 'util';
 import 'assert';
 import 'path';
-import 'node:module';
 import 'readline';
 import 'events';
 import 'node:os';
@@ -45,6 +45,10 @@ import 'tls';
 import 'tty';
 import 'os';
 import 'querystring';
+import 'module';
+import 'fs/promises';
+import 'process';
+import 'v8';
 import 'vue';
 import './vue3-DtTC1eal.mjs';
 
@@ -1009,7 +1013,7 @@ function toArray$1(value) {
   return Array.isArray(value) ? value : [value];
 }
 function isIndexPage(parsed) {
-  const folder = sp__default.basename(parsed.dir);
+  const folder = path__default.basename(parsed.dir);
   if (parsed.name === folder) {
     return true;
   }
@@ -1079,8 +1083,8 @@ function getComponent(attrs) {
   return toArray$1(attrs.component).map(normalizeComponent);
 }
 function parseFile$1(filePath, basePath, content) {
-  const relative = basePath ? sp__default.relative(basePath, normalizePath(filePath)) : normalizePath(filePath);
-  const parsed = sp__default.parse(relative);
+  const relative = basePath ? path__default.relative(basePath, normalizePath(filePath)) : normalizePath(filePath);
+  const parsed = path__default.parse(relative);
   const blocks = fm(content);
   const attributes = blocks.attributes;
   const isIndex = isIndexPage(parsed);
@@ -1777,7 +1781,7 @@ async function translateAPI(filePath) {
 
 function parseAPI(filePath, api) {
   const relative = normalizePath(filePath);
-  const parsedPath = sp__default.parse(relative);
+  const parsedPath = path__default.parse(relative);
   const componentName = parsedPath.name;
   let html = "";
   if (api.models.length) {
@@ -1806,7 +1810,7 @@ function parseAPI(filePath, api) {
 }
 async function parseTranslation(slug, filePath) {
   const relative = normalizePath(filePath);
-  const parsedPath = sp__default.parse(relative);
+  const parsedPath = path__default.parse(relative);
   const componentName = parsedPath.name;
   const content = await fs.readFile(filePath, "utf-8");
   return {
@@ -1881,8 +1885,8 @@ function parseFile(filePath, basePath, content) {
   if (!title) {
     throw new Error(`No title property set in "${filePath}"`);
   }
-  const relative = basePath ? sp__default.relative(basePath, normalizePath(filePath)) : normalizePath(filePath);
-  const parsed = sp__default.parse(relative);
+  const relative = basePath ? path__default.relative(basePath, normalizePath(filePath)) : normalizePath(filePath);
+  const parsed = path__default.parse(relative);
   const filename = parsed.name.toLowerCase();
   const name = parsed.name;
   const urlpath = parsed.dir;
@@ -1923,7 +1927,7 @@ async function compileSassString(dst, style) {
     style: "expanded",
     importers: [new NodePackageImporter(), moduleImporter]
   });
-  await fs.mkdir(sp__default.dirname(dst), { recursive: true });
+  await fs.mkdir(path__default.dirname(dst), { recursive: true });
   await fs.writeFile(dst, result.css, "utf-8");
 }
 
@@ -2016,7 +2020,7 @@ async function compileScript(options) {
   const iconLib = process.env.DOCS_ICON_LIB ?? "@fkui/icon-lib-default";
   try {
     const entryPoints = [src instanceof URL ? fileURLToPath(src) : src];
-    const outfile = sp__default.join("temp", `asset-${name}.js`);
+    const outfile = path__default.join("temp", `asset-${name}.js`);
     const external = [...assets, ...vendor.map(toExternalVendor)];
     const format = buildOptions.format ?? "esm";
     await esbuild({
@@ -2037,8 +2041,8 @@ async function compileScript(options) {
     const fingerprint = getFingerprint(content);
     const integrity = getIntegrity(content);
     const filename = `${name}-${fingerprint}.js`;
-    const dst = sp__default.join(assetFolder, filename);
-    await fs$1.mkdir(sp__default.dirname(dst), { recursive: true });
+    const dst = path__default.join(assetFolder, filename);
+    await fs$1.mkdir(path__default.dirname(dst), { recursive: true });
     await fs$1.rename(outfile, dst);
     const stat = await fs$1.stat(dst);
     return {
@@ -2138,7 +2142,7 @@ function compileProcessorRuntime(generator, distDir, processors) {
       const assetName = [
         "processors",
         processor.name.replace(/-processor/, ""),
-        entry.name ?? sp__default.parse(entry.src).name
+        entry.name ?? path__default.parse(entry.src).name
       ].join("/");
       const name = processorRuntimeName(processor, entry);
       const bundled = new URL(`${name}.mjs`, distDir);
@@ -2204,7 +2208,7 @@ function pathFromDoc({ fileInfo }) {
     return [fileInfo.path.replace(/\\/g, "/"), true];
   } else {
     return [
-      `./${sp__default.join(fileInfo.path, fileInfo.name).replace(/\\/g, "/")}`,
+      `./${path__default.join(fileInfo.path, fileInfo.name).replace(/\\/g, "/")}`,
       false
     ];
   }
@@ -2439,7 +2443,7 @@ function findTemplate(folders, from, src, format) {
   folders = [...folders, templateDirectory];
   const template = `${layout}.template.${format}`;
   const searchPaths = folders.map((it) => {
-    return sp__default.join(it, template);
+    return path__default.join(it, template);
   });
   const found = searchPaths.find((it) => fs__default.existsSync(it));
   if (!found) {
@@ -2506,7 +2510,7 @@ Make sure the name is correct and the template file exists in one of the listed
   }
   findTemplateFile(name) {
     const { folders } = this;
-    const searchPaths = folders.map((it) => sp__default.join(it, name));
+    const searchPaths = folders.map((it) => path__default.join(it, name));
     return searchPaths.find((it) => existsSync(it));
   }
 }
@@ -2577,8 +2581,8 @@ function findSidenav(doc, tree) {
 }
 function cache(cacheFolder, outputFolder) {
   return (it) => {
-    const cacheFile = sp__default.join(cacheFolder, it.outputFile);
-    const outputFile = sp__default.join(outputFolder, it.outputFile);
+    const cacheFile = path__default.join(cacheFolder, it.outputFile);
+    const outputFile = path__default.join(outputFolder, it.outputFile);
     if (existsSync(cacheFile)) {
       copyFileSync(cacheFile, outputFile);
       return false;
@@ -2596,8 +2600,8 @@ async function compileExamples(options) {
     ...assets.map((it) => it.name),
     ...vendors.map((it) => it.package)
   ];
-  const cacheFolder = sp__default.posix.join(options.cacheFolder, fileInfo.path);
-  const outputFolder = sp__default.posix.join(options.outputFolder, fileInfo.path);
+  const cacheFolder = path__default.posix.join(options.cacheFolder, fileInfo.path);
+  const outputFolder = path__default.posix.join(options.outputFolder, fileInfo.path);
   const cacheMiss = cache(cacheFolder, outputFolder);
   const dirtyTasks = tasks.filter(cacheMiss);
   if (dirtyTasks.length === 0) {
@@ -2632,8 +2636,8 @@ async function compileStandalones(options) {
   if (tasks.length === 0) {
     return;
   }
-  const cacheFolder = sp__default.posix.join(options.cacheFolder, fileInfo.path);
-  const outputFolder = sp__default.posix.join(options.outputFolder, fileInfo.path);
+  const cacheFolder = path__default.posix.join(options.cacheFolder, fileInfo.path);
+  const outputFolder = path__default.posix.join(options.outputFolder, fileInfo.path);
   const cacheMiss = cache(cacheFolder, outputFolder);
   const dirtyTasks = tasks.filter(cacheMiss);
   const standaloneTemplate = findTemplate(
@@ -2642,7 +2646,7 @@ async function compileStandalones(options) {
     "example"
   );
   for (const task of dirtyTasks) {
-    const outputFile = sp__default.join(outputFolder, task.outputFile);
+    const outputFile = path__default.join(outputFolder, task.outputFile);
     const content = await renderTemplate(standaloneTemplate, {
       ...templateData,
       content: task.content
@@ -2664,7 +2668,7 @@ async function render(doc, docs, nav, vendors, options) {
     return null;
   }
   const dst = getOutputFilePath(outputFolder, fileInfo);
-  const mkdir = fs.mkdir(sp__default.dirname(dst), { recursive: true });
+  const mkdir = fs.mkdir(path__default.dirname(dst), { recursive: true });
   const topnav = nav.topnav;
   const sidenav = findSidenav(doc, nav.sidenav);
   if (sidenav && isNavigationSection(sidenav)) {
@@ -2730,12 +2734,12 @@ async function render(doc, docs, nav, vendors, options) {
         fileMatcher
       });
       if (example.output) {
-        const { dir, name } = sp__default.parse(example.output);
+        const { dir, name } = path__default.parse(example.output);
         if (example.task) {
           generatedExamples.push(example.task);
         }
         generatedStandalone.push({
-          outputFile: sp__default.join(dir, `${name}.html`),
+          outputFile: path__default.join(dir, `${name}.html`),
           content: example.markup
         });
       }
@@ -3029,7 +3033,7 @@ function getAssetSource(asset) {
   return lines.join("\n");
 }
 async function compileVendor(assetFolder, vendor, options) {
-  const name = sp__default.isAbsolute(vendor.package) ? sp__default.basename(vendor.package) : vendor.package;
+  const name = path__default.isAbsolute(vendor.package) ? path__default.basename(vendor.package) : vendor.package;
   const slug = slugify(name);
   const outfile = `temp/vendor-${slug}.out.js`;
   const tmpfile = `temp/vendor-${slug}.in.js`;
@@ -3055,7 +3059,7 @@ async function compileVendor(assetFolder, vendor, options) {
   const fingerprint = getFingerprint(content);
   const integrity = getIntegrity(content);
   const filename = `vendor-${slug}-${fingerprint}.js`;
-  const dst = sp__default.join(assetFolder, filename).replace(/\\/g, "/");
+  const dst = path__default.join(assetFolder, filename).replace(/\\/g, "/");
   await fs.rename(outfile, dst);
   const stat = await fs.stat(dst);
   return {
@@ -3258,7 +3262,7 @@ function getWorkingDir(value) {
   if (value) {
     const url = typeof value === "string" ? new URL(value) : value;
     const normalized = normalizePath(fileURLToPath(url));
-    return sp__default.posix.dirname(normalized);
+    return path__default.posix.dirname(normalized);
   } else {
     return normalizePath(process.cwd());
   }
@@ -3296,7 +3300,7 @@ class Generator {
     this.bundleDefaultFont = options.bundleDefaultFont ?? true;
     this.outputFolder = options.outputFolder ?? "./public";
     this.cacheFolder = options.cacheFolder ?? "./temp/docs";
-    this.assetFolder = sp__default.posix.join(this.outputFolder, "assets");
+    this.assetFolder = path__default.posix.join(this.outputFolder, "assets");
     this.exampleFolders = options.exampleFolders ?? [];
     this.templateFolders = options.templateFolders ?? [];
     this.processors = options.processors ?? [];
@@ -3456,7 +3460,7 @@ class Generator {
     const { outputFolder, cacheFolder, assetFolder } = this;
     await fs.rm(cacheFolder, { force: true, recursive: true });
     if (existsSync(outputFolder)) {
-      await fs.mkdir(sp__default.dirname(cacheFolder), { recursive: true });
+      await fs.mkdir(path__default.dirname(cacheFolder), { recursive: true });
       await fse.copy(outputFolder, cacheFolder);
       await fs.rm(outputFolder, { recursive: true });
     }
@@ -3473,7 +3477,7 @@ class Generator {
       const filename = `inter-${subset}-wght-normal.woff2`;
       const module = `@fontsource-variable/inter/files/${filename}`;
       const src = fileURLToPath(import.meta.resolve(module));
-      const dst = sp__default.join(assetFolder, filename);
+      const dst = path__default.join(assetFolder, filename);
       return fs.copyFile(src, dst);
     });
     await Promise.all(files);