@powerlines/plugin-typedoc 0.1.0 → 0.3.0

package/dist/types/index.d.cts

@@ -1,24 +1,22 @@
 export { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig } from './plugin.cjs';
-import '@babel/core';
 import '@storm-software/build-tools/types';
 import '@storm-software/config-tools/types';
 import '@storm-software/config/types';
 import '@stryke/types/configuration';
 import '@stryke/types/file';
 import 'vite';
-import '@babel/helper-plugin-utils';
 import '@stryke/env/get-env-paths';
 import '@stryke/types/package-json';
 import 'jiti';
 import '@deepkit/type';
+import 'semver';
 import 'unplugin';
 import '@stryke/capnp';
 import '@stryke/types/base';
 import '@stryke/types/tsconfig';
 import 'typescript';
-import 'semver';
-import '@stryke/types/array';
 import 'memfs';
 import 'node:fs';
 import 'unionfs';
+import '@stryke/types/array';
 import 'typedoc';

package/dist/types/index.d.ts

@@ -1,24 +1,22 @@
 export { GenerateDocsOptions, TypeDocPluginContext, TypeDocPluginOptions, TypeDocPluginResolvedConfig, TypeDocPluginUserConfig, __ΩGenerateDocsOptions, __ΩTypeDocPluginContext, __ΩTypeDocPluginOptions, __ΩTypeDocPluginResolvedConfig, __ΩTypeDocPluginUserConfig } from './plugin.js';
-import '@babel/core';
 import '@storm-software/build-tools/types';
 import '@storm-software/config-tools/types';
 import '@storm-software/config/types';
 import '@stryke/types/configuration';
 import '@stryke/types/file';
 import 'vite';
-import '@babel/helper-plugin-utils';
 import '@stryke/env/get-env-paths';
 import '@stryke/types/package-json';
 import 'jiti';
 import '@deepkit/type';
+import 'semver';
 import 'unplugin';
 import '@stryke/capnp';
 import '@stryke/types/base';
 import '@stryke/types/tsconfig';
 import 'typescript';
-import 'semver';
-import '@stryke/types/array';
 import 'memfs';
 import 'node:fs';
 import 'unionfs';
+import '@stryke/types/array';
 import 'typedoc';

package/dist/types/plugin.d.cts

@@ -1,25 +1,23 @@
-import { PluginItem, PluginObj, PluginPass, transformAsync } from '@babel/core';
 import { Format } from '@storm-software/build-tools/types';
 import { LogLevelLabel } from '@storm-software/config-tools/types';
 import { StormWorkspaceConfig } from '@storm-software/config/types';
 import { TypeDefinition, TypeDefinitionParameter } from '@stryke/types/configuration';
 import { AssetGlob } from '@stryke/types/file';
 import { ResolvedPreviewOptions, PreviewOptions } from 'vite';
-import { BabelAPI } from '@babel/helper-plugin-utils';
 import { EnvPaths } from '@stryke/env/get-env-paths';
 import { PackageJson } from '@stryke/types/package-json';
 import { Jiti } from 'jiti';
 import { ReflectionClass } from '@deepkit/type';
+import { Range } from 'semver';
 import { TransformResult, ExternalIdResult, HookFilter, UnpluginOptions, UnpluginContext, UnpluginBuildContext } from 'unplugin';
 import * as $ from '@stryke/capnp';
 import { NonUndefined, MaybePromise, FunctionLike } from '@stryke/types/base';
 import { TsConfigJson, CompilerOptions } from '@stryke/types/tsconfig';
 import ts from 'typescript';
-import { Range } from 'semver';
-import { ArrayValues } from '@stryke/types/array';
 import { Volume } from 'memfs';
 import { StatSyncOptions, Stats, PathLike, RmDirOptions, RmOptions, Mode, MakeDirectoryOptions as MakeDirectoryOptions$1, PathOrFileDescriptor, WriteFileOptions as WriteFileOptions$1 } from 'node:fs';
 import { IUnionFs } from 'unionfs';
+import { ArrayValues } from '@stryke/types/array';
 import { ProjectReflection, TypeDocOptions, Application } from 'typedoc';
 
 declare const ReflectionKind: {
@@ -1655,7 +1653,7 @@ type OutputResolvedConfig = Required<Omit<OutputConfig, "assets"> & {
 /**
  * The resolved options for the Powerlines project configuration.
  */
-type ResolvedConfig<TUserConfig extends UserConfig = UserConfig> = Omit<TUserConfig, "name" | "title" | "plugins" | "mode" | "environments" | "platform" | "tsconfig" | "lint" | "build" | "transform" | "override" | "root" | "variant" | "type" | "output" | "logLevel"> & Required<Pick<TUserConfig, "name" | "title" | "plugins" | "mode" | "environments" | "tsconfig" | "build" | "transform" | "override">> & {
+type ResolvedConfig<TUserConfig extends UserConfig = UserConfig> = Omit<TUserConfig, "name" | "title" | "plugins" | "mode" | "environments" | "platform" | "tsconfig" | "lint" | "build" | "transform" | "override" | "root" | "variant" | "type" | "output" | "logLevel" | "framework"> & Required<Pick<TUserConfig, "name" | "title" | "plugins" | "mode" | "environments" | "tsconfig" | "build" | "transform" | "override" | "framework">> & {
     /**
      * The configuration options that were provided inline to the Powerlines CLI.
      */
@@ -1701,11 +1699,6 @@ type ResolvedConfig<TUserConfig extends UserConfig = UserConfig> = Omit<TUserCon
 declare const SUPPORTED_COMMANDS: readonly ["new", "clean", "prepare", "lint", "test", "build", "docs", "release", "finalize"];
 type CommandType = ArrayValues<typeof SUPPORTED_COMMANDS>;
 
-type PackageDependencyMeta = "dependency" | "devDependency" | {
-    version?: string | Range;
-    type?: "dependency" | "devDependency";
-};
-type PackageDependencies = Record<string, PackageDependencyMeta>;
 interface PluginHookObject<THookFunction extends FunctionLike, TFilter extends keyof HookFilter | undefined = undefined> {
     /**
      * The order in which the plugin should be applied.
@@ -2419,13 +2412,6 @@ interface Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> {
      * The relative path to the Powerlines workspace root directory
      */
     relativeToWorkspaceRoot: string;
-    /**
-     * The path to the \powerlines package
-     *
-     * @remarks
-     * This is used to determine the path to the Powerlines core package, which contains the runtime files.
-     */
-    corePackagePath: string;
     /**
      * The Powerlines artifacts directory
      */
@@ -2455,9 +2441,17 @@ interface Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> {
      */
     envPaths: EnvPaths;
     /**
-     * The installations required by the project
+     * The file system path to the Powerlines package installation
      */
-    dependencies: PackageDependencies;
+    powerlinesPath: string;
+    /**
+     * The dependency installations required by the project
+     */
+    dependencies: Record<string, string | Range>;
+    /**
+     * The development dependency installations required by the project
+     */
+    devDependencies: Record<string, string | Range>;
     /**
      * The project's `package.json` file content
      */
@@ -2512,24 +2506,6 @@ interface PluginContext<out TResolvedConfig extends ResolvedConfig = ResolvedCon
 }
 type BuildPluginContext<TResolvedConfig extends ResolvedConfig = ResolvedConfig> = PluginContext<TResolvedConfig> & UnpluginBuildContext;
 
-type BabelPluginPass<TState = unknown> = PluginPass & TState;
-type BabelTransformPluginFilter = (code: string, id: string) => boolean;
-type BabelTransformPlugin<TContext extends Context = Context, TOptions extends Record<string, any> = Record<string, any>, TState = unknown> = ((context: TContext) => (options: {
-    name: string;
-    log: LogFn;
-    api: BabelAPI;
-    options: TOptions;
-    context: TContext;
-    dirname: string;
-}) => PluginObj<TOptions & BabelPluginPass<TState>>) & {
-    $$name: string;
-};
-type BabelTransformPluginOptions<TContext extends Context = Context, TOptions extends Record<string, any> = Record<string, any>, TState = unknown> = PluginItem | BabelTransformPlugin<TContext, TOptions, TState> | [BabelTransformPlugin<TContext, TOptions, TState>, TOptions] | [
-    BabelTransformPlugin<TContext, TOptions, TState>,
-    TOptions,
-    BabelTransformPluginFilter
-];
-
 type LogFn = (type: LogLevelLabel, ...args: string[]) => void;
 /**
  * The {@link StormWorkspaceConfig | configuration} object for an entire Powerlines workspace
@@ -2555,16 +2531,6 @@ type PluginConfigObject<TProps = unknown, TContext extends PluginContext = Plugi
  */
 type PluginConfig<TContext extends PluginContext = PluginContext, TProps = unknown> = string | PluginFactory<void, TContext> | Plugin<TContext> | PluginConfigTuple<TProps> | PluginConfigObject<TProps>;
 type ProjectType = "application" | "library";
-type BabelUserConfig = Parameters<typeof transformAsync>[1] & {
-    /**
-     * The Babel plugins to be used during the build process
-     */
-    plugins?: BabelTransformPluginOptions[];
-    /**
-     * The Babel presets to be used during the build process
-     */
-    presets?: BabelTransformPluginOptions[];
-};
 interface ESLintConfig {
     eslintOptions?: any;
     reportErrorsOnly?: boolean;
@@ -2613,14 +2579,14 @@ interface OutputConfig {
      */
     builtinPrefix?: string;
     /**
-     * The folder where the generated runtime modules/builtins will be located
+     * The folder where the generated runtime artifacts will be located
      *
      * @remarks
-     * This folder will contain all runtime modules and builtins generated during the "prepare" phase.
+     * This folder will contain all runtime artifacts and builtins generated during the "prepare" phase.
      *
      * @defaultValue "\{projectRoot\}/.powerlines"
      */
-    runtimeFolder?: string;
+    artifactsFolder?: string;
     /**
      * The module format of the output files
      *
@@ -2638,19 +2604,6 @@ interface OutputConfig {
      */
     assets?: Array<string | AssetGlob>;
 }
-interface TransformConfig {
-    /**
-     * The Babel configuration options to use for the build process
-     */
-    babel?: BabelUserConfig;
-    /**
-     * Reflection configuration options for the Deepkit TSC custom transformers
-     *
-     * @remarks
-     * These options will be merged with the `tsconfig.json` file and the `tsconfigRaw` options.
-     */
-    deepkit?: DeepkitOptions;
-}
 interface BaseConfig {
     /**
      * The name of the project
@@ -2701,7 +2654,7 @@ interface BaseConfig {
     /**
      * Configuration for the transformation of the source code
      */
-    transform?: TransformConfig;
+    transform?: Record<string, any>;
     /**
      * Options to to provide to the build process
      */
@@ -2826,6 +2779,12 @@ interface CommonUserConfig extends BaseConfig {
      * Environment-specific configurations
      */
     environments?: Record<string, EnvironmentConfig>;
+    /**
+     * A string identifier that allows a child framework or tool to identify itself when using Powerlines.
+     *
+     * @defaultValue "powerlines"
+     */
+    framework?: string;
 }
 type UserConfig<TBuildConfig extends BuildConfig = BuildConfig, TBuildResolvedConfig extends BuildResolvedConfig = BuildResolvedConfig, TBuildVariant extends string = any> = CommonUserConfig & {
     build?: TBuildConfig & {

package/dist/types/plugin.d.ts

@@ -1,25 +1,23 @@
-import { PluginItem, PluginObj, PluginPass, transformAsync } from '@babel/core';
 import { Format } from '@storm-software/build-tools/types';
 import { LogLevelLabel } from '@storm-software/config-tools/types';
 import { StormWorkspaceConfig } from '@storm-software/config/types';
 import { TypeDefinition, TypeDefinitionParameter } from '@stryke/types/configuration';
 import { AssetGlob } from '@stryke/types/file';
 import { ResolvedPreviewOptions, PreviewOptions } from 'vite';
-import { BabelAPI } from '@babel/helper-plugin-utils';
 import { EnvPaths } from '@stryke/env/get-env-paths';
 import { PackageJson } from '@stryke/types/package-json';
 import { Jiti } from 'jiti';
 import { ReflectionClass } from '@deepkit/type';
+import { Range } from 'semver';
 import { TransformResult, ExternalIdResult, HookFilter, UnpluginOptions, UnpluginContext, UnpluginBuildContext } from 'unplugin';
 import * as $ from '@stryke/capnp';
 import { NonUndefined, MaybePromise, FunctionLike } from '@stryke/types/base';
 import { TsConfigJson, CompilerOptions } from '@stryke/types/tsconfig';
 import ts from 'typescript';
-import { Range } from 'semver';
-import { ArrayValues } from '@stryke/types/array';
 import { Volume } from 'memfs';
 import { StatSyncOptions, Stats, PathLike, RmDirOptions, RmOptions, Mode, MakeDirectoryOptions as MakeDirectoryOptions$1, PathOrFileDescriptor, WriteFileOptions as WriteFileOptions$1 } from 'node:fs';
 import { IUnionFs } from 'unionfs';
+import { ArrayValues } from '@stryke/types/array';
 import { ProjectReflection, TypeDocOptions, Application } from 'typedoc';
 
 declare const ReflectionKind: {
@@ -1655,7 +1653,7 @@ type OutputResolvedConfig = Required<Omit<OutputConfig, "assets"> & {
 /**
  * The resolved options for the Powerlines project configuration.
  */
-type ResolvedConfig<TUserConfig extends UserConfig = UserConfig> = Omit<TUserConfig, "name" | "title" | "plugins" | "mode" | "environments" | "platform" | "tsconfig" | "lint" | "build" | "transform" | "override" | "root" | "variant" | "type" | "output" | "logLevel"> & Required<Pick<TUserConfig, "name" | "title" | "plugins" | "mode" | "environments" | "tsconfig" | "build" | "transform" | "override">> & {
+type ResolvedConfig<TUserConfig extends UserConfig = UserConfig> = Omit<TUserConfig, "name" | "title" | "plugins" | "mode" | "environments" | "platform" | "tsconfig" | "lint" | "build" | "transform" | "override" | "root" | "variant" | "type" | "output" | "logLevel" | "framework"> & Required<Pick<TUserConfig, "name" | "title" | "plugins" | "mode" | "environments" | "tsconfig" | "build" | "transform" | "override" | "framework">> & {
     /**
      * The configuration options that were provided inline to the Powerlines CLI.
      */
@@ -1701,11 +1699,6 @@ type ResolvedConfig<TUserConfig extends UserConfig = UserConfig> = Omit<TUserCon
 declare const SUPPORTED_COMMANDS: readonly ["new", "clean", "prepare", "lint", "test", "build", "docs", "release", "finalize"];
 type CommandType = ArrayValues<typeof SUPPORTED_COMMANDS>;
 
-type PackageDependencyMeta = "dependency" | "devDependency" | {
-    version?: string | Range;
-    type?: "dependency" | "devDependency";
-};
-type PackageDependencies = Record<string, PackageDependencyMeta>;
 interface PluginHookObject<THookFunction extends FunctionLike, TFilter extends keyof HookFilter | undefined = undefined> {
     /**
      * The order in which the plugin should be applied.
@@ -2419,13 +2412,6 @@ interface Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> {
      * The relative path to the Powerlines workspace root directory
      */
     relativeToWorkspaceRoot: string;
-    /**
-     * The path to the \powerlines package
-     *
-     * @remarks
-     * This is used to determine the path to the Powerlines core package, which contains the runtime files.
-     */
-    corePackagePath: string;
     /**
      * The Powerlines artifacts directory
      */
@@ -2455,9 +2441,17 @@ interface Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> {
      */
     envPaths: EnvPaths;
     /**
-     * The installations required by the project
+     * The file system path to the Powerlines package installation
      */
-    dependencies: PackageDependencies;
+    powerlinesPath: string;
+    /**
+     * The dependency installations required by the project
+     */
+    dependencies: Record<string, string | Range>;
+    /**
+     * The development dependency installations required by the project
+     */
+    devDependencies: Record<string, string | Range>;
     /**
      * The project's `package.json` file content
      */
@@ -2512,24 +2506,6 @@ interface PluginContext<out TResolvedConfig extends ResolvedConfig = ResolvedCon
 }
 type BuildPluginContext<TResolvedConfig extends ResolvedConfig = ResolvedConfig> = PluginContext<TResolvedConfig> & UnpluginBuildContext;
 
-type BabelPluginPass<TState = unknown> = PluginPass & TState;
-type BabelTransformPluginFilter = (code: string, id: string) => boolean;
-type BabelTransformPlugin<TContext extends Context = Context, TOptions extends Record<string, any> = Record<string, any>, TState = unknown> = ((context: TContext) => (options: {
-    name: string;
-    log: LogFn;
-    api: BabelAPI;
-    options: TOptions;
-    context: TContext;
-    dirname: string;
-}) => PluginObj<TOptions & BabelPluginPass<TState>>) & {
-    $$name: string;
-};
-type BabelTransformPluginOptions<TContext extends Context = Context, TOptions extends Record<string, any> = Record<string, any>, TState = unknown> = PluginItem | BabelTransformPlugin<TContext, TOptions, TState> | [BabelTransformPlugin<TContext, TOptions, TState>, TOptions] | [
-    BabelTransformPlugin<TContext, TOptions, TState>,
-    TOptions,
-    BabelTransformPluginFilter
-];
-
 type LogFn = (type: LogLevelLabel, ...args: string[]) => void;
 /**
  * The {@link StormWorkspaceConfig | configuration} object for an entire Powerlines workspace
@@ -2555,16 +2531,6 @@ type PluginConfigObject<TProps = unknown, TContext extends PluginContext = Plugi
  */
 type PluginConfig<TContext extends PluginContext = PluginContext, TProps = unknown> = string | PluginFactory<void, TContext> | Plugin<TContext> | PluginConfigTuple<TProps> | PluginConfigObject<TProps>;
 type ProjectType = "application" | "library";
-type BabelUserConfig = Parameters<typeof transformAsync>[1] & {
-    /**
-     * The Babel plugins to be used during the build process
-     */
-    plugins?: BabelTransformPluginOptions[];
-    /**
-     * The Babel presets to be used during the build process
-     */
-    presets?: BabelTransformPluginOptions[];
-};
 interface ESLintConfig {
     eslintOptions?: any;
     reportErrorsOnly?: boolean;
@@ -2613,14 +2579,14 @@ interface OutputConfig {
      */
     builtinPrefix?: string;
     /**
-     * The folder where the generated runtime modules/builtins will be located
+     * The folder where the generated runtime artifacts will be located
      *
      * @remarks
-     * This folder will contain all runtime modules and builtins generated during the "prepare" phase.
+     * This folder will contain all runtime artifacts and builtins generated during the "prepare" phase.
      *
      * @defaultValue "\{projectRoot\}/.powerlines"
      */
-    runtimeFolder?: string;
+    artifactsFolder?: string;
     /**
      * The module format of the output files
      *
@@ -2638,19 +2604,6 @@ interface OutputConfig {
      */
     assets?: Array<string | AssetGlob>;
 }
-interface TransformConfig {
-    /**
-     * The Babel configuration options to use for the build process
-     */
-    babel?: BabelUserConfig;
-    /**
-     * Reflection configuration options for the Deepkit TSC custom transformers
-     *
-     * @remarks
-     * These options will be merged with the `tsconfig.json` file and the `tsconfigRaw` options.
-     */
-    deepkit?: DeepkitOptions;
-}
 interface BaseConfig {
     /**
      * The name of the project
@@ -2701,7 +2654,7 @@ interface BaseConfig {
     /**
      * Configuration for the transformation of the source code
      */
-    transform?: TransformConfig;
+    transform?: Record<string, any>;
     /**
      * Options to to provide to the build process
      */
@@ -2826,6 +2779,12 @@ interface CommonUserConfig extends BaseConfig {
      * Environment-specific configurations
      */
     environments?: Record<string, EnvironmentConfig>;
+    /**
+     * A string identifier that allows a child framework or tool to identify itself when using Powerlines.
+     *
+     * @defaultValue "powerlines"
+     */
+    framework?: string;
 }
 type UserConfig<TBuildConfig extends BuildConfig = BuildConfig, TBuildResolvedConfig extends BuildResolvedConfig = BuildResolvedConfig, TBuildVariant extends string = any> = CommonUserConfig & {
     build?: TBuildConfig & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powerlines/plugin-typedoc",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "type": "module",
   "description": "A package containing a Powerlines plugin for running TypeDoc on the codebase.",
   "repository": {
@@ -89,18 +89,18 @@
   "keywords": ["powerlines", "storm-software", "powerlines-plugin"],
   "dependencies": {
     "@storm-software/config-tools": "^1.188.6",
-    "@stryke/path": "^0.15.5",
     "@stryke/fs": "^0.31.4",
-    "powerlines": "^0.2.0",
+    "@stryke/path": "^0.15.5",
+    "powerlines": "^0.4.0",
     "typedoc": "0.25.12",
     "typedoc-plugin-markdown": "4.0.0-next.20"
   },
   "devDependencies": {
-    "@powerlines/nx": "^0.2.0",
+    "@powerlines/nx": "^0.4.0",
     "@storm-software/tsup": "^0.2.4",
     "@types/node": "^22.18.11",
     "tsup": "8.4.0"
   },
   "publishConfig": { "access": "public" },
-  "gitHead": "319be4880b93666a6dafe38d60278a8cad920f0b"
+  "gitHead": "f4d0c8a8f0036ac8de46ac96afd9336a390a7268"
 }