@forsakringskassan/docs-generator 3.14.0 → 3.15.0

package/dist/index.d.mts

@@ -184,6 +184,28 @@ export declare interface DocumentPartialReference {
     reference: string;
 }
 
+/**
+ * Type representing the exported docs module when extracting markdown
+ * documents.
+ *
+ * @privateRemarks
+ *
+ * Changes to this interface must be kept in sync with the output generated in
+ * `writeDts()`.
+ *
+ * @public
+ * @since %version%
+ */
+export declare interface ExtractedDocsModule {
+    readonly generatorVersion: string;
+    readonly basePath: string;
+    readonly exampleFolders: string[];
+    readonly filesPath: string;
+    readonly partialsPath: string;
+    readonly linksPath: string;
+    sourceFiles(src: Partial<SourceFiles>): SourceFiles[];
+}
+
 /**
  * Options for `extractExamplesProcessor`.
  *

package/dist/index.mjs

@@ -11,6 +11,7 @@ import { exec, execSync } from 'node:child_process';
 import { g as generateId, f as formatCode, p as parseImport, a as getFingerprint, b as parseInfostring, h as hasTag, d as findTag, e as getOutputFilePath, i as isDocumentPage, j as findDocument, k as getDocumentBody, n as normalizePath, l as htmlencode, c as createMarkdownRenderer } from './create-markdown-renderer-BlUpDhJP.mjs';
 import { DocExcerpt } from '@microsoft/tsdoc';
 import fs from 'node:fs/promises';
+import pkg from '../package.json' with { type: "json" };
 import fs__default, { existsSync, readFileSync, copyFileSync } from 'node:fs';
 import { version } from 'vue';
 import { g as generateCode } from './vue3-DbJPWpmQ.mjs';
@@ -90,10 +91,11 @@ function memoize(callback) {
   };
 }
 
-function fileMatcher(patterns) {
+function fileMatcher(patterns, options) {
+  const { ignore } = options;
   const fileList = ts(patterns, {
     posix: true,
-    ignore: "**/node_modules/**"
+    ignore
   });
   return memoize((filename, context) => {
     const matches = fileList.filter((file) => {
@@ -1010,23 +1012,24 @@ async function writeIndex(options) {
     `import path from "node:path";`,
     `import { frontMatterFileReader, partialFileReader } from "@forsakringskassan/docs-generator";`,
     ``,
-    `export const basename = import.meta.dirname;`,
-    `export const exampleFolders = [path.join(basename, "files")];`,
-    `export const filesPath = path.join(basename, "files");`,
-    `export const partialsPath = [path.join(basename, "partials.json")];`,
-    `export const linksPath = [path.join(basename, "links.json")];`,
+    `export const generatorVersion = "${pkg.version}";`,
+    `export const basePath = import.meta.dirname;`,
+    `export const exampleFolders = [path.join(basePath, "files")];`,
+    `export const filesPath = path.join(basePath, "files");`,
+    `export const partialsPath = [path.join(basePath, "partials.json")];`,
+    `export const linksPath = [path.join(basePath, "links.json")];`,
     ``,
     `export function sourceFiles(src) {`,
     `    return [`,
     `        { `,
-    `            include: path.join(basename, "files/**/*.md"),`,
-    `            basename,`,
+    `            include: path.join(filesPath, "**/*.md"),`,
+    `            basePath: filesPath,`,
     `            fileReader: frontMatterFileReader,`,
     `            ...src`,
     `        },`,
     `        { `,
-    `            include: path.join(basename, "partials.json"),`,
-    `            basename,`,
+    `            include: path.join(basePath, "partials.json"),`,
+    `            basePath,`,
     `            fileReader: partialFileReader,`,
     `        }`,
     `    ];`,
@@ -1040,7 +1043,8 @@ async function writeDts(options) {
   const lines = [
     `import { SourceFiles } from "@forsakringskassan/docs-generator";`,
     ``,
-    `export declare const basename: string;`,
+    `export declare const generatorVersion: string;`,
+    `export declare const basePath: string;`,
     `export declare const exampleFolders: string[];`,
     `export declare const filesPath: string;`,
     `export declare const partialsPath: string;`,
@@ -1513,7 +1517,9 @@ function sourceUrlProcessor(...args) {
     componentFileExtension = "vue"
   } = options;
   const repository = getRepositoryUrl(pkg) ?? "";
-  const matcher = fileMatcher(sourceFiles);
+  const matcher = fileMatcher(sourceFiles, {
+    ignore: ["**/node_modules/**"]
+  });
   return {
     after: "generate-docs",
     name: "source-url-processor",
@@ -2869,6 +2875,12 @@ async function vueFileReader(filePath) {
   return [vueApi, vueTranslation];
 }
 
+async function glob(pattern) {
+  const cwd = process.cwd();
+  const iterator = fs.glob(pattern, { withFileTypes: true });
+  const ents = await Array.fromAsync(iterator);
+  return ents.filter((st) => st.isFile()).map((st) => path__default.relative(cwd, path__default.join(st.parentPath, st.name)));
+}
 async function globAll(pattern) {
   if (!pattern) {
     return /* @__PURE__ */ new Set();
@@ -2876,9 +2888,7 @@ async function globAll(pattern) {
   if (!Array.isArray(pattern)) {
     pattern = [pattern];
   }
-  const results = await Promise.all(
-    pattern.map((it) => Ze(it, { nodir: true }))
-  );
+  const results = await Promise.all(pattern.map(glob));
   return new Set(results.flat());
 }
 async function getDocumentsForSource(context, src, index) {
@@ -4372,7 +4382,7 @@ class Generator {
       ...this.processors
     ];
     const examplePatterns = this.exampleFolders.map((it) => `${it}/**/*`);
-    const exampleFileMatcher = fileMatcher(examplePatterns);
+    const exampleFileMatcher = fileMatcher(examplePatterns, { ignore: [] });
     const templateLoader = createTemplateLoader([]);
     const context = createContext({
       outputFolder: "",
@@ -4445,7 +4455,7 @@ class Generator {
     const templateLoader = createTemplateLoader(templateFolders);
     const context = createContext({
       outputFolder,
-      exampleFileMatcher: fileMatcher(examplePatterns),
+      exampleFileMatcher: fileMatcher(examplePatterns, { ignore: [] }),
       templateLoader
     });
     const generatedFiles = [