@forsakringskassan/docs-generator 2.17.0 → 2.18.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-B1yNeGmz.js');
+var vue3 = require('./vue3-CEAR7ggN.js');
 var path = require('node:path/posix');
 require('@vue/compiler-sfc');
-require('./vendor-BeoVq2Sv.js');
+require('./vendor-Bagon7WF.js');
 require('node:url');
 require('fs');
 require('node:fs');

package/dist/{create-markdown-renderer-Bj0NKzgi.js → create-markdown-renderer-CaJTFjAd.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-var vendor = require('./vendor-BeoVq2Sv.js');
+var vendor = require('./vendor-Bagon7WF.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-B1yNeGmz.js');
+var vue3 = require('./vue3-CEAR7ggN.js');
 
 function findDocument(haystack, needle) {
   const match = haystack.find((it) => {
@@ -85,6 +85,19 @@ function hasTag(tags, tag) {
   return Boolean(match);
 }
 
+const replacement = {
+  "<": `&lt;`,
+  ">": `&gt;`,
+  "&": `&amp;`,
+  '"': `&quot;`,
+  "'": `&apos;`
+};
+function htmlencode(text) {
+  return text.replace(/[<>&"']/g, (m) => {
+    return replacement[m];
+  });
+}
+
 function parseImport(raw) {
   const comments = [];
   const stripped = raw.replace(/<!--.*?-->/gms, (match) => {
@@ -502,19 +515,6 @@ function highlight({
   }
 }
 
-const replacement = {
-  "<": `&lt;`,
-  ">": `&gt;`,
-  "&": `&amp;`,
-  '"': `&quot;`,
-  "'": `&apos;`
-};
-function htmlencode(text) {
-  return text.replace(/[<>&"']/g, (m) => {
-    return replacement[m];
-  });
-}
-
 function replaceAtLink(text) {
   return text.replace(
     /{@link [^}]+[$}]/g,
@@ -538,13 +538,18 @@ function getStandalonePath(output) {
 function getSource(content, language, tags, { namedExamples }) {
   const compare = findTag(tags, "compare");
   if (compare && compare.value !== null) {
+    const { value: context } = findTag(tags, "context") ?? {};
     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");
+    const a = transformCode(reference.content, reference.language);
+    const b = transformCode(content, language);
+    const diff = vendor.createTwoFilesPatch("a", "b", a, b, "", "", {
+      context: context ? parseInt(context, 10) : 3
+    }).split("\n").slice(4).join("\n");
     return {
       source: diff,
       language: "diff"
@@ -566,7 +571,8 @@ function codePreview(options) {
       env.namedExamples.set(name, {
         name,
         tags: rawTags,
-        content: rawContent
+        content: rawContent,
+        language: rawLanguage
       });
     }
     if (hasTag(rawTags, "hidden")) {
@@ -1092,5 +1098,6 @@ exports.generateId = generateId;
 exports.getFingerprint = getFingerprint;
 exports.getOutputFilePath = getOutputFilePath;
 exports.hasTag = hasTag;
+exports.htmlencode = htmlencode;
 exports.normalizePath = normalizePath;
 exports.parseInfostring = parseInfostring;

package/dist/index.d.ts

@@ -325,6 +325,9 @@ export declare interface ManifestProcessorOptions {
     markdown?: string;
     /** If set, the manifest will be written as JSON to this destination */
     json?: string;
+    /** If set to `true` the markdown manifest will be verified instead of
+     * written (typically enabled during CI) */
+    verify?: boolean;
 }
 
 /**

package/dist/index.js

@@ -2,11 +2,11 @@
 
 var fs = require('node:fs/promises');
 var path = require('node:path/posix');
-var vendor = require('./vendor-BeoVq2Sv.js');
+var vendor = require('./vendor-Bagon7WF.js');
 var path$1 = require('node:path');
 var require$$1 = require('crypto');
 require('node:crypto');
-var createMarkdownRenderer = require('./create-markdown-renderer-Bj0NKzgi.js');
+var createMarkdownRenderer = require('./create-markdown-renderer-CaJTFjAd.js');
 var node_child_process = require('node:child_process');
 var util = require('node:util');
 var codeFrame = require('@babel/code-frame');
@@ -44,7 +44,7 @@ require('tls');
 require('tty');
 require('querystring');
 require('vue');
-require('./vue3-B1yNeGmz.js');
+require('./vue3-CEAR7ggN.js');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 function toArray$2(value) {
@@ -424,8 +424,26 @@ function renderMarkdown(manifest) {
 function renderJSON(manifest) {
   return JSON.stringify(manifest, null, 2);
 }
+function normalize(text) {
+  return text.replace(/\r\n/g, "\n");
+}
+class ManifestError extends Error {
+  filename;
+  constructor(filename) {
+    super(`Documentation manifest "${filename}" is not up-to-date!`);
+    this.filename = filename;
+  }
+  prettyError() {
+    const { filename, message } = this;
+    return [
+      message,
+      "",
+      `Run the build locally and commit the content of "${filename}".`
+    ].join("\n");
+  }
+}
 function manifestProcessor(options = {}) {
-  const { markdown, json } = options;
+  const { markdown, json, verify } = options;
   return {
     name: "manifestProcessor",
     before: "render",
@@ -437,8 +455,17 @@ function manifestProcessor(options = {}) {
       });
       const manifest = { pages };
       if (markdown) {
-        const content = renderMarkdown(manifest);
-        await fs.writeFile(markdown, content, "utf-8");
+        const content = normalize(renderMarkdown(manifest));
+        if (verify) {
+          const actual = normalize(
+            await fs.readFile(markdown, "utf-8")
+          );
+          if (actual !== content) {
+            throw new ManifestError(markdown);
+          }
+        } else {
+          await fs.writeFile(markdown, content, "utf-8");
+        }
       }
       if (json) {
         const content = renderJSON(manifest);
@@ -1231,15 +1258,16 @@ function generatePropTable(slug, props) {
         <dl class="docs-api docs-api--slots">
             ${props.map((prop) => {
       const { name } = prop;
-      const id = `${slug}-slot-${name}`;
+      const id = `${slug}-prop-${slugify(name)}`;
       return (
         /* HTML */
         `
                         <dt>
                             <code id="${id}"
                                 ><a class="docs-api__anchor" href="#${id}"
-                                    ><span class="docs-api__name">${name}</span
-                                    >: ${prop.type}</a
+                                    ><span class="docs-api__name"
+                                        >${createMarkdownRenderer.htmlencode(name)}</span
+                                    >: ${createMarkdownRenderer.htmlencode(prop.type ?? "unknown")}</a
                                 ></code
                             >
                             ${prop.required ? "" : `<span class="docs-tag docs-tag--default">Optional</span>`}
@@ -1247,7 +1275,7 @@ function generatePropTable(slug, props) {
                         </dt>
                         <dd>
                             ${render$3(prop.description)}
-                            ${prop.default ? `<p class="doc-api__item">Default: <code>${prop.default.value}</code></p>` : ""}
+                            ${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>` : ""}
                         </dd>
                     `
@@ -1277,7 +1305,7 @@ function generateEventTable(slug, events) {
         <dl class="docs-api docs-api--events">
             ${events.map((event) => {
       const { name } = event;
-      const id = `${slug}-event-${name}`;
+      const id = `${slug}-event-${slugify(name)}`;
       const haveProperties = event.properties.length > 0;
       return (
         /* HTML */
@@ -1286,7 +1314,7 @@ function generateEventTable(slug, events) {
                             <code id="${id}"
                                 ><a class="docs-api__anchor" href="#${id}"
                                     ><span class="docs-api__name"
-                                        >${name}</span
+                                        >${createMarkdownRenderer.htmlencode(name)}</span
                                     ></a
                                 ></code
                             >
@@ -1297,9 +1325,9 @@ function generateEventTable(slug, events) {
                             ${haveProperties ? `<p class="docs-api__list-title">Arguments:</p><ul class="docs-api__list">` : ""}
                             ${event.properties.map((it) => {
           if (it.description) {
-            return `<li><code>${it.name}: ${it.type}</code> ${EM_DASH$1} ${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>${it.name}: ${it.type}</code></li>`;
+            return `<li><code>${createMarkdownRenderer.htmlencode(it.name)}: ${createMarkdownRenderer.htmlencode(it.type ?? "unknown")}</code></li>`;
           }
         }).join("")}
                             ${haveProperties ? `</ul>` : ""}
@@ -1332,7 +1360,7 @@ function generateSlotTable(slug, slots) {
         <dl class="docs-api docs-api--slots">
             ${slots.map((slot) => {
       const { name } = slot;
-      const id = `${slug}-slot-${name}`;
+      const id = `${slug}-slot-${slugify(name)}`;
       const haveBindings = slot.bindings.length > 0;
       return (
         /* HTML */
@@ -1341,7 +1369,7 @@ function generateSlotTable(slug, slots) {
                             <code id="${id}"
                                 ><a class="docs-api__anchor" href="#${id}"
                                     ><span class="docs-api__name"
-                                        >${name}</span
+                                        >${createMarkdownRenderer.htmlencode(name)}</span
                                     ></a
                                 ></code
                             >
@@ -1352,9 +1380,9 @@ function generateSlotTable(slug, slots) {
                             ${haveBindings ? `<p class="docs-api__list-title">Bindings:</p><ul class="docs-api__list">` : ""}
                             ${slot.bindings.map((it) => {
           if (it.description) {
-            return `<li><code>${it.name}: ${it.type}</code> ${EM_DASH} ${it.description}</li>`;
+            return `<li><code>${createMarkdownRenderer.htmlencode(it.name)}: ${createMarkdownRenderer.htmlencode(it.type ?? "unknown")}</code> ${EM_DASH} ${renderInline(it.description)}</li>`;
           } else {
-            return `<li><code>${it.name}: ${it.type}</code></li>`;
+            return `<li><code>${createMarkdownRenderer.htmlencode(it.name)}: ${createMarkdownRenderer.htmlencode(it.type ?? "unknown")}</code></li>`;
           }
         }).join("")}
                             ${haveBindings ? `</ul>` : ""}

package/dist/markdown.js

@@ -1,7 +1,7 @@
 'use strict';
 
-var createMarkdownRenderer = require('./create-markdown-renderer-Bj0NKzgi.js');
-require('./vendor-BeoVq2Sv.js');
+var createMarkdownRenderer = require('./create-markdown-renderer-CaJTFjAd.js');
+require('./vendor-Bagon7WF.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-B1yNeGmz.js');
+require('./vue3-CEAR7ggN.js');
 
 
 

package/dist/{vendor-BeoVq2Sv.js → vendor-Bagon7WF.js}

@@ -26515,6 +26515,11 @@ function formatPatch(diff) {
 }
 function createTwoFilesPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader, options) {
   var _options2;
+  if (typeof options === 'function') {
+    options = {
+      callback: options
+    };
+  }
   if (!((_options2 = options) !== null && _options2 !== undefined && _options2.callback)) {
     var patchObj = structuredPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader, options);
     if (!patchObj) {

package/dist/{vue3-B1yNeGmz.js → vue3-CEAR7ggN.js}

@@ -1,7 +1,7 @@
 'use strict';
 
 var require$$0 = require('@vue/compiler-sfc');
-require('./vendor-BeoVq2Sv.js');
+require('./vendor-Bagon7WF.js');
 
 var __create = Object.create;
 var __defProp = Object.defineProperty;

package/package.json

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