@virmator/docs 13.3.12 → 13.3.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/docs.d.ts +9 -8
  2. package/dist/docs.js +12 -11
  3. package/package.json +8 -7
package/dist/docs.d.ts CHANGED
@@ -1,4 +1,5 @@
1
- import { NpmDepType, PackageType, PluginLogger, VirmatorEnv } from '@virmator/core';
1
+ import { RuntimeEnv, type Logger } from '@augment-vir/common';
2
+ import { NpmDepType, PackageType } from '@virmator/core';
2
3
  import type * as Typedoc from 'typedoc';
3
4
  /** A virmator plugin for checking and generating documentation. */
4
5
  export declare const virmatorDocsPlugin: Readonly<Readonly<{
@@ -25,7 +26,7 @@ export declare const virmatorDocsPlugin: Readonly<Readonly<{
25
26
  readonly typedoc: {
26
27
  readonly copyFromPath: string;
27
28
  readonly copyToPath: string;
28
- readonly env: [VirmatorEnv.Node, VirmatorEnv.Web];
29
+ readonly env: [RuntimeEnv.Node, RuntimeEnv.Web];
29
30
  readonly packageType: [PackageType.TopPackage, PackageType.MonoPackage];
30
31
  readonly required: true;
31
32
  };
@@ -33,12 +34,12 @@ export declare const virmatorDocsPlugin: Readonly<Readonly<{
33
34
  readonly npmDeps: {
34
35
  readonly 'markdown-code-example-inserter': {
35
36
  readonly type: NpmDepType.Dev;
36
- readonly env: readonly [VirmatorEnv.Node, VirmatorEnv.Web];
37
+ readonly env: readonly [RuntimeEnv.Node, RuntimeEnv.Web];
37
38
  readonly packageType: readonly [PackageType.TopPackage, PackageType.MonoPackage, PackageType.MonoRoot];
38
39
  };
39
40
  readonly typedoc: {
40
41
  readonly type: NpmDepType.Dev;
41
- readonly env: readonly [VirmatorEnv.Node, VirmatorEnv.Web];
42
+ readonly env: readonly [RuntimeEnv.Node, RuntimeEnv.Web];
42
43
  readonly packageType: readonly [PackageType.TopPackage, PackageType.MonoPackage];
43
44
  };
44
45
  };
@@ -68,7 +69,7 @@ export declare const virmatorDocsPlugin: Readonly<Readonly<{
68
69
  readonly typedoc: {
69
70
  readonly copyFromPath: string;
70
71
  readonly copyToPath: string;
71
- readonly env: [VirmatorEnv.Node, VirmatorEnv.Web];
72
+ readonly env: [RuntimeEnv.Node, RuntimeEnv.Web];
72
73
  readonly packageType: [PackageType.TopPackage, PackageType.MonoPackage];
73
74
  readonly required: true;
74
75
  };
@@ -76,12 +77,12 @@ export declare const virmatorDocsPlugin: Readonly<Readonly<{
76
77
  readonly npmDeps: {
77
78
  readonly 'markdown-code-example-inserter': {
78
79
  readonly type: NpmDepType.Dev;
79
- readonly env: readonly [VirmatorEnv.Node, VirmatorEnv.Web];
80
+ readonly env: readonly [RuntimeEnv.Node, RuntimeEnv.Web];
80
81
  readonly packageType: readonly [PackageType.TopPackage, PackageType.MonoPackage, PackageType.MonoRoot];
81
82
  };
82
83
  readonly typedoc: {
83
84
  readonly type: NpmDepType.Dev;
84
- readonly env: readonly [VirmatorEnv.Node, VirmatorEnv.Web];
85
+ readonly env: readonly [RuntimeEnv.Node, RuntimeEnv.Web];
85
86
  readonly packageType: readonly [PackageType.TopPackage, PackageType.MonoPackage];
86
87
  };
87
88
  };
@@ -100,5 +101,5 @@ export declare function runTypedoc({ config, packageDir, checkOnly, log, }: {
100
101
  /** Set to `true` to only check current doc comments, rather than generating HTML from them. */
101
102
  checkOnly?: boolean | undefined;
102
103
  /** Optionally override the logger. */
103
- log?: PluginLogger | undefined;
104
+ log?: Logger | undefined;
104
105
  }): Promise<void>;
package/dist/docs.js CHANGED
@@ -1,6 +1,7 @@
1
- import { ensureError, isTruthy } from '@augment-vir/common';
2
- import { readPackageJson } from '@augment-vir/node-js';
3
- import { defaultPluginLogger, defineVirmatorPlugin, NpmDepType, PackageType, VirmatorEnv, VirmatorNoTraceError, } from '@virmator/core';
1
+ import { check } from '@augment-vir/assert';
2
+ import { ensureError, log as logImport, RuntimeEnv } from '@augment-vir/common';
3
+ import { readPackageJson } from '@augment-vir/node';
4
+ import { defineVirmatorPlugin, NpmDepType, PackageType, VirmatorNoTraceError } from '@virmator/core';
4
5
  import mri from 'mri';
5
6
  import { basename, join } from 'node:path';
6
7
  import { pathToFileURL } from 'node:url';
@@ -44,8 +45,8 @@ export const virmatorDocsPlugin = defineVirmatorPlugin(import.meta.dirname, {
44
45
  copyFromPath: join('configs', 'typedoc.config.share.ts'),
45
46
  copyToPath: join('configs', 'typedoc.config.ts'),
46
47
  env: [
47
- VirmatorEnv.Node,
48
- VirmatorEnv.Web,
48
+ RuntimeEnv.Node,
49
+ RuntimeEnv.Web,
49
50
  ],
50
51
  packageType: [
51
52
  PackageType.TopPackage,
@@ -58,8 +59,8 @@ export const virmatorDocsPlugin = defineVirmatorPlugin(import.meta.dirname, {
58
59
  'markdown-code-example-inserter': {
59
60
  type: NpmDepType.Dev,
60
61
  env: [
61
- VirmatorEnv.Node,
62
- VirmatorEnv.Web,
62
+ RuntimeEnv.Node,
63
+ RuntimeEnv.Web,
63
64
  ],
64
65
  packageType: [
65
66
  PackageType.TopPackage,
@@ -70,8 +71,8 @@ export const virmatorDocsPlugin = defineVirmatorPlugin(import.meta.dirname, {
70
71
  typedoc: {
71
72
  type: NpmDepType.Dev,
72
73
  env: [
73
- VirmatorEnv.Node,
74
- VirmatorEnv.Web,
74
+ RuntimeEnv.Node,
75
+ RuntimeEnv.Web,
75
76
  ],
76
77
  packageType: [
77
78
  PackageType.TopPackage,
@@ -93,7 +94,7 @@ export const virmatorDocsPlugin = defineVirmatorPlugin(import.meta.dirname, {
93
94
  ...filteredArgs,
94
95
  mdFilesArg,
95
96
  ]
96
- .filter(isTruthy)
97
+ .filter(check.isTruthy)
97
98
  .join(' ');
98
99
  async function runDocs(packageDir, packageName, color) {
99
100
  try {
@@ -146,7 +147,7 @@ export const virmatorDocsPlugin = defineVirmatorPlugin(import.meta.dirname, {
146
147
  }
147
148
  });
148
149
  /** Runs TypeDoc with a TypeScript config file just like `@virmator/docs` does. */
149
- export async function runTypedoc({ config, packageDir, checkOnly = false, log = defaultPluginLogger, }) {
150
+ export async function runTypedoc({ config, packageDir, checkOnly = false, log = logImport, }) {
150
151
  // dynamic imports are not branches
151
152
  /* node:coverage ignore next */
152
153
  const typedoc = await import('typedoc');
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@virmator/docs",
3
- "version": "13.3.12",
3
+ "version": "13.3.13",
4
4
  "description": "Default TS docs plugin for virmator.",
5
5
  "keywords": [
6
6
  "virmator",
@@ -32,15 +32,16 @@
32
32
  "test:update": "npm test update"
33
33
  },
34
34
  "dependencies": {
35
- "@augment-vir/common": "^29.3.0",
36
- "@augment-vir/node-js": "^29.3.0",
37
- "@virmator/core": "^13.3.12",
35
+ "@augment-vir/assert": "^30.0.4",
36
+ "@augment-vir/common": "^30.0.4",
37
+ "@augment-vir/node": "^30.0.4",
38
+ "@virmator/core": "^13.3.13",
38
39
  "chalk": "^5.3.0",
39
- "mri": "^1.2.0",
40
- "run-time-assertions": "^1.5.2"
40
+ "mri": "^1.2.0"
41
41
  },
42
42
  "devDependencies": {
43
- "@types/node": "^22.5.4",
43
+ "@augment-vir/test": "^30.0.4",
44
+ "@types/node": "^22.5.5",
44
45
  "c8": "^10.1.2",
45
46
  "esbuild": "^0.23.1",
46
47
  "istanbul-smart-text-reporter": "^1.1.4",