@forsakringskassan/docs-generator 2.3.0 → 2.4.0

package/dist/compile-example.js

@@ -3,7 +3,7 @@
 var path$1 = require('node:path');
 var esbuild = require('esbuild');
 var vue = require('vue');
-var vue3 = require('./vue3-BapCBGbN.js');
+var vue3 = require('./vue3-CSK73bce.js');
 var path = require('node:path/posix');
 require('@vue/compiler-sfc');
 require('./vendor-BJuS1z3U.js');

package/dist/index.d.ts

@@ -165,7 +165,9 @@ declare class Generator_2 {
     private resources;
     private sourceFiles;
     constructor(options: GeneratorOptions);
-    compileScript(name: string, src: string | URL, options?: Partial<CompileOptions>): void;
+    compileScript(name: string, src: string | URL, options?: Partial<CompileOptions>, buildOptions?: {
+        define?: Record<string, string>;
+    }): void;
     compileStyle(name: string, src: string | URL, options?: Partial<CompileOptions>): void;
     /**
      * @param dst - Destination directory relative to asset folder.
@@ -457,6 +459,10 @@ export declare interface ProcessorRuntime {
     src: string;
     /** Bundle name (in dist/processors) folder (default: derived from processor name) */
     name?: string;
+    /** Build options (passed to compileScript) */
+    buildOptions?: {
+        define?: Record<string, string>;
+    };
 }
 
 /* Excluded from this release type: processorRuntimeName */

package/dist/index.js

@@ -11,11 +11,11 @@ require('node:crypto');
 var util = require('node:util');
 var fs$1 = require('node:fs');
 var vue = require('vue');
-var vue3 = require('./vue3-BapCBGbN.js');
+var vue3 = require('./vue3-CSK73bce.js');
 var vueDocgenApi = require('vue-docgen-api');
 var sass = require('sass');
 var node_url = require('node:url');
-var esbuild = require('esbuild');
+var esbuild$1 = require('esbuild');
 var nunjucks = require('nunjucks');
 var express = require('express');
 require('@vue/compiler-sfc');
@@ -612,16 +612,21 @@ function generateVueExample(options) {
   };
 }
 function generateStaticExample(options) {
-  const { source, language, tags } = options;
+  const { filename, source, language, tags } = options;
+  const slug = getExampleName(filename);
+  const fingerprint = createMarkdownRenderer.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: null,
-    runtime: runtimeLanguages.includes(language)
+    output: runtime ? asset : null,
+    runtime,
+    task: null
   };
 }
 
@@ -1038,7 +1043,7 @@ async function navigationFileReader(filePath, basePath) {
   return [doc];
 }
 
-function resolveScssImport(filePath) {
+function resolveScssImport(filePath, throwError = true) {
   const { dir, base } = path$1.parse(filePath);
   const search = [`${base}.css`, `${base}.scss`, `_${base}.scss`, `${base}`];
   for (const variant of search) {
@@ -1052,20 +1057,24 @@ function resolveScssImport(filePath) {
       }
     }
   }
-  throw new Error(`Failed to resolve "${filePath}"`);
+  if (throwError) {
+    throw new Error(`Failed to resolve "${filePath}"`);
+  }
+  return null;
 }
-const tildeImporter = {
+const WEBPACK_NODE_MODULE_PREFIX = "~";
+const moduleImporter = {
   canonicalize(url) {
-    const indexOfTilde = url.indexOf("~");
-    if (indexOfTilde >= 0) {
-      return resolveScssImport(url.slice(indexOfTilde + 1));
+    const indexOfPrefix = url.indexOf(WEBPACK_NODE_MODULE_PREFIX);
+    if (indexOfPrefix >= 0) {
+      return resolveScssImport(url.slice(indexOfPrefix + 1));
     }
     if (url.startsWith("file://")) {
       const path$1 = node_url.fileURLToPath(url);
       const relative = path.isAbsolute(path$1) ? path.relative(__dirname, path$1) : path$1;
       return resolveScssImport(relative.replace(/\\/g, "/"));
     }
-    return null;
+    return resolveScssImport(url, false);
   },
   async load(url) {
     const filepath = node_url.fileURLToPath(url);
@@ -1081,7 +1090,7 @@ const tildeImporter = {
 async function compileSassString(dst, style) {
   const result = await sass.compileStringAsync(style, {
     style: "expanded",
-    importers: [new sass.NodePackageImporter(), tildeImporter]
+    importers: [new sass.NodePackageImporter(), moduleImporter]
   });
   await fs.mkdir(path.dirname(dst), { recursive: true });
   await fs.writeFile(dst, result.css, "utf-8");
@@ -1155,12 +1164,23 @@ function cssAssetProcessor(assetFolder, assets) {
   };
 }
 
-async function compileScript(assetFolder, name, src, options) {
+function esbuild(options) {
+  return esbuild$1.build(options);
+}
+
+async function compileScript(options) {
+  const {
+    assetFolder,
+    name,
+    src,
+    buildOptions,
+    fs: fs$1 = fs
+  } = options;
   const iconLib = process.env.DOCS_ICON_LIB ?? "@fkui/icon-lib-default";
   try {
     const entryPoints = [src instanceof URL ? node_url.fileURLToPath(src) : src];
     const outfile = path.join("temp", `asset-${name}.js`);
-    await esbuild.build({
+    await esbuild({
       entryPoints,
       outfile,
       bundle: true,
@@ -1168,19 +1188,20 @@ async function compileScript(assetFolder, name, src, options) {
       platform: "browser",
       external: ["vue", "@fkui/vue"],
       tsconfig: path.join(__dirname, "../tsconfig-examples.json"),
+      ...buildOptions,
       define: {
-        "process.env.DOCS_ICON_LIB": JSON.stringify(iconLib)
-      },
-      ...options
+        "process.env.DOCS_ICON_LIB": JSON.stringify(iconLib),
+        ...buildOptions?.define
+      }
     });
-    const content = await fs.readFile(outfile, "utf-8");
+    const content = await fs$1.readFile(outfile, "utf-8");
     const fingerprint = createMarkdownRenderer.getFingerprint(content);
     const integrity = getIntegrity(content);
     const filename = `${name}-${fingerprint}.js`;
     const dst = path.join(assetFolder, filename);
-    await fs.mkdir(path.dirname(dst), { recursive: true });
-    await fs.rename(outfile, dst);
-    const stat = await fs.stat(dst);
+    await fs$1.mkdir(path.dirname(dst), { recursive: true });
+    await fs$1.rename(outfile, dst);
+    const stat = await fs$1.stat(dst);
     return {
       name,
       filename,
@@ -1210,11 +1231,12 @@ function jsAssetProcessor(assetFolder, assets) {
       const head = context.getTemplateData("injectHead") ?? [];
       const body = context.getTemplateData("injectBody") ?? [];
       for (const asset of toSorted(assets, byPriority)) {
-        const info = await compileScript(
+        const info = await compileScript({
           assetFolder,
-          asset.name,
-          asset.src
-        );
+          name: asset.name,
+          src: asset.src,
+          buildOptions: asset.buildOptions
+        });
         const attrs = serializeAttrs(asset.options.attributes);
         const inject = { ...info, attrs: Array.from(attrs).join(" ") };
         assetInfo[asset.name] = info;
@@ -1274,10 +1296,17 @@ function compileProcessorRuntime(generator, distDir, processors) {
       const name = processorRuntimeName(processor, entry);
       const bundled = new URL(`${name}.js`, distDir);
       const scriptPath = fs$1.existsSync(bundled) ? bundled : entry.src;
-      generator.compileScript(assetName, scriptPath, {
-        appendTo: "body",
-        priority: 50
-      });
+      generator.compileScript(
+        assetName,
+        scriptPath,
+        {
+          appendTo: "body",
+          priority: 50
+        },
+        {
+          ...entry.buildOptions
+        }
+      );
     }
   }
 }
@@ -1756,7 +1785,9 @@ async function render(doc, docs, nav, vendors, options) {
       });
       if (example.output) {
         const { dir, name } = path.parse(example.output);
-        generatedExamples.push(example.task);
+        if (example.task) {
+          generatedExamples.push(example.task);
+        }
         generatedStandalone.push({
           outputFile: path.join(dir, `${name}.html`),
           content: example.markup
@@ -1959,7 +1990,7 @@ async function compileVendor(assetFolder, vendor, options) {
   const source = getAssetSource(vendor, customRequire.toString());
   const tsconfig = path.resolve(__dirname, "../tsconfig-examples.json");
   await fs.writeFile(tmpfile, source, "utf-8");
-  await esbuild.build({
+  await esbuild$1.build({
     entryPoints: [tmpfile],
     outfile,
     bundle: true,
@@ -2306,7 +2337,7 @@ class Generator {
       priority: 100
     });
   }
-  compileScript(name, src, options) {
+  compileScript(name, src, options, buildOptions) {
     this.scripts.push({
       name,
       src,
@@ -2315,6 +2346,9 @@ class Generator {
         attributes: {},
         priority: 0,
         ...options
+      },
+      buildOptions: {
+        ...buildOptions
       }
     });
   }

package/dist/markdown.d.ts

@@ -127,9 +127,11 @@ export declare interface ExampleStaticResult {
     /** HTML markup to inject into document */
     markup: string;
     /** asset filename */
-    output: null;
+    output: string | null;
     /** enables/disables running example live in the browser */
     runtime: boolean;
+    /** task data for compiler */
+    task: null;
 }
 
 /**

package/dist/{vue3-BapCBGbN.js → vue3-CSK73bce.js}

@@ -12776,6 +12776,9 @@ function generateCode(options) {
       "export default",
       "const exampleComponent = "
     );
+  } else {
+    sourcecode += `const exampleComponent = {};
+`;
   }
   if (descriptor.template) {
     const js = require$$0.compileTemplate({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forsakringskassan/docs-generator",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Documentation generator",
   "keywords": [
     "documentation"
@@ -55,7 +55,7 @@
   "dependencies": {
     "livereload-js": "4.0.2",
     "nunjucks": "3.2.4",
-    "piscina": "4.6.1",
+    "piscina": "4.7.0",
     "vue-docgen-api": "4.79.2"
   },
   "peerDependencies": {