@virmator/docs 13.3.3 → 13.3.4

package/dist/docs.d.ts

@@ -1,4 +1,4 @@
-import { NpmDepType, PackageType, VirmatorEnv } from '@virmator/core';
+import { NpmDepType, PackageType, PluginLogger, VirmatorEnv } from '@virmator/core';
 /** A virmator plugin for checking and generating documentation. */
 export declare const virmatorDocsPlugin: Readonly<Readonly<{
     name: string;
@@ -99,3 +99,17 @@ export declare const virmatorDocsPlugin: Readonly<Readonly<{
         };
     }>>;
 }>;
+/** Runs TypeDoc with a TypeScript config file just like `@virmator/docs` does. */
+export declare function runTypedoc({ configPath, packageDir, checkOnly, log, }: {
+    /** Path to TS typedoc config file. */
+    configPath: string;
+    /**
+     * Path to the npm package which is running typedoc. This should be a path to a directory that
+     * directly contains a `package.json` file.
+     */
+    packageDir: string;
+    /** Set to `true` to only check current doc comments, rather than generating HTML from them. */
+    checkOnly?: boolean | undefined;
+    /** Optionally override the logger. */
+    log?: PluginLogger | undefined;
+}): Promise<void>;

package/dist/docs.js

@@ -1,6 +1,6 @@
 import { ensureError, isTruthy } from '@augment-vir/common';
 import { readPackageJson } from '@augment-vir/node-js';
-import { defineVirmatorPlugin, JsModuleType, NpmDepType, PackageType, VirmatorEnv, VirmatorNoTraceError, withImportedTsFile, } from '@virmator/core';
+import { defaultPluginLogger, defineVirmatorPlugin, JsModuleType, NpmDepType, PackageType, VirmatorEnv, VirmatorNoTraceError, withImportedTsFile, } from '@virmator/core';
 import mri from 'mri';
 import { basename, join } from 'node:path';
 /** A virmator plugin for checking and generating documentation. */
@@ -131,22 +131,11 @@ export const virmatorDocsPlugin = defineVirmatorPlugin(import.meta.dirname, {
             log.faint(`Skipping typedoc ${typedocVerb} in private repo ${packageName}`);
             return;
         }
-        await withImportedTsFile({
-            inputPath: join(packageDir, configs.docs.configs.typedoc.copyToPath),
-            outputPath: join(packageDir, 'node_modules', '.virmator', 'typedoc.config.cjs'),
-        }, JsModuleType.Cjs, async (loadedConfig) => {
-            const typedocOptions = loadedConfig.typeDocConfig;
-            // dynamic imports are not branches
-            /* node:coverage ignore next */
-            const typedoc = await import('typedoc');
-            const fullTypedocOptions = {
-                ...typedocOptions,
-                ...(checkOnly ? { emit: typedoc.Configuration.EmitStrategy.none } : {}),
-                tsconfig: join(packageDir, 'tsconfig.json'),
-            };
-            if (!(await runTypedoc(fullTypedocOptions, typedoc, log))) {
-                throw new VirmatorNoTraceError();
-            }
+        await runTypedoc({
+            checkOnly,
+            packageDir,
+            configPath: join(packageDir, configs.docs.configs.typedoc.copyToPath),
+            log,
         });
     }
     /**
@@ -164,7 +153,27 @@ export const virmatorDocsPlugin = defineVirmatorPlugin(import.meta.dirname, {
         await runDocs(cwdPackagePath, cwdPackageJson.name || basename(cwdPackagePath), undefined);
     }
 });
-async function runTypedoc(options, typeDoc, log) {
+/** Runs TypeDoc with a TypeScript config file just like `@virmator/docs` does. */
+export async function runTypedoc({ configPath, packageDir, checkOnly = false, log = defaultPluginLogger, }) {
+    await withImportedTsFile({
+        inputPath: configPath,
+        outputPath: join(packageDir, 'node_modules', '.virmator', 'typedoc.config.cjs'),
+    }, JsModuleType.Cjs, async (loadedConfig) => {
+        const typedocOptions = loadedConfig.typeDocConfig;
+        // dynamic imports are not branches
+        /* node:coverage ignore next */
+        const typedoc = await import('typedoc');
+        const fullTypedocOptions = {
+            ...typedocOptions,
+            ...(checkOnly ? { emit: typedoc.Configuration.EmitStrategy.none } : {}),
+            tsconfig: join(packageDir, 'tsconfig.json'),
+        };
+        if (!(await runTypedocInternal(fullTypedocOptions, typedoc, log))) {
+            throw new VirmatorNoTraceError();
+        }
+    });
+}
+async function runTypedocInternal(options, typeDoc, log) {
     /** Lots of edge cases included in here to just make sure we fully run the typedoc API. */
     /* node:coverage disable */
     const app = await typeDoc.Application.bootstrapWithPlugins(options, [

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@virmator/docs",
-    "version": "13.3.3",
+    "version": "13.3.4",
     "description": "Default TS docs plugin for virmator.",
     "keywords": [
         "virmator",
@@ -34,7 +34,7 @@
     "dependencies": {
         "@augment-vir/common": "^29.3.0",
         "@augment-vir/node-js": "^29.3.0",
-        "@virmator/core": "^13.3.3",
+        "@virmator/core": "^13.3.4",
         "chalk": "^5.3.0",
         "mri": "^1.2.0",
         "run-time-assertions": "^1.5.2"