@powerlines/plugin-typedoc 0.10.65 → 0.10.67
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/dist/_virtual/rolldown_runtime.cjs +1 -0
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +2 -2
- package/dist/index.d.mts +3 -2
- package/dist/index.mjs +1 -1
- package/dist/powerlines/src/types/babel.d.mts +2 -0
- package/dist/powerlines/src/types/build.d.cts +139 -0
- package/dist/powerlines/src/types/build.d.mts +139 -0
- package/dist/powerlines/src/types/commands.d.cts +8 -0
- package/dist/powerlines/src/types/commands.d.mts +9 -0
- package/dist/powerlines/src/types/config.d.cts +345 -0
- package/dist/powerlines/src/types/config.d.mts +345 -0
- package/dist/powerlines/src/types/context.d.cts +347 -0
- package/dist/powerlines/src/types/context.d.mts +349 -0
- package/dist/powerlines/src/types/fs.d.cts +458 -0
- package/dist/powerlines/src/types/fs.d.mts +458 -0
- package/dist/powerlines/src/types/hooks.d.mts +2 -0
- package/dist/powerlines/src/types/plugin.d.cts +232 -0
- package/dist/powerlines/src/types/plugin.d.mts +232 -0
- package/dist/powerlines/src/types/resolved.d.cts +81 -0
- package/dist/powerlines/src/types/resolved.d.mts +81 -0
- package/dist/powerlines/src/types/tsconfig.d.cts +69 -0
- package/dist/powerlines/src/types/tsconfig.d.mts +69 -0
- package/dist/types/index.cjs +0 -1
- package/dist/types/index.d.cts +1 -2
- package/dist/types/index.d.mts +1 -2
- package/dist/types/index.mjs +1 -1
- package/dist/types/plugin.cjs +0 -1
- package/dist/types/plugin.d.cts +64 -1
- package/dist/types/plugin.d.mts +64 -1
- package/dist/types/plugin.mjs +1 -1
- package/package.json +8 -8
- package/dist/index-BgAdqTbb.d.mts +0 -1
- package/dist/index-CEgs-Dz2.d.cts +0 -1
- package/dist/plugin-Bvn-he2n.mjs +0 -1
- package/dist/plugin-CTLVvjpL.d.mts +0 -1699
- package/dist/plugin-DHXHjv16.cjs +0 -0
- package/dist/plugin-D_6rwOnJ.d.cts +0 -1699
- package/dist/types-B7VYa_Pp.mjs +0 -1
- package/dist/types-DHkg7xmX.cjs +0 -0
package/dist/types/plugin.d.mts
CHANGED
|
@@ -1,2 +1,65 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { UserConfig } from "../powerlines/src/types/config.mjs";
|
|
2
|
+
import { ResolvedConfig } from "../powerlines/src/types/resolved.mjs";
|
|
3
|
+
import { PluginContext } from "../powerlines/src/types/context.mjs";
|
|
4
|
+
import { Application, ProjectReflection, TypeDocOptions } from "typedoc";
|
|
5
|
+
|
|
6
|
+
//#region src/types/plugin.d.ts
|
|
7
|
+
interface GenerateDocsOptions {
|
|
8
|
+
frontmatter?: Record<string, any>;
|
|
9
|
+
outputPath?: string;
|
|
10
|
+
project: ProjectReflection;
|
|
11
|
+
}
|
|
12
|
+
interface TypeDocPluginOptions extends Partial<Omit<TypeDocOptions, "out">> {
|
|
13
|
+
/**
|
|
14
|
+
* The output path for the generated documentation.
|
|
15
|
+
*
|
|
16
|
+
* @defaultValue "docs/generated/api-reference"
|
|
17
|
+
*/
|
|
18
|
+
outputPath?: string;
|
|
19
|
+
/**
|
|
20
|
+
* The base URL for the documentation site.
|
|
21
|
+
*
|
|
22
|
+
* @defaultValue "/docs/"
|
|
23
|
+
*/
|
|
24
|
+
basePath?: string;
|
|
25
|
+
/**
|
|
26
|
+
* Options to be passed to the TypeDoc generator.
|
|
27
|
+
*
|
|
28
|
+
* @remarks
|
|
29
|
+
* These options will be override any other values passed to the TypeDoc generator.
|
|
30
|
+
*/
|
|
31
|
+
override?: Partial<TypeDocOptions>;
|
|
32
|
+
}
|
|
33
|
+
interface TypeDocPluginUserConfig extends UserConfig {
|
|
34
|
+
/**
|
|
35
|
+
* Options for the TypeDoc plugin.
|
|
36
|
+
*/
|
|
37
|
+
docs?: {
|
|
38
|
+
typedoc: TypeDocPluginOptions;
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
interface TypeDocPluginResolvedConfig extends ResolvedConfig {
|
|
42
|
+
/**
|
|
43
|
+
* Options for the TypeDoc plugin.
|
|
44
|
+
*/
|
|
45
|
+
docs: {
|
|
46
|
+
typedoc: TypeDocOptions & {
|
|
47
|
+
outputPath: string;
|
|
48
|
+
baseUrl: string;
|
|
49
|
+
override?: Partial<TypeDocOptions>;
|
|
50
|
+
};
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
type TypeDocPluginContext<TResolvedConfig extends TypeDocPluginResolvedConfig = TypeDocPluginResolvedConfig> = PluginContext<TResolvedConfig> & {
|
|
54
|
+
/**
|
|
55
|
+
* The initialized TypeDoc application.
|
|
56
|
+
*/
|
|
57
|
+
typedoc: Application;
|
|
58
|
+
};
|
|
59
|
+
declare type __ΩGenerateDocsOptions = any[];
|
|
60
|
+
declare type __ΩTypeDocPluginOptions = any[];
|
|
61
|
+
declare type __ΩTypeDocPluginUserConfig = any[];
|
|
62
|
+
declare type __ΩTypeDocPluginResolvedConfig = any[];
|
|
63
|
+
declare type __ΩTypeDocPluginContext = any[];
|
|
64
|
+
//#endregion
|
|
2
65
|
export { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig };
|
package/dist/types/plugin.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
export{};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@powerlines/plugin-typedoc",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.67",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "A package containing a Powerlines plugin for running TypeDoc on the codebase.",
|
|
6
6
|
"repository": {
|
|
@@ -100,19 +100,19 @@
|
|
|
100
100
|
"files": ["dist/**/*"],
|
|
101
101
|
"keywords": ["powerlines", "storm-software", "powerlines-plugin"],
|
|
102
102
|
"dependencies": {
|
|
103
|
-
"@storm-software/config-tools": "^1.188.
|
|
104
|
-
"@stryke/fs": "^0.33.
|
|
105
|
-
"@stryke/path": "^0.22.
|
|
106
|
-
"powerlines": "^0.30.
|
|
103
|
+
"@storm-software/config-tools": "^1.188.60",
|
|
104
|
+
"@stryke/fs": "^0.33.20",
|
|
105
|
+
"@stryke/path": "^0.22.11",
|
|
106
|
+
"powerlines": "^0.30.10",
|
|
107
107
|
"typedoc": "0.25.12",
|
|
108
108
|
"typedoc-plugin-markdown": "4.0.0-next.20"
|
|
109
109
|
},
|
|
110
110
|
"devDependencies": {
|
|
111
|
-
"@powerlines/nx": "^0.10.
|
|
112
|
-
"@storm-software/tsup": "^0.2.
|
|
111
|
+
"@powerlines/nx": "^0.10.59",
|
|
112
|
+
"@storm-software/tsup": "^0.2.58",
|
|
113
113
|
"@types/node": "^24.10.1",
|
|
114
114
|
"tsup": "8.4.0"
|
|
115
115
|
},
|
|
116
116
|
"publishConfig": { "access": "public" },
|
|
117
|
-
"gitHead": "
|
|
117
|
+
"gitHead": "1fa17406f69248e0a35ca56c09b1f4589e4d49d7"
|
|
118
118
|
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { };
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export { };
|
package/dist/plugin-Bvn-he2n.mjs
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export{};
|