@virmator/docs 13.13.2 → 13.13.4
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.
- package/configs/typedoc.config.base.ts +4 -3
- package/dist/docs.d.ts +2 -1
- package/dist/docs.js +1 -1
- package/package.json +4 -3
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import {type PartialDeep} from 'type-fest';
|
|
2
|
+
import {type TypeDocOptionMap} from 'typedoc';
|
|
2
3
|
|
|
3
|
-
export const defaultDocumentationRequirements:
|
|
4
|
+
export const defaultDocumentationRequirements: TypeDocOptionMap['requiredToBeDocumented'] = [
|
|
4
5
|
'Accessor',
|
|
5
6
|
'Class',
|
|
6
7
|
'Enum',
|
|
@@ -14,7 +15,7 @@ export const defaultDocumentationRequirements: TypeDocOptions['requiredToBeDocum
|
|
|
14
15
|
'Variable',
|
|
15
16
|
];
|
|
16
17
|
|
|
17
|
-
export const baseTypedocConfig:
|
|
18
|
+
export const baseTypedocConfig: PartialDeep<TypeDocOptionMap> = {
|
|
18
19
|
cacheBust: true,
|
|
19
20
|
cleanOutputDir: true,
|
|
20
21
|
excludeExternals: true,
|
package/dist/docs.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { RuntimeEnv, type Logger } from '@augment-vir/common';
|
|
2
2
|
import { NpmDepType, PackageType } from '@virmator/core';
|
|
3
|
+
import type { PartialDeep } from 'type-fest';
|
|
3
4
|
import type * as Typedoc from 'typedoc';
|
|
4
5
|
/** A virmator plugin for checking and generating documentation. */
|
|
5
6
|
export declare const virmatorDocsPlugin: Readonly<Readonly<{
|
|
@@ -92,7 +93,7 @@ export declare const virmatorDocsPlugin: Readonly<Readonly<{
|
|
|
92
93
|
/** Runs TypeDoc with a TypeScript config file just like `@virmator/docs` does. */
|
|
93
94
|
export declare function runTypedoc({ config, packageDir, checkOnly, log, }: {
|
|
94
95
|
/** Full typedoc options object. */
|
|
95
|
-
config:
|
|
96
|
+
config: PartialDeep<Typedoc.TypeDocOptionMap>;
|
|
96
97
|
/**
|
|
97
98
|
* Path to the npm package which is running typedoc. This should be a path to a directory that
|
|
98
99
|
* directly contains a `package.json` file.
|
package/dist/docs.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { assertWrap, check } from '@augment-vir/assert';
|
|
2
|
-
import { ensureError, log as logImport, RuntimeEnv } from '@augment-vir/common';
|
|
2
|
+
import { ensureError, log as logImport, RuntimeEnv, } from '@augment-vir/common';
|
|
3
3
|
import { readPackageJson } from '@augment-vir/node';
|
|
4
4
|
import { defineVirmatorPlugin, NpmDepType, PackageType, VirmatorNoTraceError } from '@virmator/core';
|
|
5
5
|
import mri from 'mri';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@virmator/docs",
|
|
3
|
-
"version": "13.13.
|
|
3
|
+
"version": "13.13.4",
|
|
4
4
|
"description": "Default TS docs plugin for virmator.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"virmator",
|
|
@@ -35,9 +35,10 @@
|
|
|
35
35
|
"@augment-vir/assert": "^31.10.1",
|
|
36
36
|
"@augment-vir/common": "^31.10.1",
|
|
37
37
|
"@augment-vir/node": "^31.10.1",
|
|
38
|
-
"@virmator/core": "^13.13.
|
|
38
|
+
"@virmator/core": "^13.13.4",
|
|
39
39
|
"chalk": "^5.4.1",
|
|
40
|
-
"mri": "^1.2.0"
|
|
40
|
+
"mri": "^1.2.0",
|
|
41
|
+
"type-fest": "^4.37.0"
|
|
41
42
|
},
|
|
42
43
|
"devDependencies": {
|
|
43
44
|
"@augment-vir/test": "^31.10.1",
|