@forsakringskassan/docs-generator 2.9.1 → 2.10.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-BNuTiNOg.js');
+var vue3 = require('./vue3-WhFYGWAf.js');
 var path = require('node:path/posix');
 require('@vue/compiler-sfc');
 require('./vendor-DM7XM4qm.js');
@@ -105,6 +105,7 @@ async function compileExample(batch) {
       external,
       tsconfig,
       define: {
+        "process.env.NODE_ENV": JSON.stringify("development"),
         "process.env.DOCS_ICON_LIB": JSON.stringify(iconLib)
       },
       plugins: [

package/dist/index.d.ts

@@ -371,6 +371,7 @@ export declare interface NavigationSection {
     readonly path: string;
     readonly sortorder: number;
     readonly children: NavigationNode[];
+    readonly visible: boolean;
 }
 
 /**
@@ -619,6 +620,8 @@ export declare function themeSelectProcessor(): Processor;
 export declare interface TopnavEntry {
     path: string;
     title: string;
+    sortorder?: number;
+    visible?: boolean;
 }
 
 /**

package/dist/index.js

@@ -13,10 +13,11 @@ var vueDocgenApi = require('vue-docgen-api');
 var fs$1 = require('node:fs');
 var sass = require('sass');
 var node_url = require('node:url');
+var Module = require('node:module');
 var esbuild$1 = require('esbuild');
 var nunjucks = require('nunjucks');
 var vue = require('vue');
-var vue3 = require('./vue3-BNuTiNOg.js');
+var vue3 = require('./vue3-WhFYGWAf.js');
 var express = require('express');
 require('fs');
 require('node:events');
@@ -440,6 +441,7 @@ function generateNavigation(entries) {
       key,
       sortorder: index,
       children: [],
+      visible: true,
       ...it
     };
   });
@@ -447,7 +449,8 @@ function generateNavigation(entries) {
     key: ".",
     path: "./index.html",
     sortorder: Infinity,
-    children
+    children,
+    visible: true
   };
 }
 function topnavProcessor(filename, title) {
@@ -971,50 +974,63 @@ async function navigationFileReader(filePath, basePath) {
   return [doc];
 }
 
+function resolveFrom(fromDirectory, moduleId) {
+  const fromFile = path.join(fs$1.realpathSync(fromDirectory), "noop.js");
+  return Module._resolveFilename(moduleId, {
+    id: fromFile,
+    filename: fromFile,
+    paths: Module._nodeModulePaths(fromDirectory)
+  });
+}
 const WEBPACK_NODE_MODULE_PREFIX = "~";
-const moduleImporter = {
-  findFileUrl(url) {
-    let findUrl = url;
-    if (url.startsWith(WEBPACK_NODE_MODULE_PREFIX)) {
-      findUrl = url.substring(1);
-    }
-    const directory = path.dirname(findUrl);
-    const fileName = path.basename(findUrl);
-    const search = [
-      `${fileName}.css`,
-      `${fileName}.scss`,
-      `_${fileName}.scss`,
-      `${fileName}`
-    ];
-    for (const variant of search) {
-      try {
-        const moduleName = path.posix.join(directory, variant);
-        const resolved = require.resolve(moduleName);
-        return new URL(node_url.pathToFileURL(resolved));
-      } catch (err) {
-        if (err.code !== "MODULE_NOT_FOUND") {
-          throw err;
+function moduleImporter(options) {
+  const { cwd } = options;
+  return {
+    findFileUrl(url) {
+      let findUrl = url;
+      if (url.startsWith(WEBPACK_NODE_MODULE_PREFIX)) {
+        findUrl = url.substring(1);
+      }
+      const directory = path.dirname(findUrl);
+      const fileName = path.basename(findUrl);
+      const search = [
+        `${fileName}.css`,
+        `${fileName}.scss`,
+        `_${fileName}.scss`,
+        `${fileName}`
+      ];
+      for (const variant of search) {
+        try {
+          const moduleName = path.posix.join(directory, variant);
+          const resolved = resolveFrom(cwd, moduleName);
+          return new URL(node_url.pathToFileURL(resolved));
+        } catch (err) {
+          if (err.code !== "MODULE_NOT_FOUND") {
+            throw err;
+          }
         }
       }
+      return null;
     }
-    return null;
-  }
-};
+  };
+}
 
-async function compileSassString(dst, style) {
+async function compileSassString(dst, style, options = {}) {
+  const { cwd = process.cwd() } = options;
   const result = await sass.compileStringAsync(style, {
     style: "expanded",
-    importers: [new sass.NodePackageImporter(), moduleImporter]
+    importers: [new sass.NodePackageImporter(), moduleImporter({ cwd })]
   });
   await fs.mkdir(path.dirname(dst), { recursive: true });
   await fs.writeFile(dst, result.css, "utf-8");
 }
 
-async function compileStyle(assetFolder, name, src) {
+async function compileStyle(assetFolder, name, src, options) {
+  const { cwd } = options;
   try {
     const outfile = path$1.join("temp", `asset-${name}.css`);
     const source = await fs.readFile(src, "utf-8");
-    await compileSassString(outfile, source);
+    await compileSassString(outfile, source, { cwd });
     const content = await fs.readFile(outfile, "utf-8");
     const fingerprint = createMarkdownRenderer.getFingerprint(content);
     const integrity = getIntegrity(content);
@@ -1042,7 +1058,8 @@ function byPriority$1({ options: a }, { options: b }) {
 function toSorted$1(values, comparator) {
   return [...values].sort(comparator);
 }
-function cssAssetProcessor(assetFolder, assets) {
+function cssAssetProcessor(assetFolder, assets, options) {
+  const { cwd } = options;
   return {
     name: "css-asset-processor",
     after: "assets",
@@ -1054,7 +1071,8 @@ function cssAssetProcessor(assetFolder, assets) {
         const info = await compileStyle(
           assetFolder,
           asset.name,
-          asset.src
+          asset.src,
+          { cwd }
         );
         const attrs = serializeAttrs(asset.options.attributes);
         const inject = { ...info, attrs: Array.from(attrs).join(" ") };
@@ -1347,18 +1365,20 @@ function getParentKey(name) {
 }
 function generateNavtree(docs) {
   const section = {};
-  function createSection(key, title, sortorder) {
+  function createSection(key, title, sortorder, { visible } = {}) {
     const existing = section[key];
     if (existing) {
       existing.title = title;
       existing.sortorder = sortorder;
+      existing.visible = visible ?? true;
     } else {
       const node = {
         key,
         title,
         path: "",
         sortorder,
-        children: []
+        children: [],
+        visible: visible ?? true
       };
       section[key] = node;
       if (key !== ".") {
@@ -1378,7 +1398,8 @@ function generateNavtree(docs) {
       title: parentKey.split("/").at(-1) ?? "(missing title)",
       path: "",
       sortorder: Infinity,
-      children: []
+      children: [],
+      visible: true
     };
     section[parentKey] = parent;
     let anchestor = parentKey;
@@ -1394,7 +1415,8 @@ function generateNavtree(docs) {
         title: "",
         path: "",
         sortorder: Infinity,
-        children: [current]
+        children: [current],
+        visible: true
       };
       section[anchestor] = node;
       current = node;
@@ -1425,7 +1447,7 @@ function generateNavtree(docs) {
     }
     if (!doc.visible) {
       if (isSection) {
-        createSection(name, title, sortorder);
+        createSection(name, title, sortorder, { visible: false });
       }
       continue;
     }
@@ -1448,13 +1470,15 @@ function generateNavtree(docs) {
         existing.path = leafNode.path;
         existing.sortorder = sortorder;
         existing.children.unshift(leafNode);
+        existing.visible = true;
       } else {
         const sectionNode = {
           key: name,
           title,
           path: leafNode.path,
           sortorder,
-          children: [leafNode]
+          children: [leafNode],
+          visible: true
         };
         section[name] = sectionNode;
         parent.children.push(sectionNode);
@@ -1479,7 +1503,8 @@ function generateNavtree(docs) {
       title: "",
       path: "",
       sortorder: Infinity,
-      children: []
+      children: [],
+      visible: true
     };
   }
 }
@@ -1639,7 +1664,7 @@ const cache$1 = /* @__PURE__ */ new Map();
 function cacheKey(layout, extension) {
   return [layout, extension].join("|");
 }
-function findTemplate(from, src, format) {
+function findTemplate(folders, from, src, format) {
   let layout;
   if (typeof src === "string") {
     layout = src;
@@ -1653,12 +1678,14 @@ function findTemplate(from, src, format) {
   if (cached) {
     return cached;
   }
+  folders = [...folders, templateDirectory];
   const template = `${layout}.template.${format}`;
-  const templateFile = path.join(templateDirectory, template);
-  if (!fs$1.existsSync(templateFile)) {
-    throw new MissingTemplateError(from, template, format, [
-      templateDirectory
-    ]);
+  const searchPaths = folders.map((it) => {
+    return path.join(it, template);
+  });
+  const found = searchPaths.find((it) => fs$1.existsSync(it));
+  if (!found) {
+    throw new MissingTemplateError(from, template, format, folders);
   }
   cache$1.set(key, template);
   return template;
@@ -1733,7 +1760,7 @@ async function compileExamples(options) {
   }
 }
 async function compileStandalones(options) {
-  const { fileInfo, tasks, renderTemplate, templateData } = options;
+  const { fileInfo, tasks, renderTemplate, templateData, templateFolders } = options;
   if (tasks.length === 0) {
     return;
   }
@@ -1741,7 +1768,11 @@ async function compileStandalones(options) {
   const outputFolder = path.posix.join(options.outputFolder, fileInfo.path);
   const cacheMiss = cache(cacheFolder, outputFolder);
   const dirtyTasks = tasks.filter(cacheMiss);
-  const standaloneTemplate = findTemplate(fileInfo, "example");
+  const standaloneTemplate = findTemplate(
+    templateFolders,
+    fileInfo,
+    "example"
+  );
   for (const task of dirtyTasks) {
     const outputFile = path.join(outputFolder, task.outputFile);
     const content = await renderTemplate(standaloneTemplate, {
@@ -1757,7 +1788,7 @@ function createTemplateLoader(folders) {
 }
 async function render(doc, docs, nav, vendors, options) {
   const { fileInfo } = doc;
-  const { outputFolder, cacheFolder } = options;
+  const { outputFolder, cacheFolder, templateFolders } = options;
   if (!haveOutputFile(fileInfo)) {
     return null;
   }
@@ -1771,7 +1802,7 @@ async function render(doc, docs, nav, vendors, options) {
   const njk = new nunjucks.Environment(loader, { autoescape: false });
   const asyncRender = util.promisify(njk.render);
   const renderTemplate = asyncRender.bind(njk);
-  const template = findTemplate(doc.fileInfo, doc);
+  const template = findTemplate(templateFolders, doc.fileInfo, doc);
   const templateData = {
     ...options.templateData,
     site: options.site,
@@ -1892,6 +1923,7 @@ async function render(doc, docs, nav, vendors, options) {
       fileInfo,
       cacheFolder,
       outputFolder,
+      templateFolders,
       tasks: generatedStandalone,
       renderTemplate,
       templateData
@@ -2015,9 +2047,10 @@ async function compileVendor(assetFolder, vendor, options) {
     platform: "browser",
     tsconfig,
     define: {
-      "process.env.NODE_ENV": JSON.stringify(
-        process.env.NODE_ENV ?? "production"
-      )
+      "process.env.NODE_ENV": JSON.stringify("development"),
+      __VUE_OPTIONS_API__: "true",
+      __VUE_PROD_DEVTOOLS__: "true",
+      __VUE_PROD_HYDRATION_MISMATCH_DETAILS__: "false"
     },
     alias: vendor.alias ? { [`${vendor.package}`]: vendor.alias } : void 0,
     ...options
@@ -2231,7 +2264,6 @@ async function stage(stage2, context, processors, { verbose } = { verbose: true
       }
     } catch (err) {
       console.error(`When running processor "${processor.name}":`);
-      console.error(err);
       throw err;
     }
   }
@@ -2247,14 +2279,16 @@ function createContext(templateLoader) {
     title: "",
     path: "",
     sortorder: Infinity,
-    children: []
+    children: [],
+    visible: true
   };
   let sidenav = {
     key: ".",
     title: "",
     path: "",
     sortorder: Infinity,
-    children: []
+    children: [],
+    visible: true
   };
   const templateData = {};
   return {
@@ -2413,6 +2447,7 @@ class Generator {
     return { pages };
   }
   async build(sourceFiles) {
+    const cwd = process.cwd();
     this.sourceFiles = sourceFiles;
     const {
       site,
@@ -2427,7 +2462,7 @@ class Generator {
     const processors = [
       fileReaderProcessor(sourceFiles),
       vendorProcessor(assetFolder, this.vendor),
-      cssAssetProcessor(assetFolder, this.styles),
+      cssAssetProcessor(assetFolder, this.styles, { cwd }),
       jsAssetProcessor(assetFolder, this.scripts),
       staticResourcesProcessor(assetFolder, this.resources),
       navigationProcessor(),

package/dist/style/core.css

@@ -179,7 +179,7 @@ pre code {
 .docs-topnav__item {
   display: inline-flex;
   list-style-type: none;
-  padding: 1.1rem 0 0 0;
+  padding: 1.1rem 0 0;
   white-space: nowrap;
 }
 .docs-topnav__item.highlight {
@@ -832,10 +832,7 @@ h1 code {
 /* Page header - inverted */
 header .page-header {
   background-color: #fff;
-  padding-top: 0.5rem;
-  padding-bottom: 0.5rem;
-  padding-left: 1.2rem;
-  padding-right: 1.2rem;
+  padding: 0.5rem 1.2rem;
   border-bottom: 1px solid #ddddde;
   flex-wrap: wrap;
 }

package/dist/style/index.css

@@ -179,7 +179,7 @@ pre code {
 .docs-topnav__item {
   display: inline-flex;
   list-style-type: none;
-  padding: 1.1rem 0 0 0;
+  padding: 1.1rem 0 0;
   white-space: nowrap;
 }
 .docs-topnav__item.highlight {
@@ -832,10 +832,7 @@ h1 code {
 /* Page header - inverted */
 header .page-header {
   background-color: #fff;
-  padding-top: 0.5rem;
-  padding-bottom: 0.5rem;
-  padding-left: 1.2rem;
-  padding-right: 1.2rem;
+  padding: 0.5rem 1.2rem;
   border-bottom: 1px solid #ddddde;
   flex-wrap: wrap;
 }

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.47.9"
+      "packageVersion": "7.47.11"
     }
   ]
 }

package/dist/{vue3-BNuTiNOg.js → vue3-WhFYGWAf.js}

@@ -12754,51 +12754,82 @@ function generateCode(options) {
   const selector = `#${slug}`;
   const asset = `${slug}-${fingerprint}.js`;
   const { descriptor, errors } = require$$0.parse(code, { filename });
+  const scopeId = `data-v-${fingerprint}`;
   if (errors.length) {
     throw new Error(`Errors occured when trying to parse ${filename}.`);
   }
-  if (descriptor.template?.content) {
-    descriptor.template.content = descriptor.template.content.replace(
-      "\\\\",
-      "\\"
-    );
-  }
-  if (descriptor.styles.some((it) => it.scoped)) {
-    throw new Error(
-      `Scoped style in ${filename}. Scoped styles are not implemented.`
-    );
-  }
-  const styleContent = descriptor.styles.map((stylePart) => stylePart.content).join("\n");
+  const hasScoped = descriptor.styles.some((e) => e.scoped);
+  const styleContent = descriptor.styles.map((stylePart) => {
+    const compiledStyle = require$$0.compileStyle({
+      filename: descriptor.filename,
+      source: stylePart.content,
+      isProd: false,
+      id: scopeId,
+      scoped: stylePart.scoped,
+      trim: true
+    });
+    return compiledStyle.code;
+  }).join("\n");
   let sourcecode = `import { setup } from "${setupPath}";
 `;
-  if (descriptor.script?.content) {
-    sourcecode += descriptor.script.content.replace(
-      "export default",
-      "const exampleComponent = "
-    );
+  let bindings = void 0;
+  if (descriptor.script || descriptor.scriptSetup) {
+    const script = require$$0.compileScript(descriptor, {
+      id: scopeId,
+      isProd: false,
+      sourceMap: false,
+      inlineTemplate: false,
+      genDefaultAs: "exampleComponent",
+      templateOptions: {
+        id: scopeId,
+        filename,
+        source: descriptor.template?.content,
+        scoped: hasScoped,
+        slotted: descriptor.slotted,
+        compilerOptions: {
+          comments: false,
+          whitespace: "condense",
+          scopeId: hasScoped ? scopeId : void 0,
+          mode: "module"
+        }
+      }
+    });
+    bindings = script.bindings;
+    sourcecode += script.content;
+    sourcecode += "\n\n";
   } else {
     sourcecode += `const exampleComponent = {};
+
 `;
   }
   if (descriptor.template) {
-    const js = require$$0.compileTemplate({
-      id: filename,
+    const template = require$$0.compileTemplate({
+      id: scopeId,
       filename,
       source: descriptor.template.content,
+      scoped: hasScoped,
+      slotted: descriptor.slotted,
       preprocessLang: descriptor.template.lang,
       compilerOptions: {
+        bindingMetadata: bindings,
         comments: false,
-        whitespace: "preserve"
+        whitespace: "condense",
+        scopeId: hasScoped ? scopeId : void 0,
+        mode: "module"
       }
     });
-    sourcecode += `${js.code}
+    sourcecode += `${template.code}
 
 `;
     sourcecode += `exampleComponent.render = render;
-
 `;
   }
-  sourcecode += `setup({
+  if (hasScoped) {
+    sourcecode += `exampleComponent.__scopeId = "${scopeId}";
+`;
+  }
+  sourcecode += `
+setup({
   rootComponent: exampleComponent,
   selector: "${selector}"
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forsakringskassan/docs-generator",
-  "version": "2.9.1",
+  "version": "2.10.0",
   "description": "Documentation generator",
   "keywords": [
     "documentation"

package/templates/partials/topnav.html

@@ -5,10 +5,11 @@
         {% set navPath = nav.path | replace("html", "") %}
         {% set navPath = navPath | replace(".", "") %}
         {% set activePage = navPath in doc.fileInfo.fullPath %}
+        {% if nav.visible %}
         <li class="docs-topnav__item {% if activePage %}highlight{% endif %}">
             <a class="docs-topnav__anchor" href="{{ nav.path | relative(doc) }}"> {{ nav.title }} </a>
         </li>
-        {%- endfor -%}
+        {% endif %} {%- endfor -%}
         <li class="docs-topnav__item docs-topnav__item--more" style="visibility: hidden">
             <button type="button" class="docs-topnav__anchor" aria-expanded="false">
                 <span>Mer</span>
@@ -23,10 +24,11 @@
                     {% set navPath = nav.path | replace("html", "") %}
                     {% set navPath = navPath | replace(".", "") %}
                     {% set activePage = navPath in doc.fileInfo.fullPath %}
+                    {% if nav.visible %}
                     <li class="docs-contextmenu__item {% if activePage %}highlight{% endif %}" style="display: none">
                         <a class="docs-contextmenu__anchor" href="{{ nav.path | relative(doc) }}"> {{ nav.title }} </a>
                     </li>
-                    {%- endfor -%}
+                    {% endif %} {%- endfor -%}
                 </ul>
             </div>
         </li>