@powerlines/plugin-typedoc 0.2.0 → 0.3.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.
@@ -9,14 +9,14 @@ import '@stryke/env/get-env-paths';
9
9
  import '@stryke/types/package-json';
10
10
  import 'jiti';
11
11
  import '@deepkit/type';
12
+ import 'semver';
12
13
  import 'unplugin';
13
14
  import '@stryke/capnp';
14
15
  import '@stryke/types/base';
15
16
  import '@stryke/types/tsconfig';
16
17
  import 'typescript';
17
- import 'semver';
18
- import '@stryke/types/array';
19
18
  import 'memfs';
20
19
  import 'node:fs';
21
20
  import 'unionfs';
21
+ import '@stryke/types/array';
22
22
  import 'typedoc';
@@ -9,14 +9,14 @@ import '@stryke/env/get-env-paths';
9
9
  import '@stryke/types/package-json';
10
10
  import 'jiti';
11
11
  import '@deepkit/type';
12
+ import 'semver';
12
13
  import 'unplugin';
13
14
  import '@stryke/capnp';
14
15
  import '@stryke/types/base';
15
16
  import '@stryke/types/tsconfig';
16
17
  import 'typescript';
17
- import 'semver';
18
- import '@stryke/types/array';
19
18
  import 'memfs';
20
19
  import 'node:fs';
21
20
  import 'unionfs';
21
+ import '@stryke/types/array';
22
22
  import 'typedoc';
@@ -8,16 +8,16 @@ import { EnvPaths } from '@stryke/env/get-env-paths';
8
8
  import { PackageJson } from '@stryke/types/package-json';
9
9
  import { Jiti } from 'jiti';
10
10
  import { ReflectionClass } from '@deepkit/type';
11
+ import { Range } from 'semver';
11
12
  import { TransformResult, ExternalIdResult, HookFilter, UnpluginOptions, UnpluginContext, UnpluginBuildContext } from 'unplugin';
12
13
  import * as $ from '@stryke/capnp';
13
14
  import { NonUndefined, MaybePromise, FunctionLike } from '@stryke/types/base';
14
15
  import { TsConfigJson, CompilerOptions } from '@stryke/types/tsconfig';
15
16
  import ts from 'typescript';
16
- import { Range } from 'semver';
17
- import { ArrayValues } from '@stryke/types/array';
18
17
  import { Volume } from 'memfs';
19
18
  import { StatSyncOptions, Stats, PathLike, RmDirOptions, RmOptions, Mode, MakeDirectoryOptions as MakeDirectoryOptions$1, PathOrFileDescriptor, WriteFileOptions as WriteFileOptions$1 } from 'node:fs';
20
19
  import { IUnionFs } from 'unionfs';
20
+ import { ArrayValues } from '@stryke/types/array';
21
21
  import { ProjectReflection, TypeDocOptions, Application } from 'typedoc';
22
22
 
23
23
  declare const ReflectionKind: {
@@ -1699,11 +1699,6 @@ type ResolvedConfig<TUserConfig extends UserConfig = UserConfig> = Omit<TUserCon
1699
1699
  declare const SUPPORTED_COMMANDS: readonly ["new", "clean", "prepare", "lint", "test", "build", "docs", "release", "finalize"];
1700
1700
  type CommandType = ArrayValues<typeof SUPPORTED_COMMANDS>;
1701
1701
 
1702
- type PackageDependencyMeta = "dependency" | "devDependency" | {
1703
- version?: string | Range;
1704
- type?: "dependency" | "devDependency";
1705
- };
1706
- type PackageDependencies = Record<string, PackageDependencyMeta>;
1707
1702
  interface PluginHookObject<THookFunction extends FunctionLike, TFilter extends keyof HookFilter | undefined = undefined> {
1708
1703
  /**
1709
1704
  * The order in which the plugin should be applied.
@@ -2417,13 +2412,6 @@ interface Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> {
2417
2412
  * The relative path to the Powerlines workspace root directory
2418
2413
  */
2419
2414
  relativeToWorkspaceRoot: string;
2420
- /**
2421
- * The path to the \powerlines package
2422
- *
2423
- * @remarks
2424
- * This is used to determine the path to the Powerlines core package, which contains the runtime files.
2425
- */
2426
- corePackagePath: string;
2427
2415
  /**
2428
2416
  * The Powerlines artifacts directory
2429
2417
  */
@@ -2453,9 +2441,17 @@ interface Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> {
2453
2441
  */
2454
2442
  envPaths: EnvPaths;
2455
2443
  /**
2456
- * The installations required by the project
2444
+ * The file system path to the Powerlines package installation
2445
+ */
2446
+ powerlinesPath: string;
2447
+ /**
2448
+ * The dependency installations required by the project
2449
+ */
2450
+ dependencies: Record<string, string | Range>;
2451
+ /**
2452
+ * The development dependency installations required by the project
2457
2453
  */
2458
- dependencies: PackageDependencies;
2454
+ devDependencies: Record<string, string | Range>;
2459
2455
  /**
2460
2456
  * The project's `package.json` file content
2461
2457
  */
@@ -2583,14 +2579,14 @@ interface OutputConfig {
2583
2579
  */
2584
2580
  builtinPrefix?: string;
2585
2581
  /**
2586
- * The folder where the generated runtime modules/builtins will be located
2582
+ * The folder where the generated runtime artifacts will be located
2587
2583
  *
2588
2584
  * @remarks
2589
- * This folder will contain all runtime modules and builtins generated during the "prepare" phase.
2585
+ * This folder will contain all runtime artifacts and builtins generated during the "prepare" phase.
2590
2586
  *
2591
2587
  * @defaultValue "\{projectRoot\}/.powerlines"
2592
2588
  */
2593
- runtimeFolder?: string;
2589
+ artifactsFolder?: string;
2594
2590
  /**
2595
2591
  * The module format of the output files
2596
2592
  *
@@ -8,16 +8,16 @@ import { EnvPaths } from '@stryke/env/get-env-paths';
8
8
  import { PackageJson } from '@stryke/types/package-json';
9
9
  import { Jiti } from 'jiti';
10
10
  import { ReflectionClass } from '@deepkit/type';
11
+ import { Range } from 'semver';
11
12
  import { TransformResult, ExternalIdResult, HookFilter, UnpluginOptions, UnpluginContext, UnpluginBuildContext } from 'unplugin';
12
13
  import * as $ from '@stryke/capnp';
13
14
  import { NonUndefined, MaybePromise, FunctionLike } from '@stryke/types/base';
14
15
  import { TsConfigJson, CompilerOptions } from '@stryke/types/tsconfig';
15
16
  import ts from 'typescript';
16
- import { Range } from 'semver';
17
- import { ArrayValues } from '@stryke/types/array';
18
17
  import { Volume } from 'memfs';
19
18
  import { StatSyncOptions, Stats, PathLike, RmDirOptions, RmOptions, Mode, MakeDirectoryOptions as MakeDirectoryOptions$1, PathOrFileDescriptor, WriteFileOptions as WriteFileOptions$1 } from 'node:fs';
20
19
  import { IUnionFs } from 'unionfs';
20
+ import { ArrayValues } from '@stryke/types/array';
21
21
  import { ProjectReflection, TypeDocOptions, Application } from 'typedoc';
22
22
 
23
23
  declare const ReflectionKind: {
@@ -1699,11 +1699,6 @@ type ResolvedConfig<TUserConfig extends UserConfig = UserConfig> = Omit<TUserCon
1699
1699
  declare const SUPPORTED_COMMANDS: readonly ["new", "clean", "prepare", "lint", "test", "build", "docs", "release", "finalize"];
1700
1700
  type CommandType = ArrayValues<typeof SUPPORTED_COMMANDS>;
1701
1701
 
1702
- type PackageDependencyMeta = "dependency" | "devDependency" | {
1703
- version?: string | Range;
1704
- type?: "dependency" | "devDependency";
1705
- };
1706
- type PackageDependencies = Record<string, PackageDependencyMeta>;
1707
1702
  interface PluginHookObject<THookFunction extends FunctionLike, TFilter extends keyof HookFilter | undefined = undefined> {
1708
1703
  /**
1709
1704
  * The order in which the plugin should be applied.
@@ -2417,13 +2412,6 @@ interface Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> {
2417
2412
  * The relative path to the Powerlines workspace root directory
2418
2413
  */
2419
2414
  relativeToWorkspaceRoot: string;
2420
- /**
2421
- * The path to the \powerlines package
2422
- *
2423
- * @remarks
2424
- * This is used to determine the path to the Powerlines core package, which contains the runtime files.
2425
- */
2426
- corePackagePath: string;
2427
2415
  /**
2428
2416
  * The Powerlines artifacts directory
2429
2417
  */
@@ -2453,9 +2441,17 @@ interface Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> {
2453
2441
  */
2454
2442
  envPaths: EnvPaths;
2455
2443
  /**
2456
- * The installations required by the project
2444
+ * The file system path to the Powerlines package installation
2445
+ */
2446
+ powerlinesPath: string;
2447
+ /**
2448
+ * The dependency installations required by the project
2449
+ */
2450
+ dependencies: Record<string, string | Range>;
2451
+ /**
2452
+ * The development dependency installations required by the project
2457
2453
  */
2458
- dependencies: PackageDependencies;
2454
+ devDependencies: Record<string, string | Range>;
2459
2455
  /**
2460
2456
  * The project's `package.json` file content
2461
2457
  */
@@ -2583,14 +2579,14 @@ interface OutputConfig {
2583
2579
  */
2584
2580
  builtinPrefix?: string;
2585
2581
  /**
2586
- * The folder where the generated runtime modules/builtins will be located
2582
+ * The folder where the generated runtime artifacts will be located
2587
2583
  *
2588
2584
  * @remarks
2589
- * This folder will contain all runtime modules and builtins generated during the "prepare" phase.
2585
+ * This folder will contain all runtime artifacts and builtins generated during the "prepare" phase.
2590
2586
  *
2591
2587
  * @defaultValue "\{projectRoot\}/.powerlines"
2592
2588
  */
2593
- runtimeFolder?: string;
2589
+ artifactsFolder?: string;
2594
2590
  /**
2595
2591
  * The module format of the output files
2596
2592
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@powerlines/plugin-typedoc",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "type": "module",
5
5
  "description": "A package containing a Powerlines plugin for running TypeDoc on the codebase.",
6
6
  "repository": {
@@ -91,16 +91,16 @@
91
91
  "@storm-software/config-tools": "^1.188.6",
92
92
  "@stryke/fs": "^0.31.4",
93
93
  "@stryke/path": "^0.15.5",
94
- "powerlines": "^0.3.0",
94
+ "powerlines": "^0.4.0",
95
95
  "typedoc": "0.25.12",
96
96
  "typedoc-plugin-markdown": "4.0.0-next.20"
97
97
  },
98
98
  "devDependencies": {
99
- "@powerlines/nx": "^0.3.0",
99
+ "@powerlines/nx": "^0.4.0",
100
100
  "@storm-software/tsup": "^0.2.4",
101
101
  "@types/node": "^22.18.11",
102
102
  "tsup": "8.4.0"
103
103
  },
104
104
  "publishConfig": { "access": "public" },
105
- "gitHead": "fe5e201169810dd966ee328fa3dabf57077eea36"
105
+ "gitHead": "f4d0c8a8f0036ac8de46ac96afd9336a390a7268"
106
106
  }