@powerlines/plugin-typedoc 0.10.206 → 0.10.207
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/index.cjs +2 -3
- package/dist/index.mjs +2 -3
- package/dist/powerlines/src/internal/helpers/hooks.d.mts +0 -2
- package/dist/powerlines/src/types/commands.d.mts +0 -1
- package/dist/powerlines/src/types/config.d.cts +3 -2
- package/dist/powerlines/src/types/config.d.mts +5 -4
- package/dist/powerlines/src/types/resolved.d.cts +2 -2
- package/dist/powerlines/src/types/resolved.d.mts +2 -2
- package/dist/powerlines/src/types/unplugin.d.mts +0 -1
- package/package.json +4 -4
- package/dist/powerlines/src/types/babel.d.mts +0 -2
package/dist/index.cjs
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
Object.defineProperty(exports, '__esModule', { value: true });
|
|
2
2
|
const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
|
|
3
|
-
let __storm_software_config_tools_types = require("@storm-software/config-tools/types");
|
|
4
3
|
let __stryke_fs_exists = require("@stryke/fs/exists");
|
|
5
4
|
let __stryke_fs_helpers = require("@stryke/fs/helpers");
|
|
6
5
|
let __stryke_path_append = require("@stryke/path/append");
|
|
@@ -17,7 +16,7 @@ function plugin(options = {}) {
|
|
|
17
16
|
return {
|
|
18
17
|
name: "typedoc",
|
|
19
18
|
async config() {
|
|
20
|
-
this.
|
|
19
|
+
this.debug("Providing default configuration for the Powerlines `typedoc` build plugin.");
|
|
21
20
|
return { docs: { typedoc: (0, defu.default)(options, {
|
|
22
21
|
outputPath: (0, __stryke_path_join.joinPaths)(this.config.projectRoot, "docs", "generated", "api-reference"),
|
|
23
22
|
baseUrl: "/docs/",
|
|
@@ -47,7 +46,7 @@ function plugin(options = {}) {
|
|
|
47
46
|
]);
|
|
48
47
|
},
|
|
49
48
|
async docs() {
|
|
50
|
-
this.
|
|
49
|
+
this.debug(`Generating documentation for the Powerlines application with TypeDoc.`);
|
|
51
50
|
if ((0, __stryke_fs_exists.existsSync)(this.config.docs.typedoc.outputPath)) await (0, __stryke_fs_helpers.removeDirectory)(this.config.docs.typedoc.outputPath);
|
|
52
51
|
await (0, __stryke_fs_helpers.createDirectory)(this.config.docs.typedoc.outputPath);
|
|
53
52
|
const project = await this.typedoc.convert();
|
package/dist/index.mjs
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { LogLevelLabel } from "@storm-software/config-tools/types";
|
|
2
1
|
import { existsSync } from "@stryke/fs/exists";
|
|
3
2
|
import { createDirectory, removeDirectory } from "@stryke/fs/helpers";
|
|
4
3
|
import { appendPath } from "@stryke/path/append";
|
|
@@ -14,7 +13,7 @@ function plugin(options = {}) {
|
|
|
14
13
|
return {
|
|
15
14
|
name: "typedoc",
|
|
16
15
|
async config() {
|
|
17
|
-
this.
|
|
16
|
+
this.debug("Providing default configuration for the Powerlines `typedoc` build plugin.");
|
|
18
17
|
return { docs: { typedoc: defu(options, {
|
|
19
18
|
outputPath: joinPaths(this.config.projectRoot, "docs", "generated", "api-reference"),
|
|
20
19
|
baseUrl: "/docs/",
|
|
@@ -44,7 +43,7 @@ function plugin(options = {}) {
|
|
|
44
43
|
]);
|
|
45
44
|
},
|
|
46
45
|
async docs() {
|
|
47
|
-
this.
|
|
46
|
+
this.debug(`Generating documentation for the Powerlines application with TypeDoc.`);
|
|
48
47
|
if (existsSync(this.config.docs.typedoc.outputPath)) await removeDirectory(this.config.docs.typedoc.outputPath);
|
|
49
48
|
await createDirectory(this.config.docs.typedoc.outputPath);
|
|
50
49
|
const project = await this.typedoc.convert();
|
|
@@ -14,6 +14,7 @@ import { DateString } from "compatx";
|
|
|
14
14
|
|
|
15
15
|
//#region ../powerlines/src/types/config.d.ts
|
|
16
16
|
|
|
17
|
+
type LogLevel = "error" | "warn" | "info" | "debug" | "trace";
|
|
17
18
|
type LogFn = (type: LogLevelLabel, ...args: string[]) => void;
|
|
18
19
|
/**
|
|
19
20
|
* The {@link StormWorkspaceConfig | configuration} object for an entire Powerlines workspace
|
|
@@ -253,7 +254,7 @@ interface CommonUserConfig extends BaseConfig {
|
|
|
253
254
|
*
|
|
254
255
|
* @defaultValue "info"
|
|
255
256
|
*/
|
|
256
|
-
logLevel?:
|
|
257
|
+
logLevel?: LogLevel | null;
|
|
257
258
|
/**
|
|
258
259
|
* A custom logger function to use for logging messages
|
|
259
260
|
*/
|
|
@@ -420,4 +421,4 @@ type DeployInlineConfig<TUserConfig extends UserConfig$1 = UserConfig$1> = Inlin
|
|
|
420
421
|
command: "deploy";
|
|
421
422
|
};
|
|
422
423
|
//#endregion
|
|
423
|
-
export { BuildInlineConfig, CleanInlineConfig, DeployInlineConfig, DocsInlineConfig, ESBuildUserConfig, EnvironmentConfig, FarmUserConfig, InlineConfig, LintInlineConfig, LogFn, NewInlineConfig, OutputConfig, PluginConfig, PrepareInlineConfig, RolldownUserConfig, RollupUserConfig, RspackUserConfig, TsdownUserConfig, TsupUserConfig, UnbuildUserConfig, UserConfig$1 as UserConfig, ViteUserConfig, WebpackUserConfig, WorkspaceConfig };
|
|
424
|
+
export { BuildInlineConfig, CleanInlineConfig, DeployInlineConfig, DocsInlineConfig, ESBuildUserConfig, EnvironmentConfig, FarmUserConfig, InlineConfig, LintInlineConfig, LogFn, LogLevel, NewInlineConfig, OutputConfig, PluginConfig, PrepareInlineConfig, RolldownUserConfig, RollupUserConfig, RspackUserConfig, TsdownUserConfig, TsupUserConfig, UnbuildUserConfig, UserConfig$1 as UserConfig, ViteUserConfig, WebpackUserConfig, WorkspaceConfig };
|
|
@@ -1,19 +1,20 @@
|
|
|
1
1
|
import { BuildConfig, BuildResolvedConfig, ESBuildBuildConfig, ESBuildResolvedBuildConfig, FarmBuildConfig, FarmResolvedBuildConfig, RolldownBuildConfig, RolldownResolvedBuildConfig, RollupBuildConfig, RollupResolvedBuildConfig, RspackBuildConfig, RspackResolvedBuildConfig, TsdownBuildConfig, TsdownResolvedBuildConfig, TsupBuildConfig, TsupResolvedBuildConfig, UnbuildBuildConfig, UnbuildResolvedBuildConfig, ViteBuildConfig, ViteResolvedBuildConfig, WebpackBuildConfig, WebpackResolvedBuildConfig } from "./build.mjs";
|
|
2
|
-
import "./babel.mjs";
|
|
3
2
|
import { StoragePort, StoragePreset } from "./fs.mjs";
|
|
4
3
|
import { TSConfig } from "./tsconfig.mjs";
|
|
5
4
|
import { PluginContext } from "./context.mjs";
|
|
6
5
|
import { Plugin } from "./plugin.mjs";
|
|
7
|
-
import { LogLevelLabel } from "@storm-software/config-tools/types";
|
|
8
6
|
import { MaybePromise } from "@stryke/types/base";
|
|
9
7
|
import { PreviewOptions } from "vite";
|
|
10
8
|
import { Format } from "@storm-software/build-tools/types";
|
|
9
|
+
import { LogLevelLabel } from "@storm-software/config-tools/types";
|
|
11
10
|
import { StormWorkspaceConfig } from "@storm-software/config/types";
|
|
12
11
|
import { TypeDefinitionParameter } from "@stryke/types/configuration";
|
|
13
12
|
import { AssetGlob } from "@stryke/types/file";
|
|
14
13
|
import { DateString } from "compatx";
|
|
15
14
|
|
|
16
15
|
//#region ../powerlines/src/types/config.d.ts
|
|
16
|
+
|
|
17
|
+
type LogLevel = "error" | "warn" | "info" | "debug" | "trace";
|
|
17
18
|
type LogFn = (type: LogLevelLabel, ...args: string[]) => void;
|
|
18
19
|
/**
|
|
19
20
|
* The {@link StormWorkspaceConfig | configuration} object for an entire Powerlines workspace
|
|
@@ -253,7 +254,7 @@ interface CommonUserConfig extends BaseConfig {
|
|
|
253
254
|
*
|
|
254
255
|
* @defaultValue "info"
|
|
255
256
|
*/
|
|
256
|
-
logLevel?:
|
|
257
|
+
logLevel?: LogLevel | null;
|
|
257
258
|
/**
|
|
258
259
|
* A custom logger function to use for logging messages
|
|
259
260
|
*/
|
|
@@ -420,4 +421,4 @@ type DeployInlineConfig<TUserConfig extends UserConfig$1 = UserConfig$1> = Inlin
|
|
|
420
421
|
command: "deploy";
|
|
421
422
|
};
|
|
422
423
|
//#endregion
|
|
423
|
-
export { BuildInlineConfig, CleanInlineConfig, DeployInlineConfig, DocsInlineConfig, ESBuildUserConfig, EnvironmentConfig, FarmUserConfig, InlineConfig, LintInlineConfig, LogFn, NewInlineConfig, OutputConfig, PluginConfig, PrepareInlineConfig, RolldownUserConfig, RollupUserConfig, RspackUserConfig, TsdownUserConfig, TsupUserConfig, UnbuildUserConfig, UserConfig$1 as UserConfig, ViteUserConfig, WebpackUserConfig, WorkspaceConfig };
|
|
424
|
+
export { BuildInlineConfig, CleanInlineConfig, DeployInlineConfig, DocsInlineConfig, ESBuildUserConfig, EnvironmentConfig, FarmUserConfig, InlineConfig, LintInlineConfig, LogFn, LogLevel, NewInlineConfig, OutputConfig, PluginConfig, PrepareInlineConfig, RolldownUserConfig, RollupUserConfig, RspackUserConfig, TsdownUserConfig, TsupUserConfig, UnbuildUserConfig, UserConfig$1 as UserConfig, ViteUserConfig, WebpackUserConfig, WorkspaceConfig };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { BuilderVariant } from "./build.cjs";
|
|
2
|
-
import { ESBuildUserConfig, EnvironmentConfig, FarmUserConfig, InlineConfig, OutputConfig, RolldownUserConfig, RollupUserConfig, RspackUserConfig, TsdownUserConfig, TsupUserConfig, UnbuildUserConfig, UserConfig as UserConfig$1, ViteUserConfig, WebpackUserConfig } from "./config.cjs";
|
|
2
|
+
import { ESBuildUserConfig, EnvironmentConfig, FarmUserConfig, InlineConfig, LogLevel, OutputConfig, RolldownUserConfig, RollupUserConfig, RspackUserConfig, TsdownUserConfig, TsupUserConfig, UnbuildUserConfig, UserConfig as UserConfig$1, ViteUserConfig, WebpackUserConfig } from "./config.cjs";
|
|
3
3
|
import { NonUndefined } from "@stryke/types/base";
|
|
4
4
|
import { ResolvedPreviewOptions } from "vite";
|
|
5
5
|
import { TypeDefinition } from "@stryke/types/configuration";
|
|
@@ -76,7 +76,7 @@ type ResolvedConfig<TUserConfig extends UserConfig$1 = UserConfig$1> = Omit<TUse
|
|
|
76
76
|
*
|
|
77
77
|
* @defaultValue "info"
|
|
78
78
|
*/
|
|
79
|
-
logLevel:
|
|
79
|
+
logLevel: LogLevel | null;
|
|
80
80
|
};
|
|
81
81
|
type ViteResolvedConfig = ResolvedConfig<ViteUserConfig>;
|
|
82
82
|
type WebpackResolvedConfig = ResolvedConfig<WebpackUserConfig>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { BuilderVariant } from "./build.mjs";
|
|
2
|
-
import { ESBuildUserConfig, EnvironmentConfig, FarmUserConfig, InlineConfig, OutputConfig, RolldownUserConfig, RollupUserConfig, RspackUserConfig, TsdownUserConfig, TsupUserConfig, UnbuildUserConfig, UserConfig as UserConfig$1, ViteUserConfig, WebpackUserConfig } from "./config.mjs";
|
|
2
|
+
import { ESBuildUserConfig, EnvironmentConfig, FarmUserConfig, InlineConfig, LogLevel, OutputConfig, RolldownUserConfig, RollupUserConfig, RspackUserConfig, TsdownUserConfig, TsupUserConfig, UnbuildUserConfig, UserConfig as UserConfig$1, ViteUserConfig, WebpackUserConfig } from "./config.mjs";
|
|
3
3
|
import { NonUndefined } from "@stryke/types/base";
|
|
4
4
|
import { ResolvedPreviewOptions } from "vite";
|
|
5
5
|
import { TypeDefinition } from "@stryke/types/configuration";
|
|
@@ -76,7 +76,7 @@ type ResolvedConfig<TUserConfig extends UserConfig$1 = UserConfig$1> = Omit<TUse
|
|
|
76
76
|
*
|
|
77
77
|
* @defaultValue "info"
|
|
78
78
|
*/
|
|
79
|
-
logLevel:
|
|
79
|
+
logLevel: LogLevel | null;
|
|
80
80
|
};
|
|
81
81
|
type ViteResolvedConfig = ResolvedConfig<ViteUserConfig>;
|
|
82
82
|
type WebpackResolvedConfig = ResolvedConfig<WebpackUserConfig>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@powerlines/plugin-typedoc",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.207",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "A package containing a Powerlines plugin for running TypeDoc on the codebase.",
|
|
6
6
|
"repository": {
|
|
@@ -104,14 +104,14 @@
|
|
|
104
104
|
"@stryke/fs": "^0.33.36",
|
|
105
105
|
"@stryke/path": "^0.26.0",
|
|
106
106
|
"defu": "^6.1.4",
|
|
107
|
-
"powerlines": "^0.37.
|
|
107
|
+
"powerlines": "^0.37.73",
|
|
108
108
|
"typedoc": "0.25.12",
|
|
109
109
|
"typedoc-plugin-markdown": "4.0.0-next.20"
|
|
110
110
|
},
|
|
111
111
|
"devDependencies": {
|
|
112
|
-
"@powerlines/plugin-plugin": "^0.12.
|
|
112
|
+
"@powerlines/plugin-plugin": "^0.12.151",
|
|
113
113
|
"@types/node": "^24.10.9"
|
|
114
114
|
},
|
|
115
115
|
"publishConfig": { "access": "public" },
|
|
116
|
-
"gitHead": "
|
|
116
|
+
"gitHead": "df743ef7ebac849eb4ce90899884df4758b61172"
|
|
117
117
|
}
|