@virmator/docs 13.3.3 → 13.3.5

package/README.md

@@ -15,7 +15,6 @@ A default plugin for [virmator](https://www.npmjs.com/package/virmator).
     -   Deps
         -   [markdown-code-example-inserter](https://npmjs.com/package/markdown-code-example-inserter)
         -   [typedoc](https://npmjs.com/package/typedoc)
-        -   [esbuild](https://npmjs.com/package/esbuild)
     -   Sub Commands
 
         -   **check**

package/configs/typedoc.config.share.ts

@@ -2,12 +2,7 @@ import {baseTypedocConfig} from '@virmator/docs/configs/typedoc.config.base';
 import {join, resolve} from 'node:path';
 import type {TypeDocOptions} from 'typedoc';
 
-const repoRoot = resolve(
-    __dirname,
-    /** Go up two directories because this gets compiled into `node_modules/.virmator` */
-    '..',
-    '..',
-);
+const repoRoot = resolve(import.meta.dirname, '..');
 const indexTsFile = join(repoRoot, 'src', 'index.ts');
 
 export const typeDocConfig: Partial<TypeDocOptions> = {

package/configs/typedoc.config.ts

@@ -2,12 +2,7 @@ import {baseTypedocConfig} from '@virmator/docs/configs/typedoc.config.base';
 import {join, resolve} from 'path';
 import type {TypeDocOptions} from 'typedoc';
 
-const repoRoot = resolve(
-    __dirname,
-    /** Go up two directories because this gets compiled into `node_modules/.virmator` */
-    '..',
-    '..',
-);
+const repoRoot = resolve(import.meta.dirname, '..');
 const indexTsFile = join(repoRoot, 'src', 'docs.ts');
 
 export const typeDocConfig: Partial<TypeDocOptions> = {

package/dist/docs.d.ts

@@ -1,4 +1,5 @@
-import { NpmDepType, PackageType, VirmatorEnv } from '@virmator/core';
+import { NpmDepType, PackageType, PluginLogger, VirmatorEnv } from '@virmator/core';
+import type * as Typedoc from 'typedoc';
 /** A virmator plugin for checking and generating documentation. */
 export declare const virmatorDocsPlugin: Readonly<Readonly<{
     name: string;
@@ -40,12 +41,6 @@ export declare const virmatorDocsPlugin: Readonly<Readonly<{
                     readonly env: readonly [VirmatorEnv.Node, VirmatorEnv.Web];
                     readonly packageType: readonly [PackageType.TopPackage, PackageType.MonoPackage];
                 };
-                /** Needed to compile the TS dep-cruiser config file. */
-                readonly esbuild: {
-                    readonly type: NpmDepType.Dev;
-                    readonly env: readonly [VirmatorEnv.Node, VirmatorEnv.Web];
-                    readonly packageType: readonly [PackageType.TopPackage, PackageType.MonoPackage];
-                };
             };
         };
     }>;
@@ -89,13 +84,21 @@ export declare const virmatorDocsPlugin: Readonly<Readonly<{
                     readonly env: readonly [VirmatorEnv.Node, VirmatorEnv.Web];
                     readonly packageType: readonly [PackageType.TopPackage, PackageType.MonoPackage];
                 };
-                /** Needed to compile the TS dep-cruiser config file. */
-                readonly esbuild: {
-                    readonly type: NpmDepType.Dev;
-                    readonly env: readonly [VirmatorEnv.Node, VirmatorEnv.Web];
-                    readonly packageType: readonly [PackageType.TopPackage, PackageType.MonoPackage];
-                };
             };
         };
     }>>;
 }>;
+/** Runs TypeDoc with a TypeScript config file just like `@virmator/docs` does. */
+export declare function runTypedoc({ config, packageDir, checkOnly, log, }: {
+    /** Full typedoc options object. */
+    config: Partial<Typedoc.TypeDocOptions>;
+    /**
+     * 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, NpmDepType, PackageType, VirmatorEnv, VirmatorNoTraceError, } from '@virmator/core';
 import mri from 'mri';
 import { basename, join } from 'node:path';
 /** A virmator plugin for checking and generating documentation. */
@@ -77,18 +77,6 @@ export const virmatorDocsPlugin = defineVirmatorPlugin(import.meta.dirname, {
                         PackageType.MonoPackage,
                     ],
                 },
-                /** Needed to compile the TS dep-cruiser config file. */
-                esbuild: {
-                    type: NpmDepType.Dev,
-                    env: [
-                        VirmatorEnv.Node,
-                        VirmatorEnv.Web,
-                    ],
-                    packageType: [
-                        PackageType.TopPackage,
-                        PackageType.MonoPackage,
-                    ],
-                },
             },
         },
     },
@@ -131,22 +119,15 @@ 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();
-            }
+        // dynamic imports are not branches
+        /* node:coverage ignore next 2 */
+        const config = (await import(join(packageDir, configs.docs.configs.typedoc.copyToPath)))
+            .typeDocConfig;
+        await runTypedoc({
+            checkOnly,
+            packageDir,
+            config,
+            log,
         });
     }
     /**
@@ -164,7 +145,25 @@ 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({ config, packageDir, checkOnly = false, log = defaultPluginLogger, }) {
+    // dynamic imports are not branches
+    /* node:coverage ignore next */
+    const typedoc = await import('typedoc');
+    const combinedConfig = {
+        tsconfig: join(packageDir, 'tsconfig.json'),
+        ...config,
+        ...(checkOnly
+            ? {
+                emit: typedoc.Configuration.EmitStrategy.none,
+            }
+            : {}),
+    };
+    if (!(await runTypedocInternal(combinedConfig, 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.5",
     "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.5",
         "chalk": "^5.3.0",
         "mri": "^1.2.0",
         "run-time-assertions": "^1.5.2"