bun-workspaces 1.5.0 → 1.5.2

package/src/runScript/output/multiProcessOutput.d.ts

@@ -1,14 +0,0 @@
-import {
-  type ProcessOutput,
-  type BytesOutput,
-  type TextOutput,
-} from "./processOutput";
-export interface MultiProcessOutput<Metadata extends object = object> {
-  bytes(): BytesOutput<Metadata>;
-  text(): TextOutput<Metadata>;
-}
-export declare const createMultiProcessOutput: <
-  Metadata extends object = object,
->(
-  processes: ProcessOutput<Metadata>[],
-) => MultiProcessOutput<Metadata>;

package/src/runScript/output/outputStream.d.ts

@@ -1 +0,0 @@
-export type OutputStreamName = "stdout" | "stderr";

package/src/runScript/output/processOutput.d.ts

@@ -1,33 +0,0 @@
-import { type SimpleAsyncIterable } from "../../internal/core";
-export type ByteStream = SimpleAsyncIterable<Uint8Array<ArrayBufferLike>>;
-export type ProcessOutputChunk<
-  Chunk = unknown,
-  Metadata extends object = object,
-> = {
-  /** The metadata for the script that produced the output chunk */
-  metadata: Metadata;
-  /** The output chunk */
-  chunk: Chunk;
-};
-export type ByteChunk<Metadata extends object = object> = ProcessOutputChunk<
-  Uint8Array<ArrayBufferLike>,
-  Metadata
->;
-export type TextChunk<Metadata extends object = object> = ProcessOutputChunk<
-  string,
-  Metadata
->;
-export type BytesOutput<Metadata extends object = object> = SimpleAsyncIterable<
-  ByteChunk<Metadata>
->;
-export type TextOutput<Metadata extends object = object> = SimpleAsyncIterable<
-  TextChunk<Metadata>
->;
-export interface ProcessOutput<Metadata extends object = object> {
-  bytes(): BytesOutput<Metadata>;
-  text(): TextOutput<Metadata>;
-}
-export declare const createProcessOutput: <Metadata extends object = object>(
-  stream: ByteStream,
-  metadata: Metadata,
-) => ProcessOutput<Metadata>;

package/src/runScript/parallel.d.ts

@@ -1,24 +0,0 @@
-export declare const PARALLEL_MAX_VALUES: readonly [
-  "auto",
-  "unbounded",
-  "default",
-];
-export type PercentageValue = `${number}%`;
-/**
- * The maximum number of scripts that can run in parallel.
- *
- * - `number`: The exact number of scripts that can run in parallel.
- * - `"auto"`: The number of available logical CPU threads.
- * - `"unbounded"`: No limit.
- * - `"default"`: The default value, either "auto" or the value of the root config's "parallelMax" option.
- * - `"${number}%"`: A percentage of the available logical CPU threads (e.g. "50%").
- */
-export type ParallelMaxValue =
-  | number
-  | (typeof PARALLEL_MAX_VALUES)[number]
-  | PercentageValue;
-/** Should always return at least 1 */
-export declare const determineParallelMax: (
-  value: ParallelMaxValue,
-  errorMessageSuffix?: string,
-) => number;

package/src/runScript/recursion.d.ts

@@ -1,4 +0,0 @@
-export declare const checkIsRecursiveScript: (
-  workspaceName: string,
-  scriptName: string,
-) => boolean | undefined;

package/src/runScript/runScript.d.ts

@@ -1,45 +0,0 @@
-import { type MultiProcessOutput, type OutputStreamName } from "./output";
-import type { ScriptCommand } from "./scriptCommand";
-import type { ScriptShellOption } from "./scriptShellOption";
-export type RunScriptExit<ScriptMetadata extends object = object> = {
-  exitCode: number;
-  signal: NodeJS.Signals | null;
-  success: boolean;
-  /** Whether the script was skipped due to a failed dependency */
-  skipped?: boolean;
-  startTimeISO: string;
-  endTimeISO: string;
-  durationMs: number;
-  metadata: ScriptMetadata;
-};
-export type RunScriptResult<ScriptMetadata extends object = object> = {
-  output: MultiProcessOutput<
-    ScriptMetadata & {
-      streamName: OutputStreamName;
-    }
-  >;
-  exit: Promise<RunScriptExit<ScriptMetadata>>;
-  metadata: ScriptMetadata;
-  kill: (exit?: number | NodeJS.Signals) => void;
-};
-export type RunScriptOptions<ScriptMetadata extends object = object> = {
-  scriptCommand: ScriptCommand;
-  metadata: ScriptMetadata;
-  env: Record<string, string>;
-  /** The shell to use to run the script. Defaults to "system". */
-  shell?: ScriptShellOption;
-  /** Set to `true` to ignore all output from the script. This saves memory when you don't need script output. */
-  ignoreOutput?: boolean;
-};
-/**
- * Run some script and get an async output stream of
- * stdout and stderr chunks and a result object
- * containing exit details.
- */
-export declare const runScript: <ScriptMetadata extends object = object>({
-  scriptCommand,
-  metadata,
-  env,
-  shell,
-  ignoreOutput,
-}: RunScriptOptions<ScriptMetadata>) => RunScriptResult<ScriptMetadata>;

package/src/runScript/runScripts.d.ts

@@ -1,65 +0,0 @@
-import { type MultiProcessOutput, type OutputStreamName } from "./output";
-import { type ParallelMaxValue } from "./parallel";
-import { type RunScriptExit, type RunScriptResult } from "./runScript";
-import { type ScriptCommand } from "./scriptCommand";
-import { type ScriptShellOption } from "./scriptShellOption";
-export type RunScriptsScript<ScriptMetadata extends object = object> = {
-  scriptCommand: ScriptCommand;
-  metadata: ScriptMetadata;
-  env: Record<string, string>;
-  /** The shell to use to run the script */
-  shell?: ScriptShellOption;
-  /** Indices of other scripts in the array that must complete before this one starts */
-  dependsOn?: number[];
-  /** Set to `true` to ignore all output from the script. This saves memory when you don't need script output. */
-  ignoreOutput?: boolean;
-};
-export type RunScriptsScriptResult<ScriptMetadata extends object = object> = {
-  /** The result of running the script */
-  result: RunScriptResult<ScriptMetadata>;
-};
-export type RunScriptsSummary<ScriptMetadata extends object = object> = {
-  totalCount: number;
-  successCount: number;
-  failureCount: number;
-  allSuccess: boolean;
-  startTimeISO: string;
-  endTimeISO: string;
-  durationMs: number;
-  scriptResults: RunScriptExit<ScriptMetadata>[];
-};
-export type ScriptEventName = "start" | "skip" | "exit";
-export type RunScriptsResult<ScriptMetadata extends object = object> = {
-  output: MultiProcessOutput<
-    ScriptMetadata & {
-      streamName: OutputStreamName;
-    }
-  >;
-  /** Resolves with a results summary after all scripts have exited */
-  summary: Promise<RunScriptsSummary<ScriptMetadata>>;
-};
-export type RunScriptsParallelOptions = {
-  max: ParallelMaxValue;
-};
-export type RunScriptsOptions<ScriptMetadata extends object = object> = {
-  scripts: RunScriptsScript<ScriptMetadata>[];
-  parallel: boolean | RunScriptsParallelOptions;
-  /** When true, run scripts even if a dependency failed. Default: false (skip them). */
-  ignoreDependencyFailure?: boolean;
-  /** Set to `true` to ignore all output from the scripts. This saves memory when you don't need script output. */
-  ignoreOutput?: boolean;
-  /** Callback to invoke when a script event occurs */
-  onScriptEvent?: (
-    event: ScriptEventName,
-    scriptIndex: number,
-    result: RunScriptExit<ScriptMetadata> | null,
-  ) => void;
-};
-/** Run a list of scripts */
-export declare const runScripts: <ScriptMetadata extends object = object>({
-  scripts,
-  parallel,
-  ignoreDependencyFailure,
-  ignoreOutput,
-  onScriptEvent,
-}: RunScriptsOptions<ScriptMetadata>) => RunScriptsResult<ScriptMetadata>;

package/src/runScript/scriptCommand.d.ts

@@ -1,33 +0,0 @@
-import type { Workspace } from "../workspaces";
-export declare const WORKSPACE_SCRIPT_COMMAND_METHODS: readonly [
-  "cd",
-  "filter",
-];
-export type WorkspaceScriptCommandMethod =
-  (typeof WORKSPACE_SCRIPT_COMMAND_METHODS)[number];
-/** Basic metadata to run a script, the command string and the directory to run it in */
-export interface ScriptCommand {
-  /** The command string to run */
-  command: string;
-  /** The directory to run the command in */
-  workingDirectory: string;
-}
-export interface CreateWorkspaceScriptCommandOptions {
-  /**
-   * The method to use to run the script.
-   * Either run in the workspace directory or use bun's --filter option.
-   * Defaults to "cd".
-   */
-  method?: WorkspaceScriptCommandMethod;
-  /** The name of the script to run */
-  scriptName: string;
-  /** The arguments to append to the command */
-  args: string;
-  /** The workspace that the script belongs to */
-  workspace: Workspace;
-  /** The root directory of the project */
-  rootDirectory: string;
-}
-export declare const createWorkspaceScriptCommand: (
-  options: CreateWorkspaceScriptCommandOptions,
-) => ScriptCommand;

package/src/runScript/scriptExecution.d.ts

@@ -1,9 +0,0 @@
-import { type ScriptShellOption } from "./scriptShellOption";
-export type ScriptExecutor = {
-  argv: string[];
-  cleanup: () => void;
-};
-export declare const createScriptExecutor: (
-  command: string,
-  shell: ScriptShellOption,
-) => ScriptExecutor;

package/src/runScript/scriptRuntimeMetadata.d.ts

@@ -1,73 +0,0 @@
-import type { ScriptShellOption } from "./scriptShellOption";
-export interface ScriptRuntimeMetadata {
-  projectPath: string;
-  projectName: string;
-  workspacePath: string;
-  workspaceRelativePath: string;
-  workspaceName: string;
-  scriptName: string;
-}
-declare const SCRIPT_RUNTIME_METADATA_CONFIG: {
-  readonly projectPath: {
-    readonly inlineName: "<projectPath>";
-    readonly envVarName: "BW_PROJECT_PATH";
-  };
-  readonly projectName: {
-    readonly inlineName: "<projectName>";
-    readonly envVarName: "BW_PROJECT_NAME";
-  };
-  readonly workspacePath: {
-    readonly inlineName: "<workspacePath>";
-    readonly envVarName: "BW_WORKSPACE_PATH";
-  };
-  readonly workspaceRelativePath: {
-    readonly inlineName: "<workspaceRelativePath>";
-    readonly envVarName: "BW_WORKSPACE_RELATIVE_PATH";
-  };
-  readonly scriptName: {
-    readonly inlineName: "<scriptName>";
-    readonly envVarName: "BW_SCRIPT_NAME";
-  };
-  readonly workspaceName: {
-    readonly inlineName: "<workspaceName>";
-    readonly envVarName: "BW_WORKSPACE_NAME";
-  };
-};
-export type ScriptRuntimeMetadataKey =
-  keyof typeof SCRIPT_RUNTIME_METADATA_CONFIG;
-export declare const getScriptRuntimeMetadataConfig: (
-  key: ScriptRuntimeMetadataKey,
-) =>
-  | {
-      readonly inlineName: "<projectPath>";
-      readonly envVarName: "BW_PROJECT_PATH";
-    }
-  | {
-      readonly inlineName: "<projectName>";
-      readonly envVarName: "BW_PROJECT_NAME";
-    }
-  | {
-      readonly inlineName: "<workspacePath>";
-      readonly envVarName: "BW_WORKSPACE_PATH";
-    }
-  | {
-      readonly inlineName: "<workspaceRelativePath>";
-      readonly envVarName: "BW_WORKSPACE_RELATIVE_PATH";
-    }
-  | {
-      readonly inlineName: "<scriptName>";
-      readonly envVarName: "BW_SCRIPT_NAME";
-    }
-  | {
-      readonly inlineName: "<workspaceName>";
-      readonly envVarName: "BW_WORKSPACE_NAME";
-    };
-export declare const createScriptRuntimeEnvVars: (
-  metadata: ScriptRuntimeMetadata,
-) => Record<string, string>;
-export declare const interpolateScriptRuntimeMetadata: (
-  text: string,
-  metadata: ScriptRuntimeMetadata,
-  shell: ScriptShellOption,
-) => string;
-export {};

package/src/runScript/scriptShellOption.d.ts

@@ -1,8 +0,0 @@
-export declare const SCRIPT_SHELL_OPTIONS: readonly ["bun", "system"];
-export type ScriptShellOption = (typeof SCRIPT_SHELL_OPTIONS)[number];
-export declare const validateScriptShellOption: (
-  shell: string,
-  fromEnvVar?: boolean,
-) => ScriptShellOption;
-export declare const getScriptShellDefault: () => "bun" | "system";
-export declare const resolveScriptShell: (shell?: string) => ScriptShellOption;

package/src/runScript/subprocesses.d.ts

@@ -1,11 +0,0 @@
-/**Essentially a wrapper around `Bun.spawn` that ensures all
- * the subprocess is killed when the main process exits for any
- * handle-able exit code or signal. */
-export declare const createSubprocess: <
-  In extends Bun.SpawnOptions.Writable,
-  Out extends Bun.SpawnOptions.Readable,
-  Err extends Bun.SpawnOptions.Readable,
->(
-  argv: string[],
-  options: Bun.Spawn.SpawnOptions<In, Out, Err>,
-) => Bun.Subprocess<In, Out, Err>;

package/src/workspaces/dependencyGraph/cycles.d.ts

@@ -1,9 +0,0 @@
-import type { Workspace } from "../workspace";
-export type DependencyCycleEdge = {
-  dependency: string;
-  dependent: string;
-};
-export declare const preventDependencyCycles: (workspaces: Workspace[]) => {
-  workspaces: Workspace[];
-  cycles: DependencyCycleEdge[];
-};

package/src/workspaces/dependencyGraph/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./cycles";
-export * from "./resolveDependencies";
-export * from "./validateDependencyRules";

package/src/workspaces/dependencyGraph/resolveDependencies.d.ts

@@ -1,18 +0,0 @@
-import type { ResolvedWorkspaceConfig } from "../../config";
-import {
-  type BunCatalogSet,
-  type ResolvedPackageJsonContent,
-} from "../packageJson";
-import type { Workspace } from "../workspace";
-export type WorkspaceMap = {
-  [workspaceName: string]: {
-    workspace: Workspace;
-    config: ResolvedWorkspaceConfig;
-    packageJson: ResolvedPackageJsonContent;
-  };
-};
-export declare const resolveWorkspaceDependencies: (
-  workspaceMap: WorkspaceMap,
-  includeRootWorkspace: boolean,
-  catalogs?: BunCatalogSet,
-) => Workspace[];

package/src/workspaces/dependencyGraph/validateDependencyRules.d.ts

@@ -1,7 +0,0 @@
-import type { WorkspaceMap } from "./resolveDependencies";
-export type ValidateWorkspaceDependencyRulesOptions = {
-  workspaceMap: WorkspaceMap;
-};
-export declare const validateWorkspaceDependencyRules: ({
-  workspaceMap,
-}: ValidateWorkspaceDependencyRulesOptions) => void;

package/src/workspaces/errors.d.ts

@@ -1,14 +0,0 @@
-export declare const WORKSPACE_ERRORS: import("../internal/core").DefinedErrors<
-  | "PackageNotFound"
-  | "InvalidPackageJson"
-  | "DuplicateWorkspaceName"
-  | "InvalidWorkspaceName"
-  | "NoWorkspaceName"
-  | "InvalidScripts"
-  | "InvalidWorkspaces"
-  | "InvalidWorkspacePattern"
-  | "AliasConflict"
-  | "AliasedWorkspaceNotFound"
-  | "RootWorkspaceNotFound"
-  | "DependencyRuleViolation"
->;

package/src/workspaces/findWorkspaces.d.ts

@@ -1,24 +0,0 @@
-import { type WorkspaceMap } from "./dependencyGraph";
-import type { Workspace } from "./workspace";
-export interface FindWorkspacesOptions {
-  rootDirectory: string;
-  /** If provided, will override the workspaces found in the package.json. Mainly for testing purposes */
-  workspaceGlobs?: string[];
-  /** Whether to include the root workspace as a normal workspace.*/
-  includeRootWorkspace?: boolean;
-}
-export declare const sortWorkspaces: (workspaces: Workspace[]) => Workspace[];
-export declare const findWorkspaces: ({
-  rootDirectory,
-  workspaceGlobs: _workspaceGlobs,
-  includeRootWorkspace,
-}: FindWorkspacesOptions) => {
-  workspaces: Workspace[];
-  workspaceMap: WorkspaceMap;
-  rootWorkspace: Workspace;
-};
-export declare const validateWorkspaceAliases: (
-  workspaces: Workspace[],
-  workspaceAliases: Record<string, string>,
-  rootWorkspaceName: string,
-) => void;

package/src/workspaces/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./findWorkspaces";
-export * from "./packageJson";
-export * from "./errors";
-export type * from "./workspace";

package/src/workspaces/packageJson.d.ts

@@ -1,31 +0,0 @@
-export declare const resolvePackageJsonPath: (directoryItem: string) => string;
-export type BunCatalog = Record<string, string>;
-export type BunCatalogSet = {
-  defaultCatalog: BunCatalog;
-  namedCatalogs: Record<string, BunCatalog>;
-};
-export type ResolvedPackageJsonContent = {
-  name: string;
-  workspaces: string[];
-  catalog: BunCatalog;
-  catalogs: Record<string, BunCatalog>;
-  scripts: Record<string, string>;
-  dependencies: Record<string, string>;
-  devDependencies: Record<string, string>;
-  peerDependencies: Record<string, string>;
-  optionalDependencies: Record<string, string>;
-} & Record<string, unknown>;
-/**
- * Resolve a `catalog:` or `catalog:name` version reference for a given package name.
- * Returns the resolved version string, or null if the catalog or package is not found.
- */
-export declare const resolveCatalogDependencyVersion: (
-  packageName: string,
-  catalogRef: string,
-  catalogs: BunCatalogSet,
-) => string | null;
-export declare const resolvePackageJsonContent: (
-  packageJsonPath: string,
-  rootDirectory: string,
-  validations: ("workspaces" | "name" | "scripts")[],
-) => ResolvedPackageJsonContent;

package/src/workspaces/workspace.d.ts

@@ -1,21 +0,0 @@
-/** Metadata about a nested package within a Bun monorepo */
-export type Workspace = {
-  /** The name of the workspace from its `package.json` */
-  name: string;
-  /** Whether the workspace is the root workspace */
-  isRoot: boolean;
-  /** The relative path to the workspace from the root `package.json` */
-  path: string;
-  /** The pattern from `"workspaces"` in the root `package.json`that this workspace was matched from*/
-  matchPattern: string;
-  /** The scripts available in package.json */
-  scripts: string[];
-  /** Aliases assigned via the `"alias"` field in the workspace's config */
-  aliases: string[];
-  /** Tags assigned via the `"tags"` field in the workspace's config */
-  tags: string[];
-  /** Names of workspaces that this workspace depends on */
-  dependencies: string[];
-  /** Names of workspaces that depend on this workspace */
-  dependents: string[];
-};

package/src/workspaces/workspacePattern.d.ts

@@ -1,22 +0,0 @@
-import type { Workspace } from "./workspace";
-declare const TARGETS: readonly ["path", "alias", "name", "tag"];
-export declare const WORKSPACE_PATTERN_ERRORS: import("../internal/core").DefinedErrors<"InvalidWorkspacePattern">;
-export type WorkspacePatternTarget = (typeof TARGETS)[number];
-export type WorkspacePattern = {
-  target: WorkspacePatternTarget | "default";
-  value: string;
-  isNegated: boolean;
-};
-export declare const WORKSPACE_PATTERN_NEGATION_PREFIX = "not:";
-export declare const WORKSPACE_PATTERN_SEPARATOR = ":";
-export declare const parseWorkspacePattern: (
-  pattern: string,
-) => WorkspacePattern;
-export declare const stringifyWorkspacePattern: (
-  pattern: WorkspacePattern,
-) => string;
-export declare const matchWorkspacesByPatterns: (
-  patterns: string[],
-  workspaces: Workspace[],
-) => Workspace[];
-export {};