@virmator/docs 13.13.4 → 13.14.0

package/configs/typedoc.config.base.ts

@@ -15,7 +15,7 @@ export const defaultDocumentationRequirements: TypeDocOptionMap['requiredToBeDoc
     'Variable',
 ];
 
-export const baseTypedocConfig: PartialDeep<TypeDocOptionMap> = {
+export const baseTypedocConfig = {
     cacheBust: true,
     cleanOutputDir: true,
     excludeExternals: true,
@@ -35,4 +35,4 @@ export const baseTypedocConfig: PartialDeep<TypeDocOptionMap> = {
     navigation: {
         includeCategories: true,
     },
-};
+} satisfies PartialDeep<TypeDocOptionMap>;

package/configs/typedoc.config.share.ts

@@ -1,13 +1,14 @@
 import {baseTypedocConfig} from '@virmator/docs/configs/typedoc.config.base';
-import {join, resolve} from 'node:path';
-import type {TypeDocOptions} from 'typedoc';
+import {dirname, join} from 'node:path/posix';
+import {fileURLToPath} from 'node:url';
+import {type TypeDocOptions} from 'typedoc';
 
-const repoRoot = resolve(import.meta.dirname, '..');
-const indexTsFile = join(repoRoot, 'src', 'index.ts');
+const indexTsFile = join(dirname(dirname(fileURLToPath(import.meta.url))), 'src', 'index.ts');
+const outDirPath = join(dirname(dirname(fileURLToPath(import.meta.url))), 'dist-docs');
 
 export const typeDocConfig: Partial<TypeDocOptions> = {
     ...baseTypedocConfig,
-    out: join(repoRoot, 'dist-docs'),
+    out: outDirPath,
     entryPoints: [
         indexTsFile,
     ],

package/configs/typedoc.config.ts

@@ -1,13 +1,14 @@
 import {baseTypedocConfig} from '@virmator/docs/configs/typedoc.config.base';
-import {join, resolve} from 'path';
-import type {TypeDocOptions} from 'typedoc';
+import {dirname, join} from 'node:path/posix';
+import {fileURLToPath} from 'node:url';
+import {type TypeDocOptions} from 'typedoc';
 
-const repoRoot = resolve(import.meta.dirname, '..');
-const indexTsFile = join(repoRoot, 'src', 'docs.ts');
+const indexTsFile = join(dirname(dirname(fileURLToPath(import.meta.url))), 'src', 'docs.ts');
+const outDirPath = join(dirname(dirname(fileURLToPath(import.meta.url))), 'dist-docs');
 
 export const typeDocConfig: Partial<TypeDocOptions> = {
     ...baseTypedocConfig,
-    out: join(repoRoot, 'dist-docs'),
+    out: outDirPath,
     entryPoints: [
         indexTsFile,
     ],

package/dist/docs.js

@@ -191,7 +191,7 @@ async function runTypedocInternal(options, typeDoc, log) {
         return false;
     }
     else if (app.options.getValue('watch')) {
-        throw new Error(';TypeDoc watch mode not supported in virmator. Run typedoc directly instead.');
+        throw new Error('TypeDoc watch mode not supported in virmator. Run typedoc directly instead.');
     }
     const project = await app.convert();
     if (!project || (app.options.getValue('treatWarningsAsErrors') && app.logger.hasWarnings())) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@virmator/docs",
-    "version": "13.13.4",
+    "version": "13.14.0",
     "description": "Default TS docs plugin for virmator.",
     "keywords": [
         "virmator",
@@ -21,6 +21,7 @@
         "name": "electrovir",
         "url": "https://github.com/electrovir"
     },
+    "sideEffects": false,
     "type": "module",
     "main": "dist/docs.js",
     "module": "dist/docs.js",
@@ -32,22 +33,22 @@
         "test:update": "npm test update"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.10.1",
-        "@augment-vir/common": "^31.10.1",
-        "@augment-vir/node": "^31.10.1",
-        "@virmator/core": "^13.13.4",
+        "@augment-vir/assert": "^31.14.1",
+        "@augment-vir/common": "^31.14.1",
+        "@augment-vir/node": "^31.14.1",
+        "@virmator/core": "^13.14.0",
         "chalk": "^5.4.1",
         "mri": "^1.2.0",
-        "type-fest": "^4.37.0"
+        "type-fest": "^4.40.0"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.10.1",
-        "@types/node": "^22.13.10",
+        "@augment-vir/test": "^31.14.1",
+        "@types/node": "^22.14.1",
         "c8": "^10.1.3",
-        "esbuild": "^0.25.1",
+        "esbuild": "^0.25.2",
         "istanbul-smart-text-reporter": "^1.1.5",
         "markdown-code-example-inserter": "^3.0.3",
-        "typedoc": "^0.28.0"
+        "typedoc": "^0.28.3"
     },
     "engines": {
         "node": ">=22"