@powerlines/plugin-env 0.13.63 → 0.13.65

package/dist/powerlines/src/types/config.d.cts

@@ -0,0 +1,356 @@
+import { StoragePort, StoragePreset } from "./fs.cjs";
+import { BuildConfig, BuildResolvedConfig } from "./build.cjs";
+import { Plugin } from "./plugin.cjs";
+import { TSConfig } from "./tsconfig.cjs";
+import { PluginContext } from "./context.cjs";
+import { BabelTransformPluginOptions } from "./babel.cjs";
+import { 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 { MaybePromise } from "@stryke/types/base";
+import { TypeDefinitionParameter } from "@stryke/types/configuration";
+import { AssetGlob } from "@stryke/types/file";
+import { PreviewOptions } from "vite";
+
+//#region ../powerlines/src/types/config.d.ts
+type LogFn = (type: LogLevelLabel, ...args: string[]) => void;
+/**
+ * The {@link StormWorkspaceConfig | configuration} object for an entire Powerlines workspace
+ */
+type WorkspaceConfig = Partial<StormWorkspaceConfig> & Required<Pick<StormWorkspaceConfig, "workspaceRoot">>;
+type PluginFactory<in out TContext extends PluginContext = PluginContext, TOptions = any> = (options: TOptions) => MaybePromise<Plugin<TContext>>;
+/**
+ * A configuration tuple for a Powerlines plugin.
+ */
+type PluginConfigTuple<TContext extends PluginContext = PluginContext, TOptions = any> = [string | PluginFactory<TContext, TOptions>, TOptions] | [Plugin<TContext>];
+/**
+ * A configuration object for a Powerlines plugin.
+ */
+type PluginConfigObject<TContext extends PluginContext = PluginContext, TOptions = any> = {
+  plugin: string | PluginFactory<TContext, TOptions>;
+  options: TOptions;
+} | {
+  plugin: Plugin<TContext>;
+  options?: never;
+};
+/**
+ * A configuration tuple for a Powerlines plugin.
+ */
+type PluginConfig<TContext extends PluginContext = PluginContext> = string | PluginFactory<TContext, void> | Plugin<TContext> | Promise<Plugin<TContext>> | PluginConfigTuple<TContext> | PluginConfigObject<TContext>;
+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 DeployConfig {
+  /**
+   * The deployment variant being used by the Powerlines engine.
+   *
+   * @example
+   * ```ts
+   * export default defineConfig({
+   *  deploy: {
+   *    variant: "cloudflare"
+   *  }
+   * });
+   *
+   * ```
+   */
+  variant?: string;
+}
+interface OutputConfig {
+  /**
+   * The path to output the final compiled files to
+   *
+   * @remarks
+   * If a value is not provided, Powerlines will attempt to:
+   * 1. Use the `outDir` value in the `tsconfig.json` file.
+   * 2. Use the `dist` directory in the project root directory.
+   *
+   * @defaultValue "dist/\{projectRoot\}"
+   */
+  outputPath?: string;
+  /**
+   * The output directory path for the project build.
+   *
+   * @remarks
+   * This path is used to determine where the built files will be placed after the build process completes. This will be used in scenarios where the monorepo uses TSConfig paths to link packages together.
+   *
+   * @defaultValue "\{projectRoot\}/dist"
+   */
+  buildPath?: string;
+  /**
+   * The folder where the generated runtime artifacts will be located
+   *
+   * @remarks
+   * This folder will contain all runtime artifacts and builtins generated during the "prepare" phase.
+   *
+   * @defaultValue "\{projectRoot\}/.powerlines"
+   */
+  artifactsPath?: string;
+  /**
+   * The path of the generated runtime declaration file relative to the workspace root.
+   *
+   * @defaultValue "\{projectRoot\}/powerlines.d.ts"
+   */
+  dts?: string | false;
+  /**
+   * A prefix to use for identifying builtin modules
+   *
+   * @remarks
+   * This prefix will be used to identify all builtin modules generated during the "prepare" phase. An example builtin ID for a module called `"utils"` would be `"{builtinPrefix}:utils"`.
+   *
+   * @defaultValue "powerlines"
+   */
+  builtinPrefix?: string;
+  /**
+   * The module format of the output files
+   *
+   * @remarks
+   * This option can be a single format or an array of formats. If an array is provided, multiple builds will be generated for each format.
+   *
+   * @defaultValue "esm"
+   */
+  format?: Format | Format[];
+  /**
+   * A list of assets to copy to the output directory
+   *
+   * @remarks
+   * The assets can be specified as a string (path to the asset) or as an object with a `glob` property (to match multiple files). The paths are relative to the project root directory.
+   */
+  assets?: Array<string | AssetGlob>;
+  /**
+   * A string preset or a custom {@link StoragePort} to provide fine-grained control over generated/output file storage.
+   *
+   * @remarks
+   * If a string preset is provided, it must be one of the following values:
+   * - `"virtual"`: Uses the local file system for storage.
+   * - `"fs"`: Uses an in-memory virtual file system for storage.
+   *
+   * If a custom {@link StoragePort} is provided, it will be used for all file storage operations during the build process.
+   *
+   * @defaultValue "virtual"
+   */
+  storage?: StoragePort | StoragePreset;
+}
+interface BaseConfig {
+  /**
+   * The entry point(s) for the application
+   */
+  entry?: TypeDefinitionParameter | TypeDefinitionParameter[];
+  /**
+   * Configuration for the output of the build process
+   */
+  output?: OutputConfig;
+  /**
+   * Configuration for cleaning the build artifacts
+   *
+   * @remarks
+   * If set to `false`, the cleaning process will be disabled.
+   */
+  clean?: Record<string, any> | false;
+  /**
+   * Configuration for linting the source code
+   *
+   * @remarks
+   * If set to `false`, linting will be disabled.
+   */
+  lint?: Record<string, any> | false;
+  /**
+   * Configuration for testing the source code
+   *
+   * @remarks
+   * If set to `false`, testing will be disabled.
+   */
+  test?: Record<string, any> | false;
+  /**
+   * Configuration for the transformation of the source code
+   */
+  transform?: Record<string, any>;
+  /**
+   * Configuration provided to build processes
+   *
+   * @remarks
+   * This configuration can be used by plugins during the `build` command. It will generally contain options specific to the selected {@link BuildVariant | build variant}.
+   */
+  build?: BuildConfig;
+  /**
+   * Configuration for documentation generation
+   *
+   * @remarks
+   * This configuration will be used by the documentation generation plugins during the `docs` command.
+   */
+  docs?: Record<string, any>;
+  /**
+   * Configuration for deploying the source code
+   *
+   * @remarks
+   * If set to `false`, the deployment will be disabled.
+   */
+  deploy?: DeployConfig | false;
+  /**
+   * The path to the tsconfig file to be used by the compiler
+   *
+   * @remarks
+   * If a value is not provided, the plugin will attempt to find the `tsconfig.json` file in the project root directory. The parsed tsconfig compiler options will be merged with the {@link Options.tsconfigRaw} value (if provided).
+   *
+   * @defaultValue "\{projectRoot\}/tsconfig.json"
+   */
+  tsconfig?: string;
+  /**
+   * The raw {@link TSConfig} object to be used by the compiler. This object will be merged with the `tsconfig.json` file.
+   *
+   * @see https://www.typescriptlang.org/tsconfig
+   *
+   * @remarks
+   * If populated, this option takes higher priority than `tsconfig`
+   */
+  tsconfigRaw?: TSConfig;
+}
+interface EnvironmentConfig extends BaseConfig {
+  /**
+   * Configuration options for the preview server
+   */
+  preview?: PreviewOptions;
+  /**
+   * A flag indicating whether the build is for a Server-Side Rendering environment.
+   */
+  ssr?: boolean;
+  /**
+   * Define if this environment is used for Server-Side Rendering
+   *
+   * @defaultValue "server" (if it isn't the client environment)
+   */
+  consumer?: "client" | "server";
+}
+interface CommonUserConfig extends BaseConfig {
+  /**
+   * The name of the project
+   */
+  name?: string;
+  /**
+   * The project display title
+   *
+   * @remarks
+   * This option is used in documentation generation and other places where a human-readable title is needed.
+   */
+  title?: string;
+  /**
+   * A description of the project
+   *
+   * @remarks
+   * If this option is not provided, the build process will try to use the \`description\` value from the `\package.json\` file.
+   */
+  description?: string;
+  /**
+   * The log level to use for the Powerlines processes.
+   *
+   * @defaultValue "info"
+   */
+  logLevel?: LogLevelLabel | null;
+  /**
+   * A custom logger function to use for logging messages
+   */
+  customLogger?: LogFn;
+  /**
+   * Explicitly set a mode to run in. This mode will be used at various points throughout the Powerlines processes, such as when compiling the source code.
+   *
+   * @defaultValue "production"
+   */
+  mode?: "development" | "test" | "production";
+  /**
+   * The type of project being built
+   *
+   * @defaultValue "application"
+   */
+  type?: ProjectType;
+  /**
+   * The root directory of the project
+   */
+  root: string;
+  /**
+   * The root directory of the project's source code
+   *
+   * @defaultValue "\{root\}/src"
+   */
+  sourceRoot?: string;
+  /**
+   * A path to a custom configuration file to be used instead of the default `storm.json`, `powerlines.config.js`, or `powerlines.config.ts` files.
+   *
+   * @remarks
+   * This option is useful for running Powerlines commands with different configuration files, such as in CI/CD environments or when testing different configurations.
+   */
+  configFile?: string;
+  /**
+   * Should the Powerlines CLI processes skip installing missing packages?
+   *
+   * @remarks
+   * This option is useful for CI/CD environments where the installation of packages is handled by a different process.
+   *
+   * @defaultValue false
+   */
+  skipInstalls?: boolean;
+  /**
+   * Should the compiler processes skip any improvements that make use of cache?
+   *
+   * @defaultValue false
+   */
+  skipCache?: boolean;
+  /**
+   * A list of resolvable paths to plugins used during the build process
+   */
+  plugins?: PluginConfig<PluginContext<any>>[];
+  /**
+   * Environment-specific configurations
+   */
+  environments?: Record<string, EnvironmentConfig>;
+  /**
+   * A string identifier that allows a child framework or tool to identify itself when using Powerlines.
+   *
+   * @remarks
+   * If no values are provided for {@link OutputConfig.dts | output.dts}, {@link OutputConfig.builtinPrefix | output.builtinPrefix}, or {@link OutputConfig.artifactsPath | output.artifactsFolder}, this value will be used as the default.
+   *
+   * @defaultValue "powerlines"
+   */
+  framework?: string;
+}
+interface UserConfig<TBuildConfig extends BuildConfig = BuildConfig, TBuildResolvedConfig extends BuildResolvedConfig = BuildResolvedConfig, TBuildVariant extends string = any> extends Omit<CommonUserConfig, "build"> {
+  /**
+   * Configuration provided to build processes
+   *
+   * @remarks
+   * This configuration can be used by plugins during the `build` command. It will generally contain options specific to the selected {@link BuildVariant | build variant}.
+   */
+  build: Omit<TBuildConfig, "override"> & {
+    /**
+     * The build variant being used by the Powerlines engine.
+     */
+    variant?: TBuildVariant;
+    /**
+     * An optional set of override options to apply to the selected build variant.
+     *
+     * @remarks
+     * This option allows you to provide configuration options with the guarantee that they will **not** be overridden and will take precedence over other build configurations.
+     */
+    override?: Partial<TBuildResolvedConfig>;
+  };
+}
+type PowerlinesCommand = "new" | "prepare" | "build" | "lint" | "test" | "docs" | "deploy" | "clean";
+/**
+ * The configuration provided while executing Powerlines commands.
+ */
+type InlineConfig<TUserConfig extends UserConfig = UserConfig> = Partial<TUserConfig> & {
+  /**
+   * A string identifier for the Powerlines command being executed
+   */
+  command: PowerlinesCommand;
+};
+//#endregion
+export { BabelUserConfig, EnvironmentConfig, InlineConfig, LogFn, OutputConfig, PluginConfig, UserConfig, WorkspaceConfig };