bun-workspaces 1.5.1 → 1.5.2

package/src/index.d.ts

@@ -1,38 +1,458 @@
-export {
-  createFileSystemProject,
-  createMemoryProject,
-  type Project,
-  type FileSystemProject,
-  type MemoryProject,
-  type CreateFileSystemProjectOptions,
-  type CreateMemoryProjectOptions,
-  type CreateProjectScriptCommandOptions,
-  type CreateProjectScriptCommandResult,
-  type WorkspaceScriptMetadata,
-  type RunWorkspaceScriptMetadata,
-  type RunWorkspaceScriptOptions,
-  type RunWorkspaceScriptExit,
-  type RunWorkspaceScriptResult,
-  type InlineScriptOptions,
-  type RunScriptAcrossWorkspacesOptions,
-  type RunScriptAcrossWorkspacesOutput,
-  type RunScriptAcrossWorkspacesSummary,
-  type RunScriptAcrossWorkspacesOutput as RunScriptAcrossWorkspacesProcessOutput,
-  type RunScriptAcrossWorkspacesResult,
-  type ParallelOption,
-  type ShellOption,
-  type ScriptEventMetadata,
-  type OnScriptEventCallback,
-} from "./project";
-export * from "./config/public";
-export {
-  type ScriptEventName,
-  type OutputStreamName,
-  type PercentageValue,
-  type ParallelMaxValue,
-  type WorkspaceScriptCommandMethod,
-  type RunScriptsParallelOptions,
-} from "./runScript";
-export { type Workspace } from "./workspaces";
-export { type SimpleAsyncIterable, BunWorkspacesError } from "./internal/core";
-export { setLogLevel, type LogLevelSetting } from "./internal/logger";
+// Generated by dts-bundle-generator v9.5.1
+
+/** Does not change an object type, but remaps it for cleaner Intellisense only */
+export type Simplify<T extends object> = {
+  [K in keyof T]: T[K];
+};
+/** A normal `AsyncIterable` that is only intended for `for await` style iteration */
+export type SimpleAsyncIterable<T> = AsyncIterable<T, void, undefined>;
+export declare class BunWorkspacesError extends Error {
+  name: string;
+}
+declare const SCRIPT_SHELL_OPTIONS: readonly ["bun", "system"];
+export type ScriptShellOption = (typeof SCRIPT_SHELL_OPTIONS)[number];
+export type ShellOption = ScriptShellOption | "default";
+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;
+export type WorkspaceDependenciesRule = {
+  allowPatterns?: string[];
+  denyPatterns?: string[];
+};
+export type WorkspaceRules = {
+  workspaceDependencies?: WorkspaceDependenciesRule;
+};
+/** Configuration that applies to a specific package.json script */
+export type ScriptConfig = {
+  /**
+   * The order in which the script should be executed.
+   *
+   * 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 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 type OutputStreamName = "stdout" | "stderr";
+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 MultiProcessOutput<Metadata extends object = object> {
+  bytes(): BytesOutput<Metadata>;
+  text(): TextOutput<Metadata>;
+}
+/** 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[];
+};
+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 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 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 RunScriptsParallelOptions = {
+  max: ParallelMaxValue;
+};
+/** Metadata about a {@link Project}'s script, including the workspaces that have it in their package.json */
+export type WorkspaceScriptMetadata = {
+  name: string;
+  workspaces: Workspace[];
+};
+/** Arguments for {@link Project.createScriptCommand} */
+export type CreateProjectScriptCommandOptions = {
+  /** The workspace to run the script in */
+  workspaceNameOrAlias: string;
+  /** The name of the script to run */
+  scriptName: string;
+  /**
+   * 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 arguments to append to the command */
+  args?: string;
+};
+/** Result of {@link Project.createScriptCommand}. Includes a command string that will run a workspace's script. */
+export type CreateProjectScriptCommandResult = {
+  /** Data including a command string using the `bun`
+   * CLI that will run a workspace's script and the
+   * directory to run it in. */
+  commandDetails: ScriptCommand;
+  /** The name of the script to run */
+  scriptName: string;
+  /** The workspace that the script belongs to */
+  workspace: Workspace;
+};
+/** The config for a project and its workspaces */
+export type ProjectConfig = {
+  root: ResolvedRootConfig;
+  /** A map of workspace names to their resolved config */
+  workspaces: Record<string, ResolvedWorkspaceConfig>;
+};
+/**
+ * A project contains a collection of workspaces and is the core of `bun-workspaces`'s functionality.
+ *
+ * Typically based on a root package.json file's `"workspaces"` field and any matching nested package.json files that are found.
+ */
+export interface Project {
+  /** The name of the project. This is typically the name of the root package.json unless otherwise provided. */
+  name: string;
+  /** The root directory of the project */
+  rootDirectory: string;
+  /** The root workspace of the project */
+  rootWorkspace: Workspace;
+  /** The list of all workspaces in the project */
+  workspaces: Workspace[];
+  /** The config for the project and its workspaces */
+  config: ProjectConfig;
+  /** The means by which the project was created */
+  sourceType: "fileSystem" | "memory";
+  /** Find a workspace by its package.json name */
+  findWorkspaceByName(workspaceName: string): Workspace | null;
+  /** Find a workspace by a workspace alias */
+  findWorkspaceByAlias(alias: string): Workspace | null;
+  /** Find a workspace that matches a workspace's name or an alias if no name matches. */
+  findWorkspaceByNameOrAlias(nameOrAlias: string): Workspace | null;
+  /** Find a list of workspaces that have a given tag in their configuration */
+  listWorkspacesWithTag(tag: string): Workspace[];
+  /** Accepts a wildcard pattern for finding a list of workspaces by their name*/
+  findWorkspacesByPattern(workspacePattern: string): Workspace[];
+  /** Get an array of all workspaces that have a given script in their package.json */
+  listWorkspacesWithScript(scriptName: string): Workspace[];
+  /** Get a mapping of all scripts to the workspaces that have them in their package.json */
+  mapScriptsToWorkspaces(): Record<string, WorkspaceScriptMetadata>;
+  /** Get a mapping of all tags to the workspaces that have them in their config */
+  mapTagsToWorkspaces(): Record<string, Workspace[]>;
+  /** Create metadata that can be used to run a workspace's script */
+  createScriptCommand(
+    options: CreateProjectScriptCommandOptions,
+  ): CreateProjectScriptCommandResult;
+}
+declare abstract class ProjectBase implements Project {
+  abstract readonly name: string;
+  abstract readonly rootDirectory: string;
+  abstract readonly rootWorkspace: Workspace;
+  abstract readonly workspaces: Workspace[];
+  abstract readonly sourceType: "fileSystem" | "memory";
+  abstract readonly config: ProjectConfig;
+  constructor(_ignoreBunVersion?: boolean);
+  listWorkspacesWithScript(scriptName: string): Workspace[];
+  mapScriptsToWorkspaces(): Record<string, WorkspaceScriptMetadata>;
+  mapTagsToWorkspaces(): Record<string, Workspace[]>;
+  findWorkspaceByName(workspaceName: string): Workspace | null;
+  findWorkspaceByAlias(alias: string): Workspace | null;
+  findWorkspaceByNameOrAlias(nameOrAlias: string): Workspace | null;
+  listWorkspacesWithTag(tag: string): Workspace[];
+  findWorkspacesByPattern(...workspacePatterns: string[]): Workspace[];
+  createScriptCommand(
+    options: CreateProjectScriptCommandOptions,
+  ): CreateProjectScriptCommandResult;
+}
+/** Arguments for {@link createFileSystemProject} */
+export type CreateFileSystemProjectOptions = {
+  /** The directory containing the root package.json. Often the same root as a git repository. Relative to process.cwd(). The default is process.cwd(). */
+  rootDirectory?: string;
+  /**
+   * The name of the project.
+   *
+   * By default will use the root package.json name
+   */
+  name?: string;
+  /** Whether to include the root workspace as a normal workspace. This overrides any config or env var settings. */
+  includeRootWorkspace?: boolean;
+};
+export type InlineScriptOptions = {
+  /** A name to act as a label for the inline script */
+  scriptName?: string;
+  /** Whether to run the script as an inline command */
+  shell?: ShellOption;
+};
+/** Arguments for `FileSystemProject.runWorkspaceScript` */
+export type RunWorkspaceScriptOptions = {
+  /** The name of the workspace to run the script in */
+  workspaceNameOrAlias: string;
+  /** The name of the script to run, or an inline command when `inline` is true */
+  script: string;
+  /** Whether to run the script as an inline command */
+  inline?: boolean | InlineScriptOptions;
+  /** The arguments to append to the script command. If passed as a string, the argv will be parsed POSIX-style */
+  args?: string | string[];
+  /** Set to `true` to ignore all output from the script. This saves memory when you don't need script output. */
+  ignoreOutput?: boolean;
+};
+/** Metadata associated with a workspace script */
+export type RunWorkspaceScriptMetadata = {
+  /** The workspace that the script was run in */
+  workspace: Workspace;
+};
+export type RunWorkspaceScriptExit = Simplify<
+  RunScriptExit<RunWorkspaceScriptMetadata>
+>;
+export type RunWorkspaceScriptProcessOutput = MultiProcessOutput<
+  RunWorkspaceScriptMetadata & {
+    streamName: OutputStreamName;
+  }
+>;
+/** Result of `FileSystemProject.runWorkspaceScript` */
+export type RunWorkspaceScriptResult = {
+  /** Use to get the output of the script */
+  output: RunWorkspaceScriptProcessOutput;
+  /** The exit result of the script */
+  exit: Promise<RunWorkspaceScriptExit>;
+};
+export type ParallelOption = boolean | RunScriptsParallelOptions;
+export type ScriptEventMetadata = {
+  /** The workspace that the script event occurred in */
+  workspace: Workspace;
+  /** The exit result of the script */
+  exitResult: RunScriptExit<RunWorkspaceScriptMetadata> | null;
+};
+export type OnScriptEventCallback = (
+  /** The event that occurred */
+  event: ScriptEventName,
+  /** The metadata for the script event */
+  metadata: ScriptEventMetadata,
+) => unknown;
+/** Arguments for `FileSystemProject.runScriptAcrossWorkspaces` */
+export type RunScriptAcrossWorkspacesOptions = {
+  /**
+   * Workspace names, aliases, or patterns including a wildcard.
+   *
+   * When not provided, all workspaces that the script can be ran in will be used.
+   */
+  workspacePatterns?: string[];
+  /** The name of the script to run, or an inline command when `inline` is true */
+  script: string;
+  /** Whether to run the script as an inline command */
+  inline?: boolean | InlineScriptOptions;
+  /** The arguments to append to the script command. If passed as a string, the argv will be parsed POSIX-style */
+  args?: string | string[];
+  /** Whether to run the scripts in parallel (default: `true`). Pass `false` to run in series. */
+  parallel?: ParallelOption;
+  /** When `true`, run scripts so that dependent workspaces run only after their dependencies */
+  dependencyOrder?: boolean;
+  /** When `true`, continue running scripts even if a dependency fails (Only relevant when `dependencyOrder` is `true`) */
+  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 (start, skip, exit) */
+  onScriptEvent?: OnScriptEventCallback;
+};
+export type RunScriptAcrossWorkspacesSummary = Simplify<
+  RunScriptsSummary<RunWorkspaceScriptMetadata>
+>;
+export type RunScriptAcrossWorkspacesOutput = MultiProcessOutput<
+  RunWorkspaceScriptMetadata & {
+    streamName: OutputStreamName;
+  }
+>;
+/** Result of `FileSystemProject.runScriptAcrossWorkspaces` */
+export type RunScriptAcrossWorkspacesResult = {
+  /** Use to get the output of the scripts */
+  output: RunScriptAcrossWorkspacesOutput;
+  /** The summary of the script run with exit details for each workspace */
+  summary: Promise<RunScriptAcrossWorkspacesSummary>;
+  /** The workspaces targeted */
+  workspaces: Workspace[];
+};
+declare class _FileSystemProject extends ProjectBase implements Project {
+  #private;
+  readonly rootDirectory: string;
+  readonly workspaces: Workspace[];
+  readonly name: string;
+  readonly sourceType = "fileSystem";
+  readonly config: ProjectConfig;
+  readonly rootWorkspace: Workspace;
+  constructor(options: CreateFileSystemProjectOptions);
+  runWorkspaceScript(
+    options: RunWorkspaceScriptOptions,
+  ): RunWorkspaceScriptResult;
+  runScriptAcrossWorkspaces(
+    options: RunScriptAcrossWorkspacesOptions,
+  ): RunScriptAcrossWorkspacesResult;
+}
+/** An implementation of {@link Project} that is created from a root directory in the file system. */
+export type FileSystemProject = Simplify<_FileSystemProject>;
+/**
+ * Create a {@link Project} based on a given root directory.
+ * Automatically finds workspaces based on the root package.json "workspaces" field
+ * and detects and utilizes any provided configuration.
+ */
+export declare const createFileSystemProject: (
+  options?: CreateFileSystemProjectOptions,
+) => FileSystemProject;
+/** Arguments for {@link createMemoryProject} */
+export type CreateMemoryProjectOptions = {
+  /** The list of workspaces in the project */
+  workspaces: Workspace[];
+  /** The name of the project */
+  name?: string;
+  /** The root directory of the project (not used in any actual file system interactions in a {@link MemoryProject}) */
+  rootDirectory?: string;
+  /** The root workspace */
+  rootWorkspace?: Workspace;
+  /** Whether to include the root workspace as a normal workspace. */
+  includeRootWorkspace?: boolean;
+};
+declare class _MemoryProject extends ProjectBase implements Project {
+  readonly rootDirectory: string;
+  readonly workspaces: Workspace[];
+  readonly name: string;
+  readonly sourceType = "memory";
+  readonly config: {
+    root: ResolvedRootConfig;
+    workspaces: {};
+  };
+  readonly rootWorkspace: Workspace;
+  constructor(options: CreateMemoryProjectOptions);
+}
+/**
+ * An implementation of {@link Project} that is created from a list of workspaces in memory.
+ *
+ * Mainly used for testing without needing a real file system project. */
+export type MemoryProject = Simplify<InstanceType<typeof _MemoryProject>>;
+/** Create a {@link Project} from a provided list of workspace objects.
+ *
+ * Mainly used for testing without needing a real file system project. */
+export declare const createMemoryProject: (
+  options: CreateMemoryProjectOptions,
+) => MemoryProject;
+export declare const defineRootConfig: (
+  config: RootConfig,
+) => ResolvedRootConfig;
+export declare const defineWorkspaceConfig: (
+  config: WorkspaceConfig,
+) => ResolvedWorkspaceConfig;
+declare const LOG_LEVELS: readonly ["debug", "info", "warn", "error"];
+export type LogLevel = (typeof LOG_LEVELS)[number];
+export type LogLevelSetting = LogLevel | "silent";
+/** Set the global logging level. Defaults to "info" or "error" when `NODE_ENV` is "test" */
+export declare const setLogLevel: (level: LogLevelSetting) => void;
+
+export { RunScriptAcrossWorkspacesOutput as RunScriptAcrossWorkspacesProcessOutput };
+
+export {};

package/src/index.mjs

@@ -1,17 +1,8 @@
-import {
-  createFileSystemProject,
-  createMemoryProject,
-} from "./project/index.mjs";
-import { BunWorkspacesError } from "./internal/core/index.mjs";
-import { setLogLevel } from "./internal/logger/index.mjs";
-export * from "./config/public.mjs"; // CONCATENATED MODULE: external "./project/index.mjs"
-// CONCATENATED MODULE: external "./internal/core/index.mjs"
-// CONCATENATED MODULE: external "./internal/logger/index.mjs"
-// CONCATENATED MODULE: ./src/index.ts
+export * from "./config/public.mjs";
 
 export {
-  BunWorkspacesError,
   createFileSystemProject,
   createMemoryProject,
-  setLogLevel,
-};
+} from "./project/index.mjs";
+export { BunWorkspacesError } from "./internal/core/index.mjs";
+export { setLogLevel } from "./internal/logger/index.mjs";

package/src/internal/bun/bunLock.mjs

@@ -1,9 +1,7 @@
 import fs from "fs";
 import path from "path";
-import { defineErrors, isJSONObject, parseJSONC } from "../core/index.mjs"; // CONCATENATED MODULE: external "fs"
-// CONCATENATED MODULE: external "path"
-// CONCATENATED MODULE: external "../core/index.mjs"
-// CONCATENATED MODULE: ./src/internal/bun/bunLock.ts
+import { defineErrors, parseJSONC } from "../core/index.mjs";
+import { isJSONObject } from "../../8257.mjs";
 
 const BUN_LOCK_ERRORS = defineErrors(
   "BunLockNotFound",

package/src/internal/bun/bunVersion.mjs

@@ -1,7 +1,5 @@
 import package_0 from "../../../package.json";
-import { defineErrors } from "../core/error/index.mjs"; // CONCATENATED MODULE: external "../../../package.json"
-// CONCATENATED MODULE: external "../core/error/index.mjs"
-// CONCATENATED MODULE: ./src/internal/bun/bunVersion.ts
+import { defineErrors } from "../core/error/index.mjs";
 
 const LIBRARY_CONSUMER_BUN_VERSION =
   package_0._bwInternal.bunVersion.libraryConsumer;

package/src/internal/bun/index.mjs

@@ -1,2 +1,4 @@
 export * from "./bunVersion.mjs";
-export * from "./bunLock.mjs"; // CONCATENATED MODULE: ./src/internal/bun/index.ts
+export * from "./bunLock.mjs";
+
+export {};