@forsakringskassan/docs-generator 2.23.0 → 2.24.0

package/dist/index.js

@@ -2,8 +2,8 @@
 
 var fs = require('node:fs/promises');
 var path = require('node:path/posix');
-var vendor = require('./vendor-BxO3IPg6.js');
-var createMarkdownRenderer = require('./create-markdown-renderer-BSbHc8U0.js');
+var vendor = require('./vendor-DQQ31U4v.js');
+var createMarkdownRenderer = require('./create-markdown-renderer-wbIE-KQj.js');
 var path$1 = require('node:path');
 var require$$1 = require('crypto');
 require('node:crypto');
@@ -11,6 +11,9 @@ var node_child_process = require('node:child_process');
 var util = require('node:util');
 var codeFrame = require('@babel/code-frame');
 var vueDocgenApi = require('vue-docgen-api');
+var parser = require('@babel/parser');
+var traverseModule = require('@babel/traverse');
+var require$$0 = require('@vue/compiler-sfc');
 var fs$1 = require('node:fs');
 var sass = require('sass');
 var node_url = require('node:url');
@@ -21,7 +24,6 @@ require('fs');
 require('node:events');
 require('node:stream');
 require('node:string_decoder');
-require('@vue/compiler-sfc');
 require('typescript');
 require('constants');
 require('stream');
@@ -44,7 +46,7 @@ require('tls');
 require('tty');
 require('querystring');
 require('vue');
-require('./vue3-CZnjnYGV.js');
+require('./vue3-BQVQQ2Vn.js');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 function toArray$2(value) {
@@ -81,6 +83,7 @@ const documentAttributeKeys = [
   "include",
   "component",
   "href",
+  "search",
   "sortorder",
   "redirect_from"
 ];
@@ -281,8 +284,8 @@ function slugify(value) {
   return value.toLowerCase().replace(/\//g, "--").replace(/[^a-z]+/g, "-").replace(/(^-+|-+$)/, "");
 }
 
-const md$4 = vendor.MarkdownIt();
-md$4.renderer.rules.fence = (tokens, idx, _options, collected) => {
+const md$5 = vendor.MarkdownIt();
+md$5.renderer.rules.fence = (tokens, idx, _options, collected) => {
   const { content, info } = tokens[idx];
   const { language, tags } = createMarkdownRenderer.parseInfostring(info);
   if (language === "import") {
@@ -303,7 +306,7 @@ function findExamples$1(doc) {
     return [];
   }
   const collected = [];
-  md$4.render(doc.body, collected);
+  md$5.render(doc.body, collected);
   return collected;
 }
 function getSuffix(tags) {
@@ -370,8 +373,8 @@ function extractExamplesProcessor(options) {
   };
 }
 
-const md$3 = vendor.MarkdownIt();
-md$3.renderer.rules.fence = (tokens, idx, _options, collected) => {
+const md$4 = vendor.MarkdownIt();
+md$4.renderer.rules.fence = (tokens, idx, _options, collected) => {
   const { content, info, map } = tokens[idx];
   const { language, tags } = createMarkdownRenderer.parseInfostring(info);
   const hashContent = `${map?.[0]}:${map?.[1]}:${info}:${content}`;
@@ -405,7 +408,7 @@ function findExamples(doc) {
     return [];
   }
   const collected = [];
-  md$3.render(doc.body, collected);
+  md$4.render(doc.body, collected);
   return collected;
 }
 function manifestPageFromDocument(doc) {
@@ -697,7 +700,8 @@ function redirectProcessor() {
           visible: false,
           attributes: {
             sortorder: Infinity,
-            redirectFrom: []
+            redirectFrom: [],
+            search: { terms: [] }
           },
           body: redirect.to,
           outline: [],
@@ -1085,6 +1089,9 @@ function parseFile$1(filePath, basePath, content) {
       badge: getBadge(attributes),
       component: getComponent(attributes),
       redirectFrom: toArray$1(attributes.redirect_from ?? []),
+      search: {
+        terms: toArray$1(attributes.search?.terms ?? [])
+      },
       sortorder: attributes.sortorder ?? Infinity
     },
     body: blocks.body,
@@ -1252,13 +1259,13 @@ async function translateAPI(filePath) {
   };
 }
 
-const md$2 = vendor.MarkdownIt();
-const EMPTY_CHAR$2 = "‐";
-function render$3(text) {
-  return text ? md$2.render(text) : EMPTY_CHAR$2;
+const md$3 = vendor.MarkdownIt();
+const EMPTY_CHAR$3 = "‐";
+function render$4(text) {
+  return text ? md$3.render(text) : EMPTY_CHAR$3;
 }
-function renderInline$2(text) {
-  return text ? md$2.renderInline(text) : EMPTY_CHAR$2;
+function renderInline$3(text) {
+  return text ? md$3.renderInline(text) : EMPTY_CHAR$3;
 }
 function generatePropTable(slug, props) {
   return (
@@ -1286,9 +1293,9 @@ function generatePropTable(slug, props) {
                             ${prop.deprecated === null ? "" : `<span class="docs-tag docs-tag--deprecated">Deprecated</span>`}
                         </dt>
                         <dd>
-                            ${render$3(prop.description)}
+                            ${render$4(prop.description)}
                             ${prop.default ? `<p class="doc-api__item">Default: <code>${createMarkdownRenderer.htmlencode(prop.default.value)}</code></p>` : ""}
-                            ${prop.deprecated ? `<p class="doc-api__item docs-deprecated">Deprecated: ${renderInline$2(prop.deprecated)}</p>` : ""}
+                            ${prop.deprecated ? `<p class="doc-api__item docs-deprecated">Deprecated: ${renderInline$3(prop.deprecated)}</p>` : ""}
                         </dd>
                     `
       );
@@ -1298,14 +1305,14 @@ function generatePropTable(slug, props) {
   );
 }
 
-const md$1 = vendor.MarkdownIt();
-const EMPTY_CHAR$1 = "&#8208;";
-const EM_DASH$1 = `<span role="presentation">&mdash;</span>`;
-function render$2(text) {
-  return text ? md$1.render(text) : EMPTY_CHAR$1;
+const md$2 = vendor.MarkdownIt();
+const EMPTY_CHAR$2 = "&#8208;";
+const EM_DASH$2 = `<span role="presentation">&mdash;</span>`;
+function render$3(text) {
+  return text ? md$2.render(text) : EMPTY_CHAR$2;
 }
-function renderInline$1(text) {
-  return text ? md$1.renderInline(text) : EMPTY_CHAR$1;
+function renderInline$2(text) {
+  return text ? md$2.renderInline(text) : EMPTY_CHAR$2;
 }
 function generateEventTable(slug, events) {
   return (
@@ -1333,17 +1340,17 @@ function generateEventTable(slug, events) {
                             ${event.deprecated === null ? "" : `<span class="docs-tag docs-tag--deprecated">Deprecated</span>`}
                         </dt>
                         <dd>
-                            ${render$2(event.description)}
+                            ${render$3(event.description)}
                             ${haveProperties ? `<p class="docs-api__list-title">Arguments:</p><ul class="docs-api__list">` : ""}
                             ${event.properties.map((it) => {
           if (it.description) {
-            return `<li><code>${createMarkdownRenderer.htmlencode(it.name)}: ${createMarkdownRenderer.htmlencode(it.type ?? "unknown")}</code> ${EM_DASH$1} ${renderInline$1(it.description)}</li>`;
+            return `<li><code>${createMarkdownRenderer.htmlencode(it.name)}: ${createMarkdownRenderer.htmlencode(it.type ?? "unknown")}</code> ${EM_DASH$2} ${renderInline$2(it.description)}</li>`;
           } else {
             return `<li><code>${createMarkdownRenderer.htmlencode(it.name)}: ${createMarkdownRenderer.htmlencode(it.type ?? "unknown")}</code></li>`;
           }
         }).join("")}
                             ${haveProperties ? `</ul>` : ""}
-                            ${event.deprecated ? `<p class="docs-api__deprecated docs-deprecated">Deprecated: ${renderInline$1(event.deprecated)}</p>` : ""}
+                            ${event.deprecated ? `<p class="docs-api__deprecated docs-deprecated">Deprecated: ${renderInline$2(event.deprecated)}</p>` : ""}
                         </dd>
                     `
       );
@@ -1353,14 +1360,14 @@ function generateEventTable(slug, events) {
   );
 }
 
-const md = vendor.MarkdownIt();
-const EMPTY_CHAR = "&#8208;";
-const EM_DASH = `<span role="presentation">&mdash;</span>`;
-function render$1(text) {
-  return text ? md.render(text) : EMPTY_CHAR;
+const md$1 = vendor.MarkdownIt();
+const EMPTY_CHAR$1 = "&#8208;";
+const EM_DASH$1 = `<span role="presentation">&mdash;</span>`;
+function render$2(text) {
+  return text ? md$1.render(text) : EMPTY_CHAR$1;
 }
-function renderInline(text) {
-  return text ? md.renderInline(text) : EMPTY_CHAR;
+function renderInline$1(text) {
+  return text ? md$1.renderInline(text) : EMPTY_CHAR$1;
 }
 function generateSlotTable(slug, slots) {
   return (
@@ -1388,17 +1395,247 @@ function generateSlotTable(slug, slots) {
                             ${slot.deprecated === null ? "" : `<span class="docs-tag docs-tag--deprecated">Deprecated</span>`}
                         </dt>
                         <dd>
-                            ${render$1(slot.description)}
+                            ${render$2(slot.description)}
                             ${haveBindings ? `<p class="docs-api__list-title">Bindings:</p><ul class="docs-api__list">` : ""}
                             ${slot.bindings.map((it) => {
           if (it.description) {
-            return `<li><code>${createMarkdownRenderer.htmlencode(it.name)}: ${createMarkdownRenderer.htmlencode(it.type ?? "unknown")}</code> ${EM_DASH} ${renderInline(it.description)}</li>`;
+            return `<li><code>${createMarkdownRenderer.htmlencode(it.name)}: ${createMarkdownRenderer.htmlencode(it.type ?? "unknown")}</code> ${EM_DASH$1} ${renderInline$1(it.description)}</li>`;
           } else {
             return `<li><code>${createMarkdownRenderer.htmlencode(it.name)}: ${createMarkdownRenderer.htmlencode(it.type ?? "unknown")}</code></li>`;
           }
         }).join("")}
                             ${haveBindings ? `</ul>` : ""}
-                            ${slot.deprecated ? `<p class="docs-api__deprecated docs-deprecated">Deprecated: ${renderInline(slot.deprecated)}</p>` : ""}
+                            ${slot.deprecated ? `<p class="docs-api__deprecated docs-deprecated">Deprecated: ${renderInline$1(slot.deprecated)}</p>` : ""}
+                        </dd>
+                    `
+      );
+    }).join("")}
+        </dl>
+    `
+  );
+}
+
+function isStringLiteral(node) {
+  return node.type === "StringLiteral";
+}
+function isObjectExpression(node) {
+  return node.type === "ObjectExpression";
+}
+function isDocComment(node) {
+  return node.type === "CommentBlock";
+}
+function getDescription(node) {
+  if (!node) {
+    return null;
+  }
+  const text = node.value;
+  if (!text.startsWith("*")) {
+    return null;
+  }
+  return node.value.replace(/^\s*[*]\s/gm, "").replace(/\s+$/gm, "");
+}
+function flattenMemberExpression(node) {
+  const { object, property } = node;
+  if (property.type !== "Identifier") {
+    return null;
+  }
+  if (object.type === "Identifier") {
+    return [object.name, property.name].join(".");
+  }
+  if (object.type === "ThisExpression") {
+    return ["this", property.name].join(".");
+  }
+  if (object.type === "MemberExpression") {
+    const nested = flattenMemberExpression(object);
+    if (nested) {
+      return [nested, property.name].join(".");
+    }
+  }
+  return null;
+}
+function getParameters(node) {
+  if (!node) {
+    return [];
+  }
+  const parameters = [];
+  for (const property of node.properties) {
+    if (property.type !== "ObjectProperty") {
+      continue;
+    }
+    if (property.key.type !== "Identifier") {
+      continue;
+    }
+    const docComment = property.leadingComments?.find(isDocComment);
+    parameters.push({
+      name: property.key.name,
+      description: getDescription(docComment)
+    });
+  }
+  return parameters;
+}
+function isTranslateCall(node) {
+  const allowedNames = [
+    "this.$t",
+    // options api (inside computed, methods, etc)
+    "_ctx.$t",
+    // options api (template)
+    "$setup.$t",
+    // script setup or setup in options api
+    "TranslationService.provider.translate"
+    // props call this directly
+  ];
+  if (node.callee.type === "MemberExpression") {
+    const fullName = flattenMemberExpression(node.callee);
+    return Boolean(fullName && allowedNames.includes(fullName));
+  }
+  if (node.callee.type === "Identifier") {
+    return node.callee.name === "$t";
+  }
+  return false;
+}
+function findDocComment(path, node) {
+  if (node.leadingComments) {
+    const doc = node.leadingComments.find(isDocComment);
+    if (doc) {
+      return doc;
+    }
+  }
+  const parent = path.parent;
+  if (parent.leadingComments && (parent.type === "ReturnStatement" || parent.type === "ObjectProperty")) {
+    const doc = parent.leadingComments.find(isDocComment);
+    if (doc) {
+      return doc;
+    }
+  }
+  return null;
+}
+function findTranslations(filename, content) {
+  const { descriptor, errors } = require$$0.parse(content, { filename });
+  if (errors.length > 0) {
+    if (vendor.isCI) {
+      const first = errors[0].message;
+      throw new Error(
+        `Errors occurred when trying to parse "${filename}": ${first}`
+      );
+    }
+    return [];
+  }
+  const id = "faux-id";
+  let sourcecode = "";
+  let bindings = void 0;
+  if (descriptor.script || descriptor.scriptSetup) {
+    const script = require$$0.compileScript(descriptor, {
+      id,
+      isProd: false,
+      sourceMap: false,
+      inlineTemplate: false,
+      genDefaultAs: "exampleComponent",
+      templateOptions: {
+        filename,
+        source: descriptor.template?.content,
+        slotted: descriptor.slotted,
+        compilerOptions: {
+          comments: true,
+          whitespace: "condense",
+          mode: "module"
+        }
+      }
+    });
+    bindings = script.bindings;
+    sourcecode += `${script.content}
+
+`;
+  }
+  if (descriptor.template) {
+    const template = require$$0.compileTemplate({
+      id,
+      filename,
+      source: descriptor.template.content,
+      slotted: descriptor.slotted,
+      preprocessLang: descriptor.template.lang,
+      compilerOptions: {
+        bindingMetadata: bindings,
+        comments: true,
+        whitespace: "condense",
+        mode: "module"
+      }
+    });
+    sourcecode += `${template.code}
+
+`;
+  }
+  const ast = parser.parse(sourcecode, {
+    sourceType: "module",
+    plugins: ["typescript"]
+  });
+  const traverse = "default" in traverseModule ? traverseModule.default : traverseModule;
+  const result = [];
+  traverse(ast, {
+    CallExpression(path) {
+      const { node } = path;
+      if (isTranslateCall(node)) {
+        const [name, ...defaultOrParams] = node.arguments;
+        const textArgument = defaultOrParams.find(isStringLiteral);
+        const paramArgument = defaultOrParams.find(isObjectExpression);
+        if (name.type !== "StringLiteral") {
+          return;
+        }
+        const defaultTranslation = textArgument ? textArgument.value : null;
+        const docComment = findDocComment(path, node);
+        result.push({
+          name: name.value,
+          defaultTranslation,
+          description: getDescription(docComment),
+          parameters: getParameters(paramArgument)
+        });
+      }
+    }
+  });
+  return result;
+}
+
+const md = vendor.MarkdownIt();
+const EMPTY_CHAR = "&#8208;";
+const EM_DASH = `<span role="presentation">&mdash;</span>`;
+function render$1(text) {
+  return text ? md.render(text) : EMPTY_CHAR;
+}
+function renderInline(text) {
+  return text ? md.renderInline(text) : EMPTY_CHAR;
+}
+function generateTranslationTable(slug, translations) {
+  return (
+    /* HTML */
+    `
+        <dl class="docs-api docs-api--translation">
+            ${translations.map((translation) => {
+      const { name } = translation;
+      const id = `${slug}-translation-${slugify(name)}`;
+      const haveParameters = translation.parameters.length > 0;
+      return (
+        /* HTML */
+        `
+                        <dt>
+                            <code id="${id}"
+                                ><a class="docs-api__anchor" href="#${id}"
+                                    ><span class="docs-api__name"
+                                        >${createMarkdownRenderer.htmlencode(name)}</span
+                                    ></a
+                                ></code
+                            >
+                        </dt>
+                        <dd>
+                            ${render$1(translation.description)}
+                            ${translation.defaultTranslation ? `<p class="doc-api__item">Default: "${createMarkdownRenderer.htmlencode(translation.defaultTranslation)}"</p>` : ""}
+                            ${haveParameters ? `<p class="docs-api__list-title">Parameters:</p><ul class="docs-api__list">` : ""}
+                            ${translation.parameters.map((it) => {
+          if (it.description) {
+            return `<li><code>${createMarkdownRenderer.htmlencode(it.name)}</code> ${EM_DASH} ${renderInline(it.description)}</li>`;
+          } else {
+            return `<li><code>${createMarkdownRenderer.htmlencode(it.name)}</code></li>`;
+          }
+        }).join("")}
+                            ${haveParameters ? `</ul>` : ""}
                         </dd>
                     `
       );
@@ -1424,7 +1661,7 @@ function parseAPI(filePath, api) {
   }
   return {
     kind: "partial",
-    id: `fs:${filePath.replace(/\\/g, "/")}`,
+    id: `fs:${filePath.replace(/\\/g, "/")}:api`,
     name: `vue:${componentName}`,
     alias: [],
     body: html,
@@ -1434,10 +1671,31 @@ function parseAPI(filePath, api) {
     }
   };
 }
+async function parseTranslation(slug, filePath) {
+  const relative = createMarkdownRenderer.normalizePath(filePath);
+  const parsedPath = path$1.parse(relative);
+  const componentName = parsedPath.name;
+  const content = await fs.readFile(filePath, "utf-8");
+  return {
+    kind: "partial",
+    id: `fs:${filePath.replace(/\\/g, "/")}:translation`,
+    name: `translation:${componentName}`,
+    alias: [],
+    get body() {
+      const translations = findTranslations(filePath, content);
+      return generateTranslationTable(slug, translations);
+    },
+    format: "html",
+    fileInfo: {
+      fullPath: filePath
+    }
+  };
+}
 async function vueFileReader(filePath) {
   const translated = await translateAPI(filePath);
-  const doc = parseAPI(filePath, translated);
-  return [doc];
+  const vueApi = parseAPI(filePath, translated);
+  const vueTranslation = await parseTranslation(translated.slug, filePath);
+  return [vueApi, vueTranslation];
 }
 
 async function globAll(pattern) {
@@ -1505,7 +1763,8 @@ function parseFile(filePath, basePath, content) {
       title,
       href,
       sortorder: attributes.sortorder ?? Infinity,
-      redirectFrom: []
+      redirectFrom: [],
+      search: { terms: [] }
     },
     body: content,
     outline: [],
@@ -2207,6 +2466,9 @@ function createTemplateLoader(folders) {
   loader = new TemplateLoader(folders);
   return loader;
 }
+function stripPrettierComments(content) {
+  return content.replace(/\s*<!-- prettier-ignore -->\s*/gm, "");
+}
 async function render(doc, docs, nav, vendors, options) {
   const { fileInfo } = doc;
   const { outputFolder, cacheFolder, templateFolders } = options;
@@ -2228,6 +2490,9 @@ async function render(doc, docs, nav, vendors, options) {
     ...options.templateData,
     site: options.site,
     doc,
+    get layoutClass() {
+      return `layout--${doc.template.replace(/[.]/g, "--")}`;
+    },
     topnav,
     rootUrl(doc2) {
       const { fileInfo: fileInfo2 } = doc2;
@@ -2335,7 +2600,9 @@ async function render(doc, docs, nav, vendors, options) {
   await mkdir;
   let content;
   try {
-    content = await renderTemplate(template, templateData);
+    content = stripPrettierComments(
+      await renderTemplate(template, templateData)
+    );
   } catch (err) {
     const filename = fileInfo.fullPath;
     if (err instanceof Error && err.name === "Template render error") {
@@ -2962,7 +3229,8 @@ function generateIndex(entries) {
   for (const entry of entries) {
     index.results.push({
       url: entry.url,
-      title: entry.title
+      title: entry.title,
+      terms: entry.terms
     });
     const resultIndex = index.results.length - 1;
     for (const word of entry.words) {
@@ -2974,16 +3242,20 @@ function generateIndex(entries) {
   return index;
 }
 
-function extractTerms(doc) {
+function* extractTerms(doc) {
   const { title, component } = doc.attributes;
-  if (title && component) {
-    return component.map((it) => `${title} (${it.name})`);
-  } else if (component) {
-    return component.map((it) => it.name);
-  } else if (title) {
-    return [title];
+  if (title) {
+    yield title;
   } else {
-    return [];
+    yield doc.name;
+  }
+  if (component) {
+    for (const name of component.map((it) => it.name)) {
+      yield name;
+    }
+  }
+  for (const term of doc.attributes.search.terms) {
+    yield term;
   }
 }
 function isIndexable(doc) {
@@ -2993,8 +3265,12 @@ function isIndexable(doc) {
 function getTerms(doc) {
   return {
     url: createMarkdownRenderer.getOutputFilePath(".", doc.fileInfo) ?? "",
-    title: doc.name,
-    words: extractTerms(doc)
+    title: doc.attributes.title ?? doc.name,
+    terms: [
+      ...doc.attributes.search.terms,
+      ...doc.attributes.component?.map((it) => it.name) ?? []
+    ],
+    words: Array.from(extractTerms(doc))
   };
 }
 function searchProcessor() {
@@ -3004,7 +3280,7 @@ function searchProcessor() {
     handler(context) {
       const entries = context.docs.filter(createMarkdownRenderer.isDocumentPage).filter(isIndexable).map(getTerms);
       const index = generateIndex(entries);
-      const body = JSON.stringify(index);
+      const body = JSON.stringify(index, null, 2);
       const fingerprint = createMarkdownRenderer.getFingerprint(body);
       const integrity = getIntegrity(body);
       const outputName = `search-data-[hash].json`;
@@ -3019,7 +3295,10 @@ function searchProcessor() {
         visible: false,
         attributes: {
           sortorder: Infinity,
-          redirectFrom: []
+          redirectFrom: [],
+          search: {
+            terms: []
+          }
         },
         body,
         outline: [],