@forsakringskassan/docs-generator 3.11.0 → 3.12.0

package/dist/{format-code.worker-DJSjofVE.mjs → format-code.worker-CoZR-v_f.mjs}

@@ -2,7 +2,7 @@ import { createRequire as $createRequire } from "node:module";
 
 const require = $createRequire(import.meta.url);
 
-import { r as runAsWorker, f as format2, a as resolveConfig } from './vendor-DIj4mOXS.mjs';
+import { r as runAsWorker, f as format2, a as resolveConfig } from './vendor-BesEHnwj.mjs';
 import 'node:url';
 import 'node:path';
 import 'fs';
@@ -54,4 +54,4 @@ async function formatCode(source, filepath) {
 runAsWorker(formatCode);
 
 export { formatCode };
-//# sourceMappingURL=format-code.worker-DJSjofVE.mjs.map
+//# sourceMappingURL=format-code.worker-CoZR-v_f.mjs.map

package/dist/{format-code.worker-DJSjofVE.mjs.map → format-code.worker-CoZR-v_f.mjs.map}

@@ -1 +1 @@
-{"version":3,"file":"format-code.worker-DJSjofVE.mjs","sources":["../src/utils/format-code.worker.ts"],"sourcesContent":["import { type Options, format as prettier, resolveConfig } from \"prettier\";\nimport { runAsWorker } from \"synckit\";\n\nconst configCache = new Map<string, Options | null>();\n\nasync function getConfig(filepath: string): Promise<Options | null> {\n    const cached = configCache.get(filepath);\n    if (cached !== undefined) {\n        return cached;\n    }\n    const options = await resolveConfig(filepath);\n    configCache.set(filepath, options);\n    return options;\n}\n\n/**\n * @internal\n */\nexport async function formatCode(\n    source: string,\n    filepath: string,\n): Promise<string> {\n    const options = await getConfig(filepath);\n    const formatted = await prettier(source, { ...options, filepath });\n    return formatted.trim();\n}\n\n/* eslint-disable-next-line unicorn/no-top-level-side-effects -- required for worker to function */\nrunAsWorker(formatCode);\n"],"names":["prettier"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,MAAM,WAAA,uBAAkB,GAAA,EAA4B;AAEpD,eAAe,UAAU,QAAA,EAA2C;AAChE,EAAA,MAAM,MAAA,GAAS,WAAA,CAAY,GAAA,CAAI,QAAQ,CAAA;AACvC,EAAA,IAAI,WAAW,MAAA,EAAW;AACtB,IAAA,OAAO,MAAA;AAAA,EACX;AACA,EAAA,MAAM,OAAA,GAAU,MAAM,aAAA,CAAc,QAAQ,CAAA;AAC5C,EAAA,WAAA,CAAY,GAAA,CAAI,UAAU,OAAO,CAAA;AACjC,EAAA,OAAO,OAAA;AACX;AAKA,eAAsB,UAAA,CAClB,QACA,QAAA,EACe;AACf,EAAA,MAAM,OAAA,GAAU,MAAM,SAAA,CAAU,QAAQ,CAAA;AACxC,EAAA,MAAM,SAAA,GAAY,MAAMA,OAAA,CAAS,MAAA,EAAQ,EAAE,GAAG,OAAA,EAAS,UAAU,CAAA;AACjE,EAAA,OAAO,UAAU,IAAA,EAAK;AAC1B;AAGA,WAAA,CAAY,UAAU,CAAA;;"}
+{"version":3,"file":"format-code.worker-CoZR-v_f.mjs","sources":["../src/utils/format-code.worker.ts"],"sourcesContent":["import { type Options, format as prettier, resolveConfig } from \"prettier\";\nimport { runAsWorker } from \"synckit\";\n\nconst configCache = new Map<string, Options | null>();\n\nasync function getConfig(filepath: string): Promise<Options | null> {\n    const cached = configCache.get(filepath);\n    if (cached !== undefined) {\n        return cached;\n    }\n    const options = await resolveConfig(filepath);\n    configCache.set(filepath, options);\n    return options;\n}\n\n/**\n * @internal\n */\nexport async function formatCode(\n    source: string,\n    filepath: string,\n): Promise<string> {\n    const options = await getConfig(filepath);\n    const formatted = await prettier(source, { ...options, filepath });\n    return formatted.trim();\n}\n\n/* eslint-disable-next-line unicorn/no-top-level-side-effects -- required for worker to function */\nrunAsWorker(formatCode);\n"],"names":["prettier"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,MAAM,WAAA,uBAAkB,GAAA,EAA4B;AAEpD,eAAe,UAAU,QAAA,EAA2C;AAChE,EAAA,MAAM,MAAA,GAAS,WAAA,CAAY,GAAA,CAAI,QAAQ,CAAA;AACvC,EAAA,IAAI,WAAW,MAAA,EAAW;AACtB,IAAA,OAAO,MAAA;AAAA,EACX;AACA,EAAA,MAAM,OAAA,GAAU,MAAM,aAAA,CAAc,QAAQ,CAAA;AAC5C,EAAA,WAAA,CAAY,GAAA,CAAI,UAAU,OAAO,CAAA;AACjC,EAAA,OAAO,OAAA;AACX;AAKA,eAAsB,UAAA,CAClB,QACA,QAAA,EACe;AACf,EAAA,MAAM,OAAA,GAAU,MAAM,SAAA,CAAU,QAAQ,CAAA;AACxC,EAAA,MAAM,SAAA,GAAY,MAAMA,OAAA,CAAS,MAAA,EAAQ,EAAE,GAAG,OAAA,EAAS,UAAU,CAAA;AACjE,EAAA,OAAO,UAAU,IAAA,EAAK;AAC1B;AAGA,WAAA,CAAY,UAAU,CAAA;;"}

package/dist/index.d.mts

@@ -910,6 +910,12 @@ export declare interface SourceFiles {
     exclude?: string | string[];
     basePath?: string;
     fileReader: FileReader_2;
+    /**
+     * Only documents for which filter returns true are used.
+     *
+     * Runs before `transform`.
+     */
+    filter?(this: void, doc: Document_2): boolean;
     /**
      * Transform document before further processing.
      *

package/dist/index.mjs

@@ -3,12 +3,12 @@ import { createRequire as $createRequire } from "node:module";
 const require = $createRequire(import.meta.url);
 
 import { ApiItemKind, ApiModel } from '@microsoft/api-extractor-model';
-import { t as ts, Z as Ze, M as MarkdownItCallable, g as fm, s as strToU8, z as zlibSync, h as strFromU8, d as dedent, i as closest, j as distance, k as isCI, m as moduleImporter, l as cliProgress, n as tinylr, w as watch, o as createInstance, p as fse, q as inter } from './vendor-DIj4mOXS.mjs';
+import { t as ts, Z as Ze, M as MarkdownItCallable, g as fm, s as strToU8, z as zlibSync, h as strFromU8, d as dedent, i as closest, j as distance, k as isCI, m as moduleImporter, l as cliProgress, n as tinylr, w as watch, o as createInstance, p as fse, q as inter } from './vendor-BesEHnwj.mjs';
 import path__default from 'node:path';
 import crypto from 'node:crypto';
 import path from 'node:path/posix';
 import { exec, execSync } from 'node:child_process';
-import { g as generateId, f as formatCode, p as parseInfostring, a as getFingerprint, h as hasTag, b as parseImport, d as findTag, e as getOutputFilePath, i as isDocumentPage, j as findDocument, k as getDocumentBody, n as normalizePath, l as htmlencode, m as filePath, c as createMarkdownRenderer, o as generateExample } from './create-markdown-renderer--UwmwaiQ.mjs';
+import { g as generateId, f as formatCode, p as parseInfostring, a as getFingerprint, h as hasTag, b as parseImport, d as findTag, e as getOutputFilePath, i as isDocumentPage, j as findDocument, k as getDocumentBody, n as normalizePath, l as htmlencode, m as filePath, c as createMarkdownRenderer, o as generateExample } from './create-markdown-renderer-C7-7Tads.mjs';
 import { DocExcerpt } from '@microsoft/tsdoc';
 import fs from 'node:fs/promises';
 import util, { promisify, styleText } from 'node:util';
@@ -402,10 +402,11 @@ function getInheritance(item) {
     for (const { excerpt } of current.extendsTypes) {
       const name = getNameFromExcerpt(excerpt);
       const parentInterface = findMemberByName(name, pkg2);
-      if (parentInterface) {
-        traverseParents(parentInterface, pkg2);
-        hierarchy.push(parentInterface);
+      if (!parentInterface) {
+        continue;
       }
+      traverseParents(parentInterface, pkg2);
+      hierarchy.push(parentInterface);
     }
   }
   traverseParents(item, pkg);
@@ -1091,15 +1092,16 @@ function motdProcessor(options = {}) {
         filename: "partials/motd-container.njk.html",
         data: useLegacyTemplate ? void 0 : data
       });
-      if (useLegacyTemplate) {
-        console.warn(
-          `[deprecated] using the "partial/version-banner.html" template for motdProcessor is deprecated`
-        );
-        context.addTemplateBlock(container, "version-banner", {
-          filename: "partials/version-banner.html",
-          data
-        });
+      if (!useLegacyTemplate) {
+        return;
       }
+      console.warn(
+        `[deprecated] using the "partial/version-banner.html" template for motdProcessor is deprecated`
+      );
+      context.addTemplateBlock(container, "version-banner", {
+        filename: "partials/version-banner.html",
+        data
+      });
     }
   };
 }
@@ -2222,22 +2224,23 @@ function findTranslations(filename, content) {
   traverse(ast, {
     CallExpression(path) {
       const { node } = path;
-      if (isTranslateCall(node)) {
-        const [name, ...defaultOrParams] = node.arguments;
-        if (name.type !== "StringLiteral") {
-          return;
-        }
-        const textArgument = defaultOrParams.find(isStringLiteral);
-        const paramArgument = defaultOrParams.find(isObjectExpression);
-        const defaultTranslation = textArgument ? textArgument.value : null;
-        const docComment = findDocComment(path, node);
-        result.push({
-          name: name.value,
-          defaultTranslation,
-          description: getDescription(docComment),
-          parameters: getParameters(paramArgument)
-        });
+      if (!isTranslateCall(node)) {
+        return;
       }
+      const [name, ...defaultOrParams] = node.arguments;
+      if (name.type !== "StringLiteral") {
+        return;
+      }
+      const textArgument = defaultOrParams.find(isStringLiteral);
+      const paramArgument = defaultOrParams.find(isObjectExpression);
+      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;
@@ -2766,7 +2769,7 @@ async function globAll(pattern) {
   return new Set(results.flat());
 }
 async function getDocumentsForSource(context, src, index) {
-  const { transform } = src;
+  const { transform, filter = () => true } = src;
   const include = await globAll(src.include);
   const exclude = await globAll(src.exclude);
   const files = Array.from(difference(include, exclude));
@@ -2791,7 +2794,8 @@ async function getDocumentsForSource(context, src, index) {
       }
       return [];
     }
-    const docs2 = await src.fileReader(it, src.basePath);
+    const allDocs = await src.fileReader(it, src.basePath);
+    const docs2 = allDocs.filter(filter);
     if (transform) {
       return docs2.map((it2) => transform(it2));
     }