bun-workspaces 1.5.0 → 1.5.2

package/src/cli/commands/runScript/output/renderGroupedOutput.d.ts

@@ -1,75 +0,0 @@
-import {
-  type TypedEvent,
-  TypedEventTarget,
-} from "../../../../internal/core/language/events/typedEventTarget";
-import type {
-  RunScriptAcrossWorkspacesOutput,
-  RunWorkspaceScriptMetadata,
-} from "../../../../project";
-import type {
-  RunScriptExit,
-  RunScriptsSummary,
-  ScriptEventName,
-} from "../../../../runScript";
-import type { Workspace } from "../../../../workspaces";
-import type { WriteOutputOptions } from "../../../createCli";
-type ScriptEvent = TypedEvent<
-  ScriptEventName,
-  {
-    workspace: Workspace;
-    exitResult: RunScriptExit<RunWorkspaceScriptMetadata> | null;
-  }
->;
-declare class ScriptEventTarget extends TypedEventTarget<{
-  [key in ScriptEvent["type"]]: ScriptEvent;
-}> {}
-export declare const createScriptEventTarget: () => ScriptEventTarget;
-export declare const createScriptEvent: {
-  start: (
-    properties: Omit<
-      {
-        type: ScriptEventName;
-      } & {
-        workspace: Workspace;
-        exitResult: RunScriptExit<RunWorkspaceScriptMetadata> | null;
-      },
-      "type"
-    >,
-    options?: EventInit,
-  ) => ScriptEvent;
-  skip: (
-    properties: Omit<
-      {
-        type: ScriptEventName;
-      } & {
-        workspace: Workspace;
-        exitResult: RunScriptExit<RunWorkspaceScriptMetadata> | null;
-      },
-      "type"
-    >,
-    options?: EventInit,
-  ) => ScriptEvent;
-  exit: (
-    properties: Omit<
-      {
-        type: ScriptEventName;
-      } & {
-        workspace: Workspace;
-        exitResult: RunScriptExit<RunWorkspaceScriptMetadata> | null;
-      },
-      "type"
-    >,
-    options?: EventInit,
-  ) => ScriptEvent;
-};
-export declare const renderGroupedOutput: (
-  workspaces: Workspace[],
-  output: RunScriptAcrossWorkspacesOutput,
-  summary: Promise<RunScriptsSummary<RunWorkspaceScriptMetadata>>,
-  scriptEventTarget: ScriptEventTarget,
-  activeScriptLines: number | "all" | "auto",
-  outputWriters: Required<WriteOutputOptions>,
-  terminalWidth: number,
-  terminalHeight: number,
-) => Promise<void>;
-export {};

package/src/cli/commands/runScript/output/renderPlainOutput.d.ts

@@ -1,24 +0,0 @@
-import type { RunScriptAcrossWorkspacesOutput } from "../../../../project";
-import type { WriteOutputOptions } from "../../../createCli";
-export type RenderPlainOutputOptions = {
-  stripDisruptiveControls?: boolean;
-  prefix?: boolean;
-};
-export declare function generatePlainOutputLines(
-  output: RunScriptAcrossWorkspacesOutput,
-  { stripDisruptiveControls, prefix }: RenderPlainOutputOptions,
-): AsyncGenerator<
-  {
-    line: string;
-    metadata: import("../../../..").RunWorkspaceScriptMetadata & {
-      streamName: import("../../../..").OutputStreamName;
-    };
-  },
-  void,
-  unknown
->;
-export declare const renderPlainOutput: (
-  output: RunScriptAcrossWorkspacesOutput,
-  outputWriters: Required<WriteOutputOptions>,
-  { stripDisruptiveControls, prefix }: RenderPlainOutputOptions,
-) => Promise<void>;

package/src/cli/commands/runScript/output/sanitizeChunk.d.ts

@@ -1,4 +0,0 @@
-export declare const sanitizeChunk: (
-  input: string,
-  stripDisruptiveControls?: boolean,
-) => string;

package/src/cli/createCli.d.ts

@@ -1,26 +0,0 @@
-import { type CliMiddlewareOptions } from "./middleware";
-export interface WriteOutputOptions {
-  stdout?: (...args: Parameters<typeof process.stdout.write>) => void;
-  stderr?: (...args: Parameters<typeof process.stderr.write>) => void;
-}
-export interface RunCliOptions {
-  argv?: string[];
-  /** Should be `true` if args do not include the binary name (e.g. `bunx bun-workspaces`) */
-  programmatic?: true;
-  middleware?: CliMiddlewareOptions;
-  writeOutput?: WriteOutputOptions;
-  terminalWidth?: number;
-  terminalHeight?: number;
-}
-export interface CLI {
-  run: (options?: RunCliOptions) => Promise<void>;
-}
-export interface CreateCliOptions {
-  defaultCwd?: string;
-  /** Always handled when the result `.run()` is called */
-  defaultMiddleware?: CliMiddlewareOptions;
-}
-export declare const createCli: ({
-  defaultCwd,
-  defaultMiddleware,
-}?: CreateCliOptions) => CLI;

package/src/cli/fatalErrorLogger.d.ts

@@ -1 +0,0 @@
-export declare const fatalErrorLogger: import("../internal/logger").Logger;

package/src/cli/globalOptions/globalOptions.d.ts

@@ -1,43 +0,0 @@
-import { type Command } from "commander";
-import type { CliMiddleware } from "../middleware";
-export declare const initializeWithGlobalOptions: (
-  program: Command,
-  args: string[],
-  middleware: CliMiddleware,
-) => {
-  project: import("../../internal/core").Simplify<{
-    readonly rootDirectory: string;
-    readonly workspaces: import("../..").Workspace[];
-    readonly name: string;
-    readonly sourceType: "fileSystem";
-    readonly config: import("../../project").ProjectConfig;
-    readonly rootWorkspace: import("../..").Workspace;
-    runWorkspaceScript(
-      options: import("../..").RunWorkspaceScriptOptions,
-    ): import("../..").RunWorkspaceScriptResult;
-    runScriptAcrossWorkspaces(
-      options: import("../..").RunScriptAcrossWorkspacesOptions,
-    ): import("../..").RunScriptAcrossWorkspacesResult;
-    listWorkspacesWithScript(scriptName: string): import("../..").Workspace[];
-    mapScriptsToWorkspaces(): Record<
-      string,
-      import("../..").WorkspaceScriptMetadata
-    >;
-    mapTagsToWorkspaces(): Record<string, import("../..").Workspace[]>;
-    findWorkspaceByName(
-      workspaceName: string,
-    ): import("../..").Workspace | null;
-    findWorkspaceByAlias(alias: string): import("../..").Workspace | null;
-    findWorkspaceByNameOrAlias(
-      nameOrAlias: string,
-    ): import("../..").Workspace | null;
-    listWorkspacesWithTag(tag: string): import("../..").Workspace[];
-    findWorkspacesByPattern(
-      ...workspacePatterns: string[]
-    ): import("../..").Workspace[];
-    createScriptCommand(
-      options: import("../..").CreateProjectScriptCommandOptions,
-    ): import("../..").CreateProjectScriptCommandResult;
-  }>;
-  projectError: Error | null;
-};

package/src/cli/globalOptions/globalOptionsConfig.d.ts

@@ -1,52 +0,0 @@
-import { type LogLevelSetting } from "../../internal/logger";
-export interface CliGlobalOptions {
-  logLevel: LogLevelSetting;
-  cwd: string;
-  includeRoot: boolean;
-  workspaceRoot: boolean;
-}
-export interface CliGlobalOptionConfig {
-  mainOption: string;
-  shortOption: string;
-  description: string;
-  defaultValue: string;
-  values: string[] | null;
-  param: string;
-}
-export type CliGlobalOptionName = keyof CliGlobalOptions;
-export declare const getCliGlobalOptionConfig: (
-  optionName: CliGlobalOptionName,
-) =>
-  | {
-      readonly mainOption: "--log-level";
-      readonly shortOption: "-l";
-      readonly description: "Log levels";
-      readonly defaultValue: "info";
-      readonly values: ("debug" | "info" | "warn" | "error" | "silent")[];
-      readonly param: "level";
-    }
-  | {
-      readonly mainOption: "--cwd";
-      readonly shortOption: "-d";
-      readonly description: "Working directory";
-      readonly defaultValue: "";
-      readonly values: null;
-      readonly param: "path";
-    }
-  | {
-      readonly mainOption: "--include-root";
-      readonly shortOption: "-r";
-      readonly description: "Include the root workspace as a normal workspace";
-      readonly defaultValue: "";
-      readonly values: null;
-      readonly param: "";
-    }
-  | {
-      readonly mainOption: "--workspace-root";
-      readonly shortOption: "-w";
-      readonly description: "Run from the project root above the current working directory";
-      readonly defaultValue: "";
-      readonly values: null;
-      readonly param: "";
-    };
-export declare const getCliGlobalOptionNames: () => CliGlobalOptionName[];

package/src/cli/globalOptions/globalOptionsConfig.mjs

@@ -1,43 +0,0 @@
-import { LOG_LEVELS } from "../../internal/logger/index.mjs"; // CONCATENATED MODULE: external "../../internal/logger/index.mjs"
-// CONCATENATED MODULE: ./src/cli/globalOptions/globalOptionsConfig.ts
-
-const CLI_GLOBAL_OPTIONS_CONFIG = {
-  logLevel: {
-    mainOption: "--log-level",
-    shortOption: "-l",
-    description: "Log levels",
-    defaultValue: "info",
-    values: [...LOG_LEVELS, "silent"],
-    param: "level",
-  },
-  cwd: {
-    mainOption: "--cwd",
-    shortOption: "-d",
-    description: "Working directory",
-    defaultValue: "",
-    values: null,
-    param: "path",
-  },
-  includeRoot: {
-    mainOption: "--include-root",
-    shortOption: "-r",
-    description: "Include the root workspace as a normal workspace",
-    defaultValue: "",
-    values: null,
-    param: "",
-  },
-  workspaceRoot: {
-    mainOption: "--workspace-root",
-    shortOption: "-w",
-    description:
-      "Run from the project root above the current working directory",
-    defaultValue: "",
-    values: null,
-    param: "",
-  },
-};
-const getCliGlobalOptionConfig = (optionName) =>
-  CLI_GLOBAL_OPTIONS_CONFIG[optionName];
-const getCliGlobalOptionNames = () => Object.keys(CLI_GLOBAL_OPTIONS_CONFIG);
-
-export { getCliGlobalOptionConfig, getCliGlobalOptionNames };

package/src/cli/globalOptions/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./globalOptionsConfig";
-export * from "./globalOptions";

package/src/cli/middleware.d.ts

@@ -1,83 +0,0 @@
-import type { Command as CommanderProgram } from "commander";
-import type { FileSystemProject } from "../project";
-import type { CliCommandName, CliGlobalCommandName } from "./commands";
-import type {
-  GlobalCommandContext,
-  ProjectCommandContext,
-} from "./commands/commandHandlerUtils";
-export type InitProgramContext = {
-  commanderProgram: CommanderProgram;
-  argv: string[];
-};
-export type ProcessArgvContext = {
-  commanderProgram: CommanderProgram;
-  args: string[];
-  postTerminatorArgs: string[];
-};
-export type ProcessWorkingDirectoryContext = {
-  commanderProgram: CommanderProgram;
-  workingDirectory: string;
-  exists: boolean;
-  isDirectory: boolean;
-};
-export type FindProjectContext = {
-  commanderProgram: CommanderProgram;
-  project: FileSystemProject;
-  projectError: Error | null;
-};
-export type PreParseContext = {
-  commanderProgram: CommanderProgram;
-  args: string[];
-  project: FileSystemProject;
-  projectError: Error | null;
-};
-export type PostParseContext = {
-  commanderProgram: CommanderProgram;
-  args: string[];
-  project: FileSystemProject;
-  projectError: Error | null;
-};
-export type CommandMiddlewareContext<C extends CliCommandName> = {
-  commanderProgram: CommanderProgram;
-  commandName: C;
-  commandContext: C extends CliGlobalCommandName
-    ? GlobalCommandContext
-    : ProjectCommandContext;
-  commanderActionArgs: unknown[];
-};
-export type CommandMiddleware = <C extends CliCommandName>(
-  context: CommandMiddlewareContext<C>,
-) => CommanderProgram;
-export type PostCleanupContext = {
-  commanderProgram: CommanderProgram;
-  args: string[];
-  project: FileSystemProject;
-  projectError: Error | null;
-};
-export type CliMiddleware = {
-  /** The first callback when the Commander program is created */
-  initProgram: (context: InitProgramContext) => CommanderProgram;
-  /** Before the true parsing, just splitting the argv into args and post-terminator args */
-  processArgv: (context: ProcessArgvContext) => CommanderProgram;
-  /** Before the working directory is changed */
-  processWorkingDirectory: (
-    context: ProcessWorkingDirectoryContext,
-  ) => CommanderProgram;
-  /** After the project has been initialized from global options */
-  findProject: (context: FindProjectContext) => CommanderProgram;
-  /** Before the Commander program parses the args */
-  preParse: (context: PreParseContext) => CommanderProgram;
-  /** After the Commander program has parsed the args (runs in finally block) */
-  postParse: (context: PostParseContext) => CommanderProgram;
-  /** Before a command is handled */
-  preHandleCommand: CommandMiddleware;
-  /** After a command is handled */
-  postHandleCommand: CommandMiddleware;
-  /** After the program has been parsed */
-  catchError: (error: Error) => unknown;
-};
-export type CliMiddlewareOptions = Partial<CliMiddleware>;
-export declare const resolveMiddleware: (
-  defaultMiddleware: CliMiddlewareOptions,
-  runMiddleware: CliMiddlewareOptions,
-) => CliMiddleware;

package/src/config/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./workspaceConfig";
-export * from "./rootConfig";
-export * from "./util";

package/src/config/rootConfig/defineRootConfig.d.ts

@@ -1,4 +0,0 @@
-import { type RootConfig, type ResolvedRootConfig } from "./rootConfig";
-export declare const defineRootConfig: (
-  config: RootConfig,
-) => ResolvedRootConfig;

package/src/config/rootConfig/errors.d.ts

@@ -1 +0,0 @@
-export declare const ROOT_CONFIG_ERRORS: import("../../internal/core").DefinedErrors<"InvalidRootConfig">;

package/src/config/rootConfig/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./rootConfigSchema";
-export * from "./rootConfig";
-export * from "./loadRootConfig";
-export * from "./errors";
-export * from "./rootConfigLocation";

package/src/config/rootConfig/loadRootConfig.d.ts

@@ -1,3 +0,0 @@
-export declare const loadRootConfig: (
-  rootDirectory: string,
-) => import("./rootConfig").ResolvedRootConfig;

package/src/config/rootConfig/rootConfig.d.ts

@@ -1,25 +0,0 @@
-import type { ShellOption } from "../../project";
-import { type ParallelMaxValue, type ScriptShellOption } from "../../runScript";
-export type RootConfig = {
-  defaults?: {
-    /** The maximum number of scripts that can run in parallel. (default: "auto") */
-    parallelMax?: ParallelMaxValue;
-    /** The shell to use for inline scripts. (default: "bun") */
-    shell?: ShellOption;
-    /** Whether to include the root workspace in the workspaces list by default. (default: false) */
-    includeRootWorkspace?: boolean;
-  };
-};
-export type ResolvedRootConfig = {
-  defaults: {
-    parallelMax: number;
-    shell: ScriptShellOption;
-    /** `undefined` means the value was not set in the input config */
-    includeRootWorkspace: boolean | undefined;
-  };
-};
-export declare const validateRootConfig: (config: RootConfig) => void;
-export declare const createDefaultRootConfig: () => ResolvedRootConfig;
-export declare const resolveRootConfig: (
-  config: RootConfig,
-) => ResolvedRootConfig;

package/src/config/rootConfig/rootConfigLocation.d.ts

@@ -1,2 +0,0 @@
-export declare const ROOT_CONFIG_FILE_NAME = "bw.root";
-export declare const ROOT_CONFIG_PACKAGE_JSON_KEY = "bw-root";

package/src/config/rootConfig/rootConfigLocation.mjs

@@ -1,5 +0,0 @@
-// CONCATENATED MODULE: ./src/config/rootConfig/rootConfigLocation.ts
-const ROOT_CONFIG_FILE_NAME = "bw.root";
-const ROOT_CONFIG_PACKAGE_JSON_KEY = "bw-root";
-
-export { ROOT_CONFIG_FILE_NAME, ROOT_CONFIG_PACKAGE_JSON_KEY };

package/src/config/rootConfig/rootConfigSchema.d.ts

@@ -1,21 +0,0 @@
-export declare const ROOT_CONFIG_JSON_SCHEMA: {
-  readonly type: "object";
-  readonly additionalProperties: false;
-  readonly properties: {
-    readonly defaults: {
-      readonly type: "object";
-      readonly additionalProperties: false;
-      readonly properties: {
-        readonly parallelMax: {
-          readonly type: readonly ["number", "string"];
-        };
-        readonly shell: {
-          readonly type: "string";
-        };
-        readonly includeRootWorkspace: {
-          readonly type: "boolean";
-        };
-      };
-    };
-  };
-};

package/src/config/userEnvVars/index.d.ts

@@ -1 +0,0 @@
-export * from "./userEnvVars";

package/src/config/userEnvVars/userEnvVars.d.ts

@@ -1,13 +0,0 @@
-export declare const USER_ENV_VARS: {
-  readonly parallelMaxDefault: "BW_PARALLEL_MAX_DEFAULT";
-  readonly scriptShellDefault: "BW_SHELL_DEFAULT";
-  readonly includeRootWorkspaceDefault: "BW_INCLUDE_ROOT_WORKSPACE_DEFAULT";
-};
-export type UserEnvVarName = keyof typeof USER_ENV_VARS;
-export declare const getUserEnvVar: (key: UserEnvVarName) => string | undefined;
-export declare const getUserEnvVarName: (
-  key: UserEnvVarName,
-) =>
-  | "BW_PARALLEL_MAX_DEFAULT"
-  | "BW_SHELL_DEFAULT"
-  | "BW_INCLUDE_ROOT_WORKSPACE_DEFAULT";

package/src/config/util/ajvTypes.d.ts

@@ -1,10 +0,0 @@
-export type AjvJsonSchemaErrorObject = {
-  instancePath?: string;
-  schemaPath?: string;
-  keyword?: string;
-  params?: Record<string, unknown>;
-  message?: string;
-};
-export type AjvSchemaValidator<T = unknown> = ((data: unknown) => data is T) & {
-  errors?: AjvJsonSchemaErrorObject[] | null;
-};

package/src/config/util/configLocation.d.ts

@@ -1,18 +0,0 @@
-export declare const CONFIG_LOCATION_TYPES: readonly [
-  "tsFile",
-  "jsFile",
-  "jsoncFile",
-  "jsonFile",
-  "packageJson",
-];
-export type ConfigLocationType = (typeof CONFIG_LOCATION_TYPES)[number];
-export type ConfigLocation = {
-  type: ConfigLocationType;
-  content: unknown;
-  path: string;
-};
-export declare const createConfigLocationPath: (
-  locationType: ConfigLocationType,
-  name: string,
-  packageJsonKey: string,
-) => string;

package/src/config/util/index.d.ts

@@ -1,4 +0,0 @@
-export type * from "./ajvTypes";
-export * from "./loadConfig";
-export * from "./validateConfig";
-export * from "./configLocation";

package/src/config/util/loadConfig.d.ts

@@ -1,18 +0,0 @@
-import { type AnyFunction } from "../../internal/core";
-import { type ConfigLocation } from "./configLocation";
-export declare const LOAD_CONFIG_ERRORS: import("../../internal/core").DefinedErrors<
-  "InvalidJSON" | "NoExportError" | "ModuleLoadFailure"
->;
-export declare const getConfigLocation: (
-  name: string,
-  directory: string,
-  fileName: string,
-  packageJsonKey: string,
-) => ConfigLocation | null;
-export declare const loadConfig: <ProcessContent extends AnyFunction>(
-  name: string,
-  directory: string,
-  fileName: string,
-  packageJsonKey: string,
-  processContent: ProcessContent,
-) => ReturnType<ProcessContent> | null;

package/src/config/util/validateConfig.d.ts

@@ -1,8 +0,0 @@
-import type { BunWorkspacesError } from "../../internal/core";
-import type { AjvSchemaValidator } from "./ajvTypes";
-export declare const executeValidator: <Config extends object>(
-  validator: AjvSchemaValidator<Config>,
-  name: string,
-  config: Config,
-  ErrorType: typeof BunWorkspacesError,
-) => void;

package/src/config/workspaceConfig/defineWorkspaceConfig.d.ts

@@ -1,7 +0,0 @@
-import {
-  type ResolvedWorkspaceConfig,
-  type WorkspaceConfig,
-} from "./workspaceConfig";
-export declare const defineWorkspaceConfig: (
-  config: WorkspaceConfig,
-) => ResolvedWorkspaceConfig;

package/src/config/workspaceConfig/errors.d.ts

@@ -1 +0,0 @@
-export declare const WORKSPACE_CONFIG_ERRORS: import("../../internal/core").DefinedErrors<"InvalidWorkspaceConfig">;

package/src/config/workspaceConfig/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./workspaceConfigSchema";
-export * from "./workspaceConfig";
-export * from "./loadWorkspaceConfig";
-export * from "./errors";
-export * from "./workspaceConfigLocation";

package/src/config/workspaceConfig/loadWorkspaceConfig.d.ts

@@ -1,3 +0,0 @@
-export declare const loadWorkspaceConfig: (
-  workspacePath: string,
-) => import("./workspaceConfig").ResolvedWorkspaceConfig;

package/src/config/workspaceConfig/workspaceConfig.d.ts

@@ -1,56 +0,0 @@
-export type WorkspaceDependenciesRule = {
-  allowPatterns?: string[];
-  denyPatterns?: string[];
-};
-export type WorkspaceRules = {
-  /** Allowed or denied workspace dependencies */
-  workspaceDependencies?: WorkspaceDependenciesRule;
-};
-/** Configuration that applies to a specific package.json script */
-export type ScriptConfig = {
-  /**
-   * The order in which the script should be executed.
-   *
-   * This is used to sort the scripts in the workspace.
-   *
-   * Scripts with no `order` set will be executed in alphanumerical order
-   * of their relative path from the project root.
-   */
-  order?: number;
-};
-/** Configuration that applies to a specific workspace */
-export type WorkspaceConfig = {
-  /**
-   * An alias or list of aliases for the workspace.
-   *
-   * These must be unique to other workspaces' aliases
-   * and package.json names.
-   */
-  alias?: string | string[];
-  /**
-   * Tags for the workspace.
-   *
-   * These can be used to group workspaces
-   * by a common tag.
-   */
-  tags?: string[];
-  /**
-   * Configuration that maps to a script name in the workspace's package.json.
-   */
-  scripts?: Record<string, ScriptConfig>;
-  /**
-   * Rules that validate the workspace.
-   */
-  rules?: WorkspaceRules;
-};
-export type ResolvedWorkspaceConfig = {
-  aliases: string[];
-  tags: string[];
-  scripts: Record<string, ScriptConfig>;
-  rules: WorkspaceRules;
-};
-export declare const validateWorkspaceConfig: (config: WorkspaceConfig) => void;
-export declare const resolveWorkspaceConfig: (
-  config: WorkspaceConfig,
-) => ResolvedWorkspaceConfig;
-export declare const createDefaultWorkspaceConfig: () => ResolvedWorkspaceConfig;

package/src/config/workspaceConfig/workspaceConfigLocation.d.ts

@@ -1,2 +0,0 @@
-export declare const WORKSPACE_CONFIG_FILE_NAME = "bw.workspace";
-export declare const WORKSPACE_CONFIG_PACKAGE_JSON_KEY = "bw";

package/src/config/workspaceConfig/workspaceConfigLocation.mjs

@@ -1,5 +0,0 @@
-// CONCATENATED MODULE: ./src/config/workspaceConfig/workspaceConfigLocation.ts
-const WORKSPACE_CONFIG_FILE_NAME = "bw.workspace";
-const WORKSPACE_CONFIG_PACKAGE_JSON_KEY = "bw";
-
-export { WORKSPACE_CONFIG_FILE_NAME, WORKSPACE_CONFIG_PACKAGE_JSON_KEY };