@forsakringskassan/docs-generator 2.15.6 → 2.16.0

package/dist/compile-example.js

@@ -3,10 +3,10 @@
 var path$1 = require('node:path');
 var esbuild = require('esbuild');
 var vue = require('vue');
-var vue3 = require('./vue3-Dgc-sSad.js');
+var vue3 = require('./vue3-B1yNeGmz.js');
 var path = require('node:path/posix');
 require('@vue/compiler-sfc');
-require('./vendor-Bxk8vVJ2.js');
+require('./vendor-BeoVq2Sv.js');
 require('node:url');
 require('fs');
 require('node:fs');

package/dist/{create-markdown-renderer-BeXKdFXE.js → create-markdown-renderer-D_yU9x5w.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-var vendor = require('./vendor-Bxk8vVJ2.js');
+var vendor = require('./vendor-BeoVq2Sv.js');
 var path = require('node:path/posix');
 var path$1 = require('node:path');
 require('crypto');
@@ -8,7 +8,7 @@ var crypto = require('node:crypto');
 require('node:child_process');
 var fs = require('node:fs');
 var vue = require('vue');
-var vue3 = require('./vue3-Dgc-sSad.js');
+var vue3 = require('./vue3-B1yNeGmz.js');
 
 function findDocument(haystack, needle) {
   const match = haystack.find((it) => {
@@ -26,6 +26,18 @@ function findDocument(haystack, needle) {
   return match ?? null;
 }
 
+function findTag(tags, tag) {
+  const match = tags.find((it) => it === tag || it.startsWith(`${tag}=`));
+  if (!match) {
+    return null;
+  }
+  if (match === tag) {
+    return { tag, value: null };
+  } else {
+    return { tag, value: match.slice(tag.length + 1) };
+  }
+}
+
 const replacements = {
   \u00E5: "a",
   \u00E4: "a",
@@ -68,6 +80,11 @@ function getOutputFilePath(outputFolder, fileInfo) {
   return normalizePath(outputFolder, path, outputName);
 }
 
+function hasTag(tags, tag) {
+  const match = tags.find((it) => it === tag || it.startsWith(`${tag}=`));
+  return Boolean(match);
+}
+
 function parseImport(raw) {
   const comments = [];
   const stripped = raw.replace(/<!--.*?-->/gms, (match) => {
@@ -260,21 +277,34 @@ function generateVueExample(options) {
     code: source,
     setupPath
   });
-  return {
-    source,
-    language: options.language,
-    comments: [],
-    tags,
-    markup,
-    output,
-    runtime: true,
-    task: {
-      outputFile: output,
-      sourcecode,
-      sourceFile: filename,
-      parent
-    }
-  };
+  if (output) {
+    return {
+      source,
+      language: options.language,
+      comments: [],
+      tags,
+      markup,
+      output,
+      runtime: true,
+      task: {
+        outputFile: output,
+        sourcecode,
+        sourceFile: filename,
+        parent
+      }
+    };
+  } else {
+    return {
+      source: sourcecode,
+      language: "plaintext",
+      comments: [],
+      tags,
+      markup,
+      output: null,
+      runtime: true,
+      task: null
+    };
+  }
 }
 function generateStaticExample(options) {
   const { filename, source, language, tags } = options;
@@ -488,7 +518,7 @@ function htmlencode(text) {
 function replaceAtLink(text) {
   return text.replace(
     /{@link [^}]+[$}]/g,
-    (match) => match.replace("{", "&lcub;").replace("}", "&rcub;")
+    (match) => match.replace(/^{/, "&lcub;").replace(/}$/, "&rcub;")
   );
 }
 
@@ -505,6 +535,23 @@ function getStandalonePath(output) {
   const { dir, name } = path$1.parse(output);
   return path$1.join(dir, `${name}.html`);
 }
+function getSource(content, language, tags, { namedExamples }) {
+  const compare = findTag(tags, "compare");
+  if (compare && compare.value !== null) {
+    const reference = namedExamples.get(compare.value);
+    if (!reference) {
+      throw new Error(
+        `Failed to find referenced example "${compare.value}"`
+      );
+    }
+    const diff = vendor.createTwoFilesPatch("a", "b", reference.content, content).split("\n").slice(3).filter((it) => !it.startsWith("@@")).join("\n");
+    return {
+      source: diff,
+      language: "diff"
+    };
+  }
+  return { source: content, language };
+}
 function codePreview(options) {
   const { generateExample } = options;
   return (md) => {
@@ -512,16 +559,33 @@ function codePreview(options) {
   };
   function fence(_md, tokens, idx, _options, env) {
     const { fileInfo } = env;
-    const { content: source, info, map } = tokens[idx];
-    const { language, tags: rawTags } = parseInfostring(info);
-    if (language === "mermaid") {
+    const { content: rawContent, info, map } = tokens[idx];
+    const { language: rawLanguage, tags: rawTags } = parseInfostring(info);
+    const name = findTag(rawTags, "name")?.value;
+    if (name) {
+      env.namedExamples.set(name, {
+        name,
+        tags: rawTags,
+        content: rawContent
+      });
+    }
+    if (hasTag(rawTags, "hidden")) {
+      return "";
+    }
+    if (rawLanguage === "mermaid") {
       return (
         /* HTML */
         `
-                <pre class="mermaid">${htmlencode(source)}</pre>
+                <pre class="mermaid">${htmlencode(rawContent)}</pre>
             `
       );
     }
+    const { source, language } = getSource(
+      rawContent,
+      rawLanguage,
+      rawTags,
+      env
+    );
     const example = generateExample({
       source,
       language,
@@ -970,7 +1034,8 @@ function createMarkdownRenderer(options) {
       path: "",
       outputName: false
     },
-    ids: /* @__PURE__ */ new Set()
+    ids: /* @__PURE__ */ new Set(),
+    namedExamples: /* @__PURE__ */ new Map()
   };
   const included = /* @__PURE__ */ new Set();
   const md = vendor.MarkdownIt({
@@ -1015,9 +1080,11 @@ function createMarkdownRenderer(options) {
 
 exports.SoftError = SoftError;
 exports.createMarkdownRenderer = createMarkdownRenderer;
+exports.findTag = findTag;
 exports.generateExample = generateExample;
 exports.generateId = generateId;
 exports.getFingerprint = getFingerprint;
 exports.getOutputFilePath = getOutputFilePath;
+exports.hasTag = hasTag;
 exports.normalizePath = normalizePath;
 exports.parseInfostring = parseInfostring;

package/dist/index.d.ts

@@ -299,6 +299,7 @@ export declare interface Manifest {
             anchor: string;
         }>;
         examples: Array<{
+            name?: string;
             selector: string;
             language: string;
             tags: string[];

package/dist/index.js

@@ -2,13 +2,14 @@
 
 var fs = require('node:fs/promises');
 var path = require('node:path/posix');
-var vendor = require('./vendor-Bxk8vVJ2.js');
+var vendor = require('./vendor-BeoVq2Sv.js');
 var path$1 = require('node:path');
 var require$$1 = require('crypto');
 require('node:crypto');
-var createMarkdownRenderer = require('./create-markdown-renderer-BeXKdFXE.js');
+var createMarkdownRenderer = require('./create-markdown-renderer-D_yU9x5w.js');
 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 fs$1 = require('node:fs');
 var sass = require('sass');
@@ -43,7 +44,7 @@ require('tls');
 require('tty');
 require('querystring');
 require('vue');
-require('./vue3-Dgc-sSad.js');
+require('./vue3-B1yNeGmz.js');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 function toArray$2(value) {
@@ -123,13 +124,16 @@ const matchHeading = /^(#+)(.*)$/gm;
 function getHeadings(text) {
   return Array.from(text.matchAll(matchHeading), parseHeading);
 }
+function cleanTitle(text) {
+  return text.trim().replaceAll("`", "");
+}
 function parseHeading(match) {
   const [, prefix, text] = match;
   const rank = prefix.length;
   const id = createMarkdownRenderer.generateId(text);
   return {
     rank,
-    title: text.trim(),
+    title: cleanTitle(text),
     anchor: id
   };
 }
@@ -269,7 +273,10 @@ md$2.renderer.rules.fence = (tokens, idx, _options, collected) => {
   if (language === "import") {
     return "";
   }
+  const nameTag = tags.find((it) => it.startsWith("name="));
+  const name = nameTag ? slugify(nameTag.slice("name=".length)) : undefined;
   collected.push({
+    name,
     content,
     language,
     tags
@@ -336,7 +343,7 @@ function extractExamplesProcessor(options) {
         for (const example of examples) {
           const suffix = getSuffix(example.tags);
           const extension = getExtension(example.language);
-          const filename = `example-${String(n++)}${suffix}.${extension}`;
+          const filename = `example-${example.name ?? String(n++)}${suffix}.${extension}`;
           const filePath = path.join(dir, filename);
           await fs.writeFile(filePath, example.content, "utf-8");
           total++;
@@ -357,7 +364,12 @@ md$1.renderer.rules.fence = (tokens, idx, _options, collected) => {
   if (language === "import") {
     extension = content.split(".").at(-1)?.trim();
   }
+  if (createMarkdownRenderer.hasTag(tags, "hidden")) {
+    return "";
+  }
+  const name = createMarkdownRenderer.findTag(tags, "name")?.value ?? undefined;
   collected.push({
+    name,
     selector: `#example-${fingerprint}`,
     language: extension ?? language,
     tags
@@ -872,6 +884,79 @@ function defineSources(sources) {
   return sources;
 }
 
+const documentAttributeKeys = [
+  "title",
+  "short-title",
+  "layout",
+  "name",
+  "alias",
+  "status",
+  "visible",
+  "include",
+  "component",
+  "href",
+  "sortorder",
+  "redirect_from"
+];
+
+const threshold = 3;
+const suggestions = {
+  hidden: "visible"
+};
+function findLocation(content, attr) {
+  const match = content.match(/^---\n(.*?)^---/ms);
+  if (!match || match.index !== 0) {
+    return null;
+  }
+  const yaml = match[1];
+  const lines = yaml.split("\n");
+  const index = lines.findIndex((it) => it.startsWith(`${attr}:`));
+  if (index < 0) {
+    return null;
+  }
+  const blockBegin = 2;
+  return {
+    start: { line: index + blockBegin, column: 1 },
+    end: { line: index + blockBegin, column: 1 + attr.length }
+  };
+}
+function getSuggestion(attribute) {
+  const manual = suggestions[attribute];
+  if (manual) {
+    return [manual, 0];
+  }
+  const closestKey = vendor.closest(attribute, documentAttributeKeys);
+  const d = vendor.distance(attribute, closestKey);
+  return [closestKey, d];
+}
+class AttributeError extends Error {
+  attribute;
+  content;
+  constructor(options) {
+    const { attribute, filePath, content } = options;
+    super(`Unknown attribute "${attribute}" in "${filePath}"`);
+    this.name = "AttributeError";
+    this.attribute = attribute;
+    this.content = content;
+  }
+  prettyError() {
+    const { attribute, content, message } = this;
+    const [closestMatch, d] = getSuggestion(attribute);
+    const suggestion = d <= threshold ? `Did you mean to use "${closestMatch}"?` : `Unknown attribute "${attribute}"`;
+    const location = findLocation(content, attribute);
+    if (location) {
+      const codeframe = codeFrame.codeFrameColumns(content, location, {
+        message: suggestion
+      });
+      return [message, "", codeframe].join("\n");
+    } else if (d <= threshold) {
+      return [message, "", suggestion].join("\n");
+    } else {
+      return message;
+    }
+  }
+}
+
 function toArray$1(value) {
   return Array.isArray(value) ? value : [value];
 }
@@ -906,26 +991,44 @@ function getBadge(attrs) {
       return "info";
   }
 }
-function getComponentAlias(attrs) {
-  if (attrs.component) {
-    return toArray$1(attrs.component).map((it) => `component:${it}`);
+function validateAttributes(attributes, filePath, content) {
+  for (const key of Object.keys(attributes)) {
+    if (documentAttributeKeys.includes(key)) {
+      continue;
+    }
+    throw new AttributeError({
+      attribute: key,
+      filePath,
+      content
+    });
+  }
+}
+function normalizeComponent(value) {
+  if (typeof value === "string") {
+    return {
+      name: value
+    };
   } else {
-    return [];
+    return value;
+  }
+}
+function getComponentAlias(value) {
+  const { name } = normalizeComponent(value);
+  return `component:${name}`;
+}
+function* getDocumentAlias(attrs) {
+  if (attrs.alias) {
+    yield* toArray$1(attrs.alias);
+  }
+  if (attrs.component) {
+    yield* toArray$1(attrs.component).map(getComponentAlias);
   }
 }
 function getComponent(attrs) {
   if (!attrs.component) {
     return undefined;
   }
-  return toArray$1(attrs.component).map((it) => {
-    if (typeof it === "string") {
-      return {
-        name: it
-      };
-    } else {
-      return it;
-    }
-  });
+  return toArray$1(attrs.component).map(normalizeComponent);
 }
 function parseFile$1(filePath, basePath, content) {
   const relative = basePath ? path$1.relative(basePath, createMarkdownRenderer.normalizePath(filePath)) : createMarkdownRenderer.normalizePath(filePath);
@@ -938,10 +1041,11 @@ function parseFile$1(filePath, basePath, content) {
   const urlpath = parsed.dir;
   const outline = getDocumentOutline(blocks.body);
   const include = attributes.include ?? true;
+  validateAttributes(attributes, filePath, content);
   return {
     id: `fs:${filePath.replace(/\\/g, "/")}`,
     name,
-    alias: [...getComponentAlias(attributes)],
+    alias: Array.from(getDocumentAlias(attributes)),
     visible: attributes.visible ?? true,
     attributes: {
       title: attributes.title ?? name,
@@ -974,6 +1078,36 @@ async function frontMatterFileReader(filePath, basePath) {
 
 const EMPTY_CHAR = "&#8208;";
 const EM_DASH = "&#8212;";
+function getPropSlotDeprecated(prop) {
+  const tags = prop.tags;
+  if (!tags) {
+    return EMPTY_CHAR;
+  }
+  const tag = tags["deprecated"]?.[0];
+  if (!tag?.description) {
+    return EMPTY_CHAR;
+  }
+  if (tag.description === true) {
+    return "true";
+  } else {
+    return tag.description;
+  }
+}
+function getEventDeprecated(event) {
+  const tags = event.tags;
+  if (!tags) {
+    return EMPTY_CHAR;
+  }
+  const tag = tags.find((it) => it.title === "deprecated");
+  if (!tag?.content) {
+    return EMPTY_CHAR;
+  }
+  if (tag.content === true) {
+    return "true";
+  } else {
+    return tag.content;
+  }
+}
 function translateProps(props) {
   const translatedProps = [];
   for (const prop of props) {
@@ -982,7 +1116,8 @@ function translateProps(props) {
       description: prop.description ?? EMPTY_CHAR,
       type: prop.type?.name ?? EMPTY_CHAR,
       required: prop.required ? "true" : "false",
-      default: prop.defaultValue?.value ?? EMPTY_CHAR
+      default: prop.defaultValue?.value ?? EMPTY_CHAR,
+      deprecated: getPropSlotDeprecated(prop)
     };
     translatedProps.push(translatedProp);
   }
@@ -994,7 +1129,8 @@ function translateEvents(events) {
     const translatedEvent = {
       name: event.name,
       description: event.description ?? EMPTY_CHAR,
-      properties: translateEventProperties(event)
+      properties: translateEventProperties(event),
+      deprecated: getEventDeprecated(event)
     };
     translatedEvents.push(translatedEvent);
   }
@@ -1028,7 +1164,8 @@ function translateSlots(slots) {
     const translatedSlot = {
       name: slot.name,
       description: slot.description ?? EMPTY_CHAR,
-      bindings: translateSlotBindings(slot)
+      bindings: translateSlotBindings(slot),
+      deprecated: getPropSlotDeprecated(slot)
     };
     translatedSlots.push(translatedSlot);
   }
@@ -1040,7 +1177,10 @@ function translateSlotBindings(slot) {
   }
   const translatedBindings = [];
   for (const binding of slot.bindings) {
-    translatedBindings.push(binding.name ? binding.name : EMPTY_CHAR);
+    const name = binding.name ?? EMPTY_CHAR;
+    const type = binding.type ? `: ${binding.type.name}` : "";
+    const description = binding.description ? ` ${EM_DASH} ${binding.description}` : "";
+    translatedBindings.push(`${name}${type}${description}`);
   }
   return translatedBindings.join("\n");
 }
@@ -1814,6 +1954,31 @@ function findTemplate(folders, from, src, format) {
   return template;
 }
 
+const messageRegex = /^[(][^)]+[)] \[Line \d+, Column \d+\]\n\s+Error: (.*)$/;
+function getActualMessage(message) {
+  const match = message.match(messageRegex);
+  if (match) {
+    return match[1].trim();
+  } else {
+    return message;
+  }
+}
+class TemplateRenderError extends Error {
+  filename;
+  constructor(message, filename) {
+    super(getActualMessage(message));
+    this.name = "RenderError";
+    this.filename = filename;
+  }
+  prettyError() {
+    return [
+      `An error occured when rendering a document.`,
+      `  Document: "${this.filename}".`,
+      `  Message: ${this.message}`
+    ].join("\n");
+  }
+}
+
 const scriptPath = path$1.join(__dirname, "compile-example.js");
 let loader = null;
 function haveOutputFile(fileInfo) {
@@ -2016,7 +2181,11 @@ async function render(doc, docs, nav, vendors, options) {
   try {
     content = await renderTemplate(template, templateData);
   } catch (err) {
-    const prefix = `Failed to render "${fileInfo.fullPath}"`;
+    const filename = fileInfo.fullPath;
+    if (err instanceof Error && err.name === "Template render error") {
+      throw new TemplateRenderError(err.message, filename);
+    }
+    const prefix = `Failed to render "${filename}"`;
     const message = err instanceof Error ? err.message : String(err);
     throw new Error(`${prefix}: ${message}`, { cause: err });
   }

package/dist/markdown.js

@@ -1,7 +1,7 @@
 'use strict';
 
-var createMarkdownRenderer = require('./create-markdown-renderer-BeXKdFXE.js');
-require('./vendor-Bxk8vVJ2.js');
+var createMarkdownRenderer = require('./create-markdown-renderer-D_yU9x5w.js');
+require('./vendor-BeoVq2Sv.js');
 require('node:url');
 require('node:path');
 require('fs');
@@ -37,7 +37,7 @@ require('querystring');
 require('node:path/posix');
 require('node:crypto');
 require('vue');
-require('./vue3-Dgc-sSad.js');
+require('./vue3-B1yNeGmz.js');
 
 
 

package/dist/processors/selectable-version.js

@@ -334,6 +334,17 @@ var require_semver = __commonJS({
       // preminor will bump the version up to the next minor release, and immediately
       // down to pre-release. premajor and prepatch work the same way.
       inc(release, identifier, identifierBase) {
+        if (release.startsWith("pre")) {
+          if (!identifier && identifierBase === false) {
+            throw new Error("invalid increment argument: identifier is empty");
+          }
+          if (identifier) {
+            const match = `-${identifier}`.match(this.options.loose ? re[t.PRERELEASELOOSE] : re[t.PRERELEASE]);
+            if (!match || match[1] !== identifier) {
+              throw new Error(`invalid identifier: ${identifier}`);
+            }
+          }
+        }
         switch (release) {
           case "premajor":
             this.prerelease.length = 0;
@@ -361,6 +372,12 @@ var require_semver = __commonJS({
             }
             this.inc("pre", identifier, identifierBase);
             break;
+          case "release":
+            if (this.prerelease.length === 0) {
+              throw new Error(`version ${this.raw} is not a prerelease`);
+            }
+            this.prerelease.length = 0;
+            break;
           case "major":
             if (this.minor !== 0 || this.patch !== 0 || this.prerelease.length === 0) {
               this.major++;
@@ -386,9 +403,6 @@ var require_semver = __commonJS({
           // 1.0.0 'pre' would become 1.0.0-0 which is the wrong direction.
           case "pre": {
             const base = Number(identifierBase) ? 1 : 0;
-            if (!identifier && identifierBase === false) {
-              throw new Error("invalid increment argument: identifier is empty");
-            }
             if (this.prerelease.length === 0) {
               this.prerelease = [base];
             } else {
@@ -523,13 +537,12 @@ var require_diff = __commonJS({
         if (!lowVersion.patch && !lowVersion.minor) {
           return "major";
         }
-        if (highVersion.patch) {
+        if (lowVersion.compareMain(highVersion) === 0) {
+          if (lowVersion.minor && !lowVersion.patch) {
+            return "minor";
+          }
           return "patch";
         }
-        if (highVersion.minor) {
-          return "minor";
-        }
-        return "major";
       }
       const prefix = highHasPre ? "pre" : "";
       if (v1.major !== v2.major) {