@visulima/packem 2.0.0-alpha.40 → 2.0.0-alpha.43

package/dist/builder/typedoc/index.js

@@ -1,3 +1,160 @@
-var j=Object.defineProperty;var g=(e,o)=>j(e,"name",{value:o,configurable:!0});import{cyan as v}from"@visulima/colorize";import{join as h}from"@visulima/path";import{p as $,d as P}from"../../packem_shared/create-or-update-key-storage-GwAIWW7R.js";import{readdirSync as A}from"node:fs";import{readFileSync as w,writeFileSync as F}from"@visulima/fs";import{Application as b}from"typedoc";var T=Object.defineProperty,_=g((e,o)=>T(e,"name",{value:o,configurable:!0}),"w");const C=_(async(e,o,a,s)=>{if(o.length===0)return;const{format:t,jsonFileName:n,marker:i,output:x,plugin:k,readmePath:p,...y}=e;if(t==="inline"&&p===void 0)throw new Error("The `readmePath` option is required when using the `inline` format.");if(t!=="inline"&&typeof p=="string"&&s.warn({message:"The `readmePath` option is only used when the `inline` format is used.",prefix:"typedoc"}),t==="json"){if(n===void 0)throw new Error("The `jsonFileName` option is required when using the `json` format.");if(!n.endsWith(".json"))throw new Error("The `jsonFileName` option must end with `.json`.")}t!=="json"&&typeof n=="string"&&s.warn({message:"The `jsonFileName` option is only used when the `json` format is used.",prefix:"typedoc"});const E=o.map(m=>m.input),u=k??[];u.push("typedoc-plugin-rename-defaults"),(t==="inline"||t==="markdown")&&u.push("typedoc-plugin-markdown");const l=await b.bootstrapWithPlugins({...y,compilerOptions:{allowJs:!0,declaration:!1,declarationMap:!1,esModuleInterop:!0,module:99,moduleResolution:100,noEmit:!0,noImplicitAny:!1,skipLibCheck:!0,sourceMap:!1,target:99,...y.compilerOptions},entryPoints:E,hideGenerator:!0,out:a,plugin:u,...t==="inline"?{hideBreadcrumbs:!0,hidePageHeader:!0,navigation:!1,outputFileStrategy:"modules",useCodeBlocks:!0}:{}},[]),d=await l.convert();if(d){if(t==="json")await l.generateJson(d,n);else if(t==="html")await l.generateDocs(d,a);else if(await l.generateOutputs(d),t==="inline"){if(i===void 0)throw new Error("The `marker` option is required when using the `inline` format.");const m=A(a,{withFileTypes:!0}).filter(r=>r.isFile());let f="";for(const r of m)r.name==="README.md"&&o.length>1||(f+=w(h(a,r.name)).replaceAll(`<!-- ${i}`,`<!-- _REPLACE_${i}`).replaceAll("<!-- ${marker}",`<!-- _REPLACE_\\${i}`));if(f!==""){const r=w(p),c=$(r,i,`
-${f}`);if(!c){s.error({message:`Could not find the typedoc marker: <!-- ${i} --><!-- /${i} --> in ${p}`,prefix:"typedoc"});return}if(r===c)return;c&&F(p,c.replaceAll(`<!-- _REPLACE_${i}`,`<!-- ${i}`).replaceAll(`<!-- _REPLACE_\\${i}`,"<!-- ${marker}"),{overwrite:!0})}}}},"generateReferenceDocumentation");var R=Object.defineProperty,D=g((e,o)=>R(e,"name",{value:o,configurable:!0}),"r");const B=D(async(e,o,a,s)=>{if(e.options.typedoc&&e.options.typedoc.format!==void 0){let t="unknown";e.pkg.dependencies?.typedoc?t=e.pkg.dependencies.typedoc:e.pkg.devDependencies?.typedoc&&(t=e.pkg.devDependencies.typedoc),o&&P("typedoc",o,e.logger,!0),s&&e.logger.raw(`
-`),e.logger.info({message:`Using ${v("typedoc")} ${t} to generate reference documentation`,prefix:"typedoc"}),await e.hooks.callHook("typedoc:before",e);let n=e.options.rootDir;e.options.typedoc.output?n=e.options.typedoc.output:e.options.typedoc.format==="inline"&&o?n=h(o,"typedoc"):e.options.typedoc.format!=="json"&&(n=h(n,"api-docs")),await C(e.options.typedoc,e.options.entries,n,e.logger),await e.hooks.callHook("typedoc:done",e)}},"builder");export{B as default};
+import { cyan } from '@visulima/colorize';
+import { join } from '@visulima/path';
+import { r as replaceContentWithinMarker, c as createOrUpdateKeyStorage } from '../../packem_shared/create-or-update-key-storage-Dd7b8-t1.js';
+import { readdirSync } from 'node:fs';
+import { readFileSync, writeFileSync } from '@visulima/fs';
+import { Application } from 'typedoc';
+
+const generateReferenceDocumentation = async (options, entries, outputDirectory, logger) => {
+  if (entries.length === 0) {
+    return;
+  }
+  const { format, jsonFileName, marker, output, plugin, readmePath, ...typedocOptions } = options;
+  if (format === "inline" && readmePath === void 0) {
+    throw new Error("The `readmePath` option is required when using the `inline` format.");
+  }
+  if (format !== "inline" && typeof readmePath === "string") {
+    logger.warn({
+      message: "The `readmePath` option is only used when the `inline` format is used.",
+      prefix: "typedoc"
+    });
+  }
+  if (format === "json") {
+    if (jsonFileName === void 0) {
+      throw new Error("The `jsonFileName` option is required when using the `json` format.");
+    } else if (!jsonFileName.endsWith(".json")) {
+      throw new Error("The `jsonFileName` option must end with `.json`.");
+    }
+  }
+  if (format !== "json" && typeof jsonFileName === "string") {
+    logger.warn({
+      message: "The `jsonFileName` option is only used when the `json` format is used.",
+      prefix: "typedoc"
+    });
+  }
+  const entryPoints = entries.map((entry) => entry.input);
+  const plugins = plugin ?? [];
+  plugins.push("typedoc-plugin-rename-defaults");
+  if (format === "inline" || format === "markdown") {
+    plugins.push("typedoc-plugin-markdown");
+  }
+  const app = await Application.bootstrapWithPlugins(
+    {
+      ...typedocOptions,
+      compilerOptions: {
+        allowJs: true,
+        declaration: false,
+        declarationMap: false,
+        esModuleInterop: true,
+        module: 99,
+        // "ESNext"
+        moduleResolution: 100,
+        // Bundler,
+        noEmit: true,
+        noImplicitAny: false,
+        skipLibCheck: true,
+        sourceMap: false,
+        // Ensure we can parse the latest code
+        target: 99,
+        // ESNext
+        ...typedocOptions.compilerOptions
+      },
+      entryPoints,
+      hideGenerator: true,
+      out: outputDirectory,
+      plugin: plugins,
+      ...format === "inline" ? {
+        hideBreadcrumbs: true,
+        hidePageHeader: true,
+        navigation: false,
+        outputFileStrategy: "modules",
+        useCodeBlocks: true
+      } : {}
+      // we dont need the default loader
+    },
+    []
+  );
+  const project = await app.convert();
+  if (project) {
+    if (format === "json") {
+      await app.generateJson(project, jsonFileName);
+    } else if (format === "html") {
+      await app.generateDocs(project, outputDirectory);
+    } else {
+      await app.generateOutputs(project);
+      if (format === "inline") {
+        if (marker === void 0) {
+          throw new Error("The `marker` option is required when using the `inline` format.");
+        }
+        const markdownPathsList = readdirSync(outputDirectory, {
+          withFileTypes: true
+        }).filter((item) => item.isFile());
+        let markdownContent = "";
+        for (const item of markdownPathsList) {
+          if (item.name === "README.md" && entries.length > 1) {
+            continue;
+          }
+          markdownContent += readFileSync(join(outputDirectory, item.name)).replaceAll(`<!-- ${marker}`, `<!-- _REPLACE_${marker}`).replaceAll(`<!-- \${marker}`, `<!-- _REPLACE_\\${marker}`);
+        }
+        if (markdownContent !== "") {
+          const readmeContent = readFileSync(readmePath);
+          const updatedReadmeContent = replaceContentWithinMarker(readmeContent, marker, `
+${markdownContent}`);
+          if (!updatedReadmeContent) {
+            logger.error({
+              message: `Could not find the typedoc marker: <!-- ${marker} --><!-- /${marker} --> in ${readmePath}`,
+              prefix: "typedoc"
+            });
+            return;
+          }
+          if (readmeContent === updatedReadmeContent) {
+            return;
+          }
+          if (updatedReadmeContent) {
+            writeFileSync(
+              readmePath,
+              updatedReadmeContent.replaceAll(`<!-- _REPLACE_${marker}`, `<!-- ${marker}`).replaceAll(`<!-- _REPLACE_\\${marker}`, `<!-- \${marker}`),
+              {
+                overwrite: true
+              }
+            );
+          }
+        }
+      }
+    }
+  }
+};
+
+const builder = async (context, cachePath, _, logged) => {
+  if (context.options.typedoc && context.options.typedoc.format !== void 0) {
+    let typedocVersion = "unknown";
+    if (context.pkg.dependencies?.typedoc) {
+      typedocVersion = context.pkg.dependencies.typedoc;
+    } else if (context.pkg.devDependencies?.typedoc) {
+      typedocVersion = context.pkg.devDependencies.typedoc;
+    }
+    if (cachePath) {
+      createOrUpdateKeyStorage("typedoc", cachePath, context.logger, true);
+    }
+    if (logged) {
+      context.logger.raw("\n");
+    }
+    context.logger.info({
+      message: `Using ${cyan("typedoc")} ${typedocVersion} to generate reference documentation`,
+      prefix: "typedoc"
+    });
+    await context.hooks.callHook("typedoc:before", context);
+    let outputDirectory = context.options.rootDir;
+    if (context.options.typedoc.output) {
+      outputDirectory = context.options.typedoc.output;
+    } else if (context.options.typedoc.format === "inline" && cachePath) {
+      outputDirectory = join(cachePath, "typedoc");
+    } else if (context.options.typedoc.format !== "json") {
+      outputDirectory = join(outputDirectory, "api-docs");
+    }
+    await generateReferenceDocumentation(context.options.typedoc, context.options.entries, outputDirectory, context.logger);
+    await context.hooks.callHook("typedoc:done", context);
+  }
+};
+
+export { builder as default };