@forsakringskassan/docs-generator 2.17.1 → 2.19.0

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-BHA4LIog.js');
+var createMarkdownRenderer = require('./create-markdown-renderer-CbE5KJoX.js');
 var path$1 = require('node:path');
 var require$$1 = require('crypto');
 require('node:crypto');
-var createMarkdownRenderer = require('./create-markdown-renderer-2ejm6Tub.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-BhdC7RZQ.js');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 function toArray$2(value) {
@@ -70,6 +70,21 @@ function matomoProcessor(options) {
   };
 }
 
+const documentAttributeKeys = [
+  "title",
+  "short-title",
+  "layout",
+  "name",
+  "alias",
+  "status",
+  "visible",
+  "include",
+  "component",
+  "href",
+  "sortorder",
+  "redirect_from"
+];
+
 function cacheKey$1(...args) {
   return JSON.stringify(args);
 }
@@ -167,14 +182,14 @@ function getPullRequestID(env) {
   if (env.JOB_BASE_NAME) {
     const name = env.JOB_BASE_NAME;
     const match = name.match(/^PR-(\d+)$/);
-    return match ? match[1] : undefined;
+    return match ? match[1] : void 0;
   }
   if (env.GITHUB_REF) {
     const name = env.GITHUB_REF;
     const match = name.match(/^refs\/pull\/([^/]+)\/merge$/);
-    return match ? match[1] : undefined;
+    return match ? match[1] : void 0;
   }
-  return undefined;
+  return void 0;
 }
 
 const RE_MATCH_SSH = /^(ssh:\/\/)?(?<user>[^@]+)@(?<host>[^:]+):(?<path>.*)$/;
@@ -274,7 +289,7 @@ md$4.renderer.rules.fence = (tokens, idx, _options, collected) => {
     return "";
   }
   const nameTag = tags.find((it) => it.startsWith("name="));
-  const name = nameTag ? slugify(nameTag.slice("name=".length)) : undefined;
+  const name = nameTag ? slugify(nameTag.slice("name=".length)) : void 0;
   collected.push({
     name,
     content,
@@ -331,8 +346,9 @@ function extractExamplesProcessor(options) {
         );
       }
       await fs.rm(outputFolder, { recursive: true, force: true });
+      const docs = context.docs.filter(createMarkdownRenderer.isDocumentPage).filter(haveOutput);
       let total = 0;
-      for (const doc of context.docs.filter(haveOutput)) {
+      for (const doc of docs) {
         const examples = findExamples$1(doc).filter(isRelevant);
         if (examples.length === 0) {
           continue;
@@ -360,14 +376,14 @@ md$3.renderer.rules.fence = (tokens, idx, _options, collected) => {
   const { language, tags } = createMarkdownRenderer.parseInfostring(info);
   const hashContent = `${map?.[0]}:${map?.[1]}:${info}:${content}`;
   const fingerprint = createMarkdownRenderer.getFingerprint(hashContent);
-  let extension = undefined;
+  let extension = void 0;
   if (language === "import") {
     extension = content.split(".").at(-1)?.trim();
   }
   if (createMarkdownRenderer.hasTag(tags, "hidden")) {
     return "";
   }
-  const name = createMarkdownRenderer.findTag(tags, "name")?.value ?? undefined;
+  const name = createMarkdownRenderer.findTag(tags, "name")?.value ?? void 0;
   collected.push({
     name,
     selector: `#example-${fingerprint}`,
@@ -424,21 +440,48 @@ 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",
     async handler(context) {
-      const docs = context.docs.filter(haveOutput);
+      const docs = context.docs.filter(createMarkdownRenderer.isDocumentPage).filter(haveOutput);
       const pages = docs.map(manifestPageFromDocument);
       pages.sort((a, b) => {
         return a.path.localeCompare(b.path);
       });
       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);
@@ -452,7 +495,7 @@ function normalizeOptions(options) {
   const defaults = {
     enabled: true,
     container: "body:begin",
-    message: undefined
+    message: void 0
   };
   return { ...defaults, ...options };
 }
@@ -474,7 +517,7 @@ function motdProcessor(options = {}) {
       };
       context.addTemplateBlock(container, "motd-container", {
         filename: "partials/motd-container.njk.html",
-        data: useLegacyTemplate ? undefined : data
+        data: useLegacyTemplate ? void 0 : data
       });
       if (useLegacyTemplate) {
         console.warn(
@@ -582,7 +625,7 @@ function htmlRedirectProcessor() {
     after: "render",
     async handler(context) {
       const { docs, outputFolder } = context;
-      for (const doc of docs.filter(haveOutput)) {
+      for (const doc of docs.filter(createMarkdownRenderer.isDocumentPage).filter(haveOutput)) {
         if (doc.format !== "redirect") {
           continue;
         }
@@ -605,7 +648,7 @@ function redirectFileProcessor(prefix = "/", filename = "_redirects") {
     after: "render",
     async handler(context) {
       const { docs } = context;
-      const lines = docs.filter(haveOutput).filter(isRedirect).map((doc) => {
+      const lines = docs.filter(createMarkdownRenderer.isDocumentPage).filter(haveOutput).filter(isRedirect).map((doc) => {
         const src = createMarkdownRenderer.normalizePath(
           doc.fileInfo.path,
           doc.fileInfo.outputName
@@ -623,7 +666,7 @@ function redirectFileProcessor(prefix = "/", filename = "_redirects") {
 }
 
 function getRedirects(docs) {
-  return docs.map((it) => {
+  return docs.filter(createMarkdownRenderer.isDocumentPage).map((it) => {
     const { fileInfo } = it;
     const { path, outputName } = fileInfo;
     if (outputName === false) {
@@ -647,6 +690,7 @@ function redirectProcessor() {
       for (const redirect of redirects) {
         const { dir, base, name } = path.parse(redirect.from);
         context.addDocument({
+          kind: "page",
           id: `redirect:${redirect.from}-${redirect.to}`,
           name: `${redirect.from}-${redirect.to}`,
           alias: [],
@@ -767,7 +811,7 @@ async function getSCMData(pkg, options) {
   const { homepage } = pkg;
   const repository = getRepositoryUrl(pkg) ?? "";
   const pr = getPullRequestID(process.env);
-  const prUrl = pr ? interpolate(options.prUrlFormat, { homepage, pr, repository }) : undefined;
+  const prUrl = pr ? interpolate(options.prUrlFormat, { homepage, pr, repository }) : void 0;
   return {
     branch: await getGitBranch(),
     commitShort,
@@ -884,21 +928,6 @@ 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"
@@ -975,7 +1004,7 @@ function isIndexPage(parsed) {
 }
 function getBadge(attrs) {
   if (!attrs.status) {
-    return undefined;
+    return void 0;
   }
   switch (attrs.status) {
     case "Produktionsklar":
@@ -1026,7 +1055,7 @@ function* getDocumentAlias(attrs) {
 }
 function getComponent(attrs) {
   if (!attrs.component) {
-    return undefined;
+    return void 0;
   }
   return toArray$1(attrs.component).map(normalizeComponent);
 }
@@ -1043,6 +1072,7 @@ function parseFile$1(filePath, basePath, content) {
   const include = attributes.include ?? true;
   validateAttributes(attributes, filePath, content);
   return {
+    kind: "page",
     id: `fs:${filePath.replace(/\\/g, "/")}`,
     name,
     alias: Array.from(getDocumentAlias(attributes)),
@@ -1384,21 +1414,14 @@ function parseAPI(filePath, api) {
     html += generateSlotTable(api.slug, api.slots);
   }
   return {
+    kind: "partial",
     id: `fs:${filePath.replace(/\\/g, "/")}`,
     name: `vue:${componentName}`,
     alias: [],
-    visible: false,
-    attributes: { sortorder: Infinity, redirectFrom: [] },
     body: html,
-    outline: [],
     format: "html",
-    tags: [],
-    template: "",
     fileInfo: {
-      path: "",
-      name: "",
-      fullPath: "",
-      outputName: false
+      fullPath: filePath
     }
   };
 }
@@ -1464,6 +1487,7 @@ function parseFile(filePath, basePath, content) {
   const name = parsed.name;
   const urlpath = parsed.dir;
   return {
+    kind: "page",
     id: `nav:${filePath.replace(/\\/g, "/")}`,
     name,
     alias: [],
@@ -1932,7 +1956,8 @@ function navigationProcessor() {
     stage: "generate-nav",
     name: "navigation-processor",
     handler(context) {
-      const navtree = generateNavtree(context.docs);
+      const pages = context.docs.filter(createMarkdownRenderer.isDocumentPage);
+      const navtree = generateNavtree(pages);
       context.setTopNavigation(navtree);
       context.setSideNavigation(navtree);
     }
@@ -2091,9 +2116,14 @@ class TemplateRenderError extends Error {
   }
   prettyError() {
     return [
+      "",
       `An error occured when rendering a document.`,
       `  Document: "${this.filename}".`,
-      `  Message: ${this.message}`
+      `  Message: ${this.message}`,
+      "",
+      "---",
+      "",
+      this.stack
     ].join("\n");
   }
 }
@@ -2375,7 +2405,7 @@ function nunjucksProcessor(options) {
         });
       }
       const formats = ["markdown", "json"];
-      const docs = context.docs.filter((it) => {
+      const docs = context.docs.filter(createMarkdownRenderer.isDocumentPage).filter((it) => {
         if (!formats.includes(it.format)) {
           return false;
         }
@@ -2467,7 +2497,7 @@ async function compileVendor(assetFolder, vendor, options) {
       __VUE_PROD_DEVTOOLS__: "true",
       __VUE_PROD_HYDRATION_MISMATCH_DETAILS__: "false"
     },
-    alias: vendor.alias ? { [`${vendor.package}`]: vendor.alias } : undefined,
+    alias: vendor.alias ? { [`${vendor.package}`]: vendor.alias } : void 0,
     ...options
   });
   const content = await fs.readFile(outfile, "utf-8");
@@ -2490,7 +2520,7 @@ function normalizeVendorDefinition(vendor) {
   if (typeof vendor === "string") {
     return {
       package: vendor,
-      global: undefined,
+      global: void 0,
       expose: "named",
       subpaths: []
     };
@@ -2500,7 +2530,7 @@ function normalizeVendorDefinition(vendor) {
       global: vendor.global,
       expose: vendor.expose ?? "named",
       subpaths: vendor.subpaths ?? [],
-      alias: vendor.alias ?? undefined
+      alias: vendor.alias ?? void 0
     };
   }
 }
@@ -2861,7 +2891,7 @@ class Generator {
     const templateLoader = createTemplateLoader([]);
     const context = createContext("", templateLoader);
     await stage("generate-docs", context, processors, { verbose: false });
-    const docs = context.docs.filter(haveOutput);
+    const docs = context.docs.filter(createMarkdownRenderer.isDocumentPage).filter(haveOutput);
     const pages = docs.map(manifestPageFromDocument);
     return { pages };
   }
@@ -2974,9 +3004,8 @@ function extractTerms(doc) {
   }
 }
 function isIndexable(doc) {
-  return Boolean(
-    doc.visible && doc.fileInfo.outputName && doc.format !== "redirect"
-  );
+  const { visible, fileInfo, format } = doc;
+  return Boolean(visible && fileInfo.outputName && format !== "redirect");
 }
 function getTerms(doc) {
   return {
@@ -2990,7 +3019,7 @@ function searchProcessor() {
     after: "generate-docs",
     name: "search-processor",
     handler(context) {
-      const entries = context.docs.filter(isIndexable).map(getTerms);
+      const entries = context.docs.filter(createMarkdownRenderer.isDocumentPage).filter(isIndexable).map(getTerms);
       const index = generateIndex(entries);
       const body = JSON.stringify(index);
       const fingerprint = createMarkdownRenderer.getFingerprint(body);
@@ -3000,6 +3029,7 @@ function searchProcessor() {
       context.setTemplateData("searchDataUrl", expandedName);
       context.setTemplateData("searchDataIntegrity", integrity);
       context.addDocument({
+        kind: "page",
         id: "search:data",
         name: "search-data",
         alias: [],
@@ -3053,3 +3083,4 @@ exports.topnavProcessor = topnavProcessor;
 exports.versionBannerProcessor = versionBannerProcessor;
 exports.versionProcessor = versionProcessor;
 exports.vueFileReader = vueFileReader;
+//# sourceMappingURL=index.js.map