@virmator/docs 13.16.1 → 14.0.0

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 +52 -14
  2. package/dist/docs.js +29 -26
  3. package/package.json +10 -10
package/dist/docs.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { RuntimeEnv, type Logger } from '@augment-vir/common';
2
- import { NpmDepType, PackageType } from '@virmator/core';
1
+ import { type Logger } from '@augment-vir/common';
2
+ import { NpmDepType } from '@virmator/core';
3
3
  import { type PartialDeep } from 'type-fest';
4
4
  import type * as Typedoc from 'typedoc';
5
5
  /** A virmator plugin for checking and generating documentation. */
@@ -27,21 +27,40 @@ export declare const virmatorDocsPlugin: Readonly<Readonly<{
27
27
  readonly typedoc: {
28
28
  readonly copyFromPath: string;
29
29
  readonly copyToPath: string;
30
- readonly env: [RuntimeEnv.Node, RuntimeEnv.Web];
31
- readonly packageType: [PackageType.TopPackage, PackageType.MonoPackage];
30
+ readonly env: {
31
+ readonly node: true;
32
+ readonly web: true;
33
+ };
34
+ readonly packageType: {
35
+ readonly "top-level-package": true;
36
+ readonly "mono-package": true;
37
+ };
32
38
  readonly required: true;
33
39
  };
34
40
  };
35
41
  readonly npmDeps: {
36
42
  readonly 'markdown-code-example-inserter': {
37
43
  readonly type: NpmDepType.Dev;
38
- readonly env: readonly [RuntimeEnv.Node, RuntimeEnv.Web];
39
- readonly packageType: readonly [PackageType.TopPackage, PackageType.MonoPackage, PackageType.MonoRoot];
44
+ readonly env: {
45
+ readonly node: true;
46
+ readonly web: true;
47
+ };
48
+ readonly packageType: {
49
+ readonly "top-level-package": true;
50
+ readonly "mono-package": true;
51
+ readonly "mono-root": true;
52
+ };
40
53
  };
41
54
  readonly typedoc: {
42
55
  readonly type: NpmDepType.Dev;
43
- readonly env: readonly [RuntimeEnv.Node, RuntimeEnv.Web];
44
- readonly packageType: readonly [PackageType.TopPackage, PackageType.MonoPackage];
56
+ readonly env: {
57
+ readonly node: true;
58
+ readonly web: true;
59
+ };
60
+ readonly packageType: {
61
+ readonly "top-level-package": true;
62
+ readonly "mono-package": true;
63
+ };
45
64
  };
46
65
  };
47
66
  };
@@ -70,21 +89,40 @@ export declare const virmatorDocsPlugin: Readonly<Readonly<{
70
89
  readonly typedoc: {
71
90
  readonly copyFromPath: string;
72
91
  readonly copyToPath: string;
73
- readonly env: [RuntimeEnv.Node, RuntimeEnv.Web];
74
- readonly packageType: [PackageType.TopPackage, PackageType.MonoPackage];
92
+ readonly env: {
93
+ readonly node: true;
94
+ readonly web: true;
95
+ };
96
+ readonly packageType: {
97
+ readonly "top-level-package": true;
98
+ readonly "mono-package": true;
99
+ };
75
100
  readonly required: true;
76
101
  };
77
102
  };
78
103
  readonly npmDeps: {
79
104
  readonly 'markdown-code-example-inserter': {
80
105
  readonly type: NpmDepType.Dev;
81
- readonly env: readonly [RuntimeEnv.Node, RuntimeEnv.Web];
82
- readonly packageType: readonly [PackageType.TopPackage, PackageType.MonoPackage, PackageType.MonoRoot];
106
+ readonly env: {
107
+ readonly node: true;
108
+ readonly web: true;
109
+ };
110
+ readonly packageType: {
111
+ readonly "top-level-package": true;
112
+ readonly "mono-package": true;
113
+ readonly "mono-root": true;
114
+ };
83
115
  };
84
116
  readonly typedoc: {
85
117
  readonly type: NpmDepType.Dev;
86
- readonly env: readonly [RuntimeEnv.Node, RuntimeEnv.Web];
87
- readonly packageType: readonly [PackageType.TopPackage, PackageType.MonoPackage];
118
+ readonly env: {
119
+ readonly node: true;
120
+ readonly web: true;
121
+ };
122
+ readonly packageType: {
123
+ readonly "top-level-package": true;
124
+ readonly "mono-package": true;
125
+ };
88
126
  };
89
127
  };
90
128
  };
package/dist/docs.js CHANGED
@@ -5,6 +5,7 @@ import { defineVirmatorPlugin, NpmDepType, PackageType, VirmatorNoTraceError } f
5
5
  import mri from 'mri';
6
6
  import { basename, join } from 'node:path';
7
7
  import { pathToFileURL } from 'node:url';
8
+ import { createCommandLogPrefix } from 'runstorm';
8
9
  /** A virmator plugin for checking and generating documentation. */
9
10
  export const virmatorDocsPlugin = defineVirmatorPlugin(import.meta.dirname, {
10
11
  name: 'Docs',
@@ -44,40 +45,40 @@ export const virmatorDocsPlugin = defineVirmatorPlugin(import.meta.dirname, {
44
45
  typedoc: {
45
46
  copyFromPath: join('configs', 'typedoc.config.share.ts'),
46
47
  copyToPath: join('configs', 'typedoc.config.ts'),
47
- env: [
48
- RuntimeEnv.Node,
49
- RuntimeEnv.Web,
50
- ],
51
- packageType: [
52
- PackageType.TopPackage,
53
- PackageType.MonoPackage,
54
- ],
48
+ env: {
49
+ [RuntimeEnv.Node]: true,
50
+ [RuntimeEnv.Web]: true,
51
+ },
52
+ packageType: {
53
+ [PackageType.TopPackage]: true,
54
+ [PackageType.MonoPackage]: true,
55
+ },
55
56
  required: true,
56
57
  },
57
58
  },
58
59
  npmDeps: {
59
60
  'markdown-code-example-inserter': {
60
61
  type: NpmDepType.Dev,
61
- env: [
62
- RuntimeEnv.Node,
63
- RuntimeEnv.Web,
64
- ],
65
- packageType: [
66
- PackageType.TopPackage,
67
- PackageType.MonoPackage,
68
- PackageType.MonoRoot,
69
- ],
62
+ env: {
63
+ [RuntimeEnv.Node]: true,
64
+ [RuntimeEnv.Web]: true,
65
+ },
66
+ packageType: {
67
+ [PackageType.TopPackage]: true,
68
+ [PackageType.MonoPackage]: true,
69
+ [PackageType.MonoRoot]: true,
70
+ },
70
71
  },
71
72
  typedoc: {
72
73
  type: NpmDepType.Dev,
73
- env: [
74
- RuntimeEnv.Node,
75
- RuntimeEnv.Web,
76
- ],
77
- packageType: [
78
- PackageType.TopPackage,
79
- PackageType.MonoPackage,
80
- ],
74
+ env: {
75
+ [RuntimeEnv.Node]: true,
76
+ [RuntimeEnv.Web]: true,
77
+ },
78
+ packageType: {
79
+ [PackageType.TopPackage]: true,
80
+ [PackageType.MonoPackage]: true,
81
+ },
81
82
  },
82
83
  },
83
84
  },
@@ -99,7 +100,9 @@ export const virmatorDocsPlugin = defineVirmatorPlugin(import.meta.dirname, {
99
100
  async function runDocs(packageDir, packageName, color) {
100
101
  try {
101
102
  await runShellCommand(mdCodeCommand, { cwd: packageDir }, {
102
- logPrefix: color && packageName ? color(`[${packageName}] `) : undefined,
103
+ logPrefix: color && packageName
104
+ ? createCommandLogPrefix({ name: packageName, color })
105
+ : undefined,
103
106
  logTransform: {
104
107
  stderr: (stderrInput) => stderrInput.replace('Run without --check to update.', 'Run without the "check" sub-command to update.'),
105
108
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@virmator/docs",
3
- "version": "13.16.1",
3
+ "version": "14.0.0",
4
4
  "description": "Default TS docs plugin for virmator.",
5
5
  "keywords": [
6
6
  "virmator",
@@ -33,22 +33,22 @@
33
33
  "test:update": "npm test update"
34
34
  },
35
35
  "dependencies": {
36
- "@augment-vir/assert": "^31.31.0",
37
- "@augment-vir/common": "^31.31.0",
38
- "@augment-vir/node": "^31.31.0",
39
- "@virmator/core": "^13.16.1",
40
- "chalk": "^5.5.0",
36
+ "@augment-vir/assert": "^31.32.3",
37
+ "@augment-vir/common": "^31.32.3",
38
+ "@augment-vir/node": "^31.32.3",
39
+ "@virmator/core": "^14.0.0",
41
40
  "mri": "^1.2.0",
41
+ "runstorm": "^0.6.1",
42
42
  "type-fest": "^4.41.0"
43
43
  },
44
44
  "devDependencies": {
45
- "@augment-vir/test": "^31.31.0",
46
- "@types/node": "^24.2.0",
45
+ "@augment-vir/test": "^31.32.3",
46
+ "@types/node": "^24.3.0",
47
47
  "c8": "^10.1.3",
48
- "esbuild": "^0.25.8",
48
+ "esbuild": "^0.25.9",
49
49
  "istanbul-smart-text-reporter": "^1.1.5",
50
50
  "markdown-code-example-inserter": "^3.0.3",
51
- "typedoc": "^0.28.9"
51
+ "typedoc": "^0.28.10"
52
52
  },
53
53
  "engines": {
54
54
  "node": ">=22"