bun-workspaces 1.5.1 → 1.5.2

package/src/internal/generated/aiDocs/docs.d.ts

@@ -1,10 +0,0 @@
-export declare const DOC_OVERVIEW =
-  '## Project Overview\n\nbun-workspaces is a CLI and TypeScript API to help manage Bun monorepos. It reads `bun.lock` to find all workspaces in the project. It is referred to as "bw" for short, which is also the recommended CLI alias. The overall goal is a monorepo tool that is more lightweight than others, with still powerful comparable features, requiring no special config to get started, only a standard Bun repo using workspaces.\n\nThree main domain terms to know:\n\n- Project: generally represents a monorepo and is defined by the root `package.json` file\n- Workspace: a nested package within a project. The root package.json can count as a workspace as well, but by default, only nested packages are considered workspaces.\n- Script: an entry in the `scripts` field of a workspace\'s `package.json` file. bw can also run one-off commands known as "inline scripts," which can use the Bun shell or system shell (`sh -c` or `cmd /d /s /c` for windows).';
-export declare const DOC_CONCEPTS =
-  '## Concepts\n\n### Workspace patterns\n\nMany features accept a list of workspace patterns to match a subset of workspaces.\n\nBy default, a pattern matches the workspace name or alias: `my-workspace-name` or `my-alias-name`. Aliases are defined in config explained below.\n\nPatterns can include a wildcard to match only by workspace name: `my-workspace-*`.\n\n- Alias pattern specifier: `alias:my-alias-*`.\n- Path pattern specifier (supports glob): `path:packages/**/*`.\n- Name pattern specifier: `name:my-workspace-*`.\n- Tag pattern specifier: `tag:my-tag`.\n- Special root workspace selector: `@root`.\n- Any pattern can start with `not:` to negate the pattern. (e.g. "not:my-workspace-name", "not:tag:my-tag-\\*") This excludes workspaces that match any other present patterns from a result.\n\n### Script runtime metadata\n\nScripts ran via bw can access metadata via env vars. This same metadata can be interpolated into inline scripts and appended args.\n\n```typescript\n// in a script\nconst projectPath = process.env.BW_PROJECT_PATH;\nconst workspaceName = process.env.BW_WORKSPACE_NAME;\nconst workspacePath = process.env.BW_WORKSPACE_PATH;\nconst workspaceRelativePath = process.env.BW_WORKSPACE_RELATIVE_PATH;\nconst scriptName = process.env.BW_SCRIPT_NAME;\n```\n\n```bash\n# interpolated\nbw run "bun <projectPath>/my-script.ts" --inline \\\n  --inline-name="my-script-name" \\\n  --args="<workspaceName> <workspacePath>"\n```';
-export declare const DOC_CLI =
-  '### CLI examples:\n\n```bash\nalias bw="bunx bun-workspaces"\n\nbw list-workspaces # human-readable output\nbw ls --json --pretty # ls is alias for list-workspaces\nbw ls "name:my-workspace-*" "alias:my-alias-*" "path:packages/**/*" # accepts workspace patterns\n\n# info includes the name, aliases, path, etc.\nbw workspace-info my-workspace\nbw info my-workspace --json --pretty # info is alias for workspace-info\n\n# info includes the script name and workspaces that have it in their package.json "scripts" field\nbw script-info my-script --json --pretty\n\n# run the package.json "lint" script for all workspaces that have it\nbw run-script lint\n\n# run is alias for run-script\n# run the package.json "lint" script for workspaces using matching specifiers\nbw run lint my-workspace-name "alias:my-alias-pattern-*" "path:my-glob/**/*" # accepts workspace patterns\n\n# A workspace\'s script will wait until any workspaces it depends on have completed\n# Similar to Bun\'s --filter behavior\nbw run lint --dep-order\n\n# Continue running scripts even if a dependency fails\nbw run lint --dep-order --ignore-dep-failure\n\n# special root workspace selector (works even if root workspace is not included)\nbw run lint @root\n\n# Scripts run in parallel by default\nbw run lint --parallel=false # Run in series\n\n# Default can be overridden by config or env var BW_PARALLEL_MAX_DEFAULT\nbw run lint --parallel # default "auto", os.availableParallelism()\nbw run lint --parallel=2 # Run in parallel with a max of 2 concurrent scripts\nbw run lint --parallel=50% # 50% of os.availableParallelism()\nbw run lint --parallel=unbounded # run all in one batch\n\n# add args to the script command\nbw run lint --args="--my-arg=value"\nbw run lint --args="--my-arg=<workspaceName>" # use the workspace name in args\n\n# run the script as an inline command from the workspace directory\nbw run "bun build" --inline\nbw run "bun build" --inline --inline-name="my-script"\nbw run "bun build" --inline --shell=system # use the system shell\n\n# Use the grouped output style (default when on a TTY)\nbw run my-script --output-style=grouped\n\n# Set the max preview lines for script output in grouped output style\nbw run my-script --output-style=grouped --grouped-lines=auto\nbw run my-script --output-style=grouped --grouped-lines=10\n\n# Use simple script output with workspace prefixes (default when not on a TTY)\nbw run my-script --output-style=prefixed\n\n# Use the plain output style (no workspace prefixes)\nbw run my-script --output-style=plain\n\n### Global Options ###\n# Root directory of project:\nbw --cwd=/path/to/project ls\nbw -d /path/to/project ls\n\n# Include root workspace as a normal workspace (default false):\nbw --include-root ls\nbw -r ls\nbw --no-include-root ls # override config/env var setting\n\n# Log level (debug|info|warn|error|silent, default info)\nbw --log-level=silent ls\nbw -l silent ls\n```';
-export declare const DOC_API =
-  '### API examples:\n\nThe API is held in close parity with the CLI. It is developed first so that the CLI is a thin wrapper around the API.\n\n```typescript\nimport { createFileSystemProject } from "bun-workspaces";\n\nconst project = createFileSystemProject({\n  // the options object itself and its properties are optional\n  rootDirectory: "path/to/your/project",\n  includeRootWorkspace: false,\n});\nproject.workspaces; // array of all workspaces in the project\nproject.rootWorkspace; // the root workspace (available even when not included in the workspaces array)\nproject.findWorkspaceByName("my-workspace"); // find a workspace by name\nproject.findWorkspaceByAlias("my-alias"); // find a workspace by alias\nproject.findWorkspaceByNameOrAlias("my-workspace-or-alias"); // find a workspace by name or alias\nproject.findWorkspacesByPattern(\n  "my-workspace-name",\n  "my-workspace-alias",\n  "my-name-pattern-*",\n  "alias:my-alias-*",\n  "path:my-glob/**/*",\n); // find workspaces by pattern like the CLI\nproject.runWorkspaceScript({\n  workspaceNameOrAlias: "my-workspace",\n  script: "lint",\n  inline: true,\n  // args can be a string or an array of strings\n  // if string, the argv will be parsed POSIX-style\n  args: "--my-arg=value",\n});\nproject.runScriptAcrossWorkspaces({\n  script: "lint",\n  workspacePatterns: [\n    "alias:my-alias-pattern-*",\n    "path:my-glob/**/*",\n    "workspace-name-a",\n    "workspace-alias-b",\n  ],\n  parallel: true, // also could be { max: 2 }, max taking same options as seen in CLI examples above (e.g. "50%", "auto", etc.)\n  dependencyOrder: true,\n  ignoreDependencyFailure: true,\n  // same as for runWorkspaceScript\n  args: ["--my", "--appended", "--args"],\n  // Optional, callback when script starts, skips, or exits\n  onScriptEvent: (event, { workspace, exitResult }) => {\n    // event: "start", "skip", "exit"\n  },\n});\n```\n\n## The Workspace object\n\n```jsonc\n{\n  // The name of the workspace from its package.json\n  "name": "my-workspace",\n  // Whether the workspace is the root workspace\n  "isRoot": false,\n  // The relative path to the workspace from the project root\n  "path": "my/workspace/path",\n  // The glob pattern from the root package.json "workspaces" field\n  // that this workspace was matched from\n  "matchPattern": "my/workspace/pattern/*",\n  // The scripts available in the workspace\'s package.json\n  "scripts": ["my-script"],\n  // Aliases defined in workspace configuration (bw.workspace.jsonc/bw.workspace.json)\n  "aliases": ["my-alias"],\n  // Names of other workspaces that this workspace depends on\n  "dependencies": ["my-dependency"],\n  // Names of other workspaces that depend on this workspace\n  "dependents": ["my-dependent"],\n}\n```';
-export declare const DOC_CONFIG =
-  '## Root config\n\nOptional project config can be placed in `bw.root.jsonc`/`bw.root.json` in the root directory.\n\nConfig defaults here take precedence over environment variables that can set defaults.\nExplicit arguments to the CLI or API take precedence over all other settings.\n\n```jsonc\n{\n  "defaults": {\n    "parallelMax": 5, // same options as seen in CLI examples above\n    "shell": "system", // "bun" or "system" (default "bun")\n    "includeRootWorkspace": true, // treat root package.json as a normal workspace\n  },\n}\n```\n\n## Workspace config\n\nOptional config can be placed in `bw.workspace.jsonc`/`bw.workspace.json` in a workspace directory.\n\nAliases must be unique to each workspace and to not clash with other workspaces\' `package.json` names.\n\nTags are strings to group workspaces together that therefore don\'t need to be unique to each workspace.\n\n```jsonc\n{\n  "alias": "my-alias", // can be array\n  "tags": ["my-tag"],\n  "scripts": {\n    "lint": {\n      // set optional sorting order for scripts\n      "order": 1,\n    },\n  },\n  "rules": {\n    "workspaceDependencies": {\n      // use workspace patterns to allow or deny other workspaces as dependencies\n      "allowPatterns": ["my-allow-pattern-*"],\n      // or\n      // "denyPatterns": ["my-deny-pattern-*"],\n    },\n  },\n}\n```\n\n### Workspace Dependency Rules\n\nUsing the `rules.workspaceDependencies` field, you can define rules for which workspaces are allowed to be dependencies,\nusing either `allowPatterns` or `denyPatterns`.\n\nWorkspace Patterns are used to match workspaces.\n\nYou can\'t use both `allowPatterns` and `denyPatterns` at the same time, but you can use\n\n## TypeScript/JSON Config Files\n\nYou can use TypeScript/JSON config files to define your workspace configuration.\n\n### TypeScript\n\n`bw.workspace.ts`\n\n```ts\nimport { defineWorkspaceConfig } from "bun-workspaces/config";\n\nexport default defineWorkspaceConfig({\n  alias: "my-alias",\n  tags: ["my-tag"],\n});\n```\n\n`bw.root.ts`\n\n```ts\nimport { defineRootConfig } from "bun-workspaces/config";\n\nexport default defineRootConfig({\n  defaults: {\n    parallelMax: 5,\n  },\n});\n```';

package/src/internal/logger/index.d.ts

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

package/src/internal/logger/logger.d.ts

@@ -1,45 +0,0 @@
-export declare const LOG_LEVELS: readonly ["debug", "info", "warn", "error"];
-export type LogLevel = (typeof LOG_LEVELS)[number];
-export type LogLevelSetting = LogLevel | "silent";
-export declare const LOGGER_ERRORS: import("../core").DefinedErrors<"InvalidLogLevel">;
-export declare const validateLogLevel: (level: LogLevelSetting) => void;
-export type LogMetadata = Record<string, unknown>;
-export interface Log<
-  Message extends string | Error = string,
-  Metadata extends LogMetadata = LogMetadata,
-> {
-  message: Message;
-  level: LogLevel;
-  metadata: Metadata;
-  time: Date;
-}
-export type Logger = {
-  name: string;
-  log<
-    Message extends string | Error = string,
-    Metadata extends LogMetadata = LogMetadata,
-  >(
-    message: Message,
-    level: LogLevel,
-    metadata?: Metadata,
-  ): Log<Message, Metadata>;
-  printLevel: LogLevelSetting;
-  setPrintStdout: (
-    stdout: (...args: Parameters<typeof process.stdout.write>) => void,
-  ) => void;
-  setPrintStderr: (
-    stderr: (...args: Parameters<typeof process.stderr.write>) => void,
-  ) => void;
-} & {
-  [Level in LogLevel]: <
-    Message extends string | Error = string,
-    Metadata extends LogMetadata = LogMetadata,
-  >(
-    message: Message,
-    metadata?: Metadata,
-  ) => Log<Message, Metadata>;
-};
-export declare const createLogger: (name: string) => Logger;
-export declare const logger: Logger;
-/** Set the global logging level. Defaults to "info" or "error" when `NODE_ENV` is "test" */
-export declare const setLogLevel: (level: LogLevelSetting) => void;

package/src/internal/version.d.ts

@@ -1 +0,0 @@
-export declare const BUN_WORKSPACES_VERSION: string;

package/src/project/errors.d.ts

@@ -1,5 +0,0 @@
-export declare const PROJECT_ERRORS: import("../internal/core").DefinedErrors<
-  | "ProjectWorkspaceNotFound"
-  | "WorkspaceScriptDoesNotExist"
-  | "RecursiveWorkspaceScript"
->;

package/src/project/implementations/fileSystemProject.d.ts

@@ -1,148 +0,0 @@
-import type { Simplify } from "../../internal/core";
-import {
-  type RunScriptsParallelOptions,
-  type RunScriptsSummary,
-  type RunScriptExit,
-  type OutputStreamName,
-  type ScriptEventName,
-} from "../../runScript";
-import type { MultiProcessOutput } from "../../runScript/output/multiProcessOutput";
-import { type ScriptShellOption } from "../../runScript/scriptShellOption";
-import { type Workspace } from "../../workspaces";
-import type { Project, ProjectConfig } from "../project";
-import { ProjectBase } from "./projectBase";
-/** 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 ShellOption = ScriptShellOption | "default";
-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;
-export {};

package/src/project/implementations/memoryProject.d.ts

@@ -1,41 +0,0 @@
-import type { Simplify } from "../../internal/core";
-import { type Workspace } from "../../workspaces";
-import type { Project } from "../project";
-import { ProjectBase } from "./projectBase";
-/** 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: import("../..").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 {};

package/src/project/implementations/projectBase.d.ts

@@ -1,37 +0,0 @@
-import { type Workspace } from "../../workspaces";
-import type {
-  CreateProjectScriptCommandOptions,
-  CreateProjectScriptCommandResult,
-  Project,
-  ProjectConfig,
-  WorkspaceScriptMetadata,
-} from "../project";
-export declare const resolveWorkspacePath: (
-  project: Project,
-  workspace: Workspace,
-) => string;
-export declare const ROOT_WORKSPACE_SELECTOR = "@root";
-export declare const resolveRootWorkspaceSelector: (
-  workspacePattern: string,
-  project: Project,
-) => Workspace | null;
-export 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;
-}

package/src/project/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./errors";
-export type * from "./project";
-export * from "./implementations/projectBase";
-export * from "./implementations/fileSystemProject";
-export * from "./implementations/memoryProject";

package/src/project/project.d.ts

@@ -1,79 +0,0 @@
-import type { ResolvedRootConfig, ResolvedWorkspaceConfig } from "../config";
-import type { ScriptCommand, WorkspaceScriptCommandMethod } from "../runScript";
-import type { Workspace } from "../workspaces";
-/** 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;
-}

package/src/runScript/index.d.ts

@@ -1,7 +0,0 @@
-export * from "./runScript";
-export * from "./runScripts";
-export * from "./scriptCommand";
-export * from "./output";
-export * from "./parallel";
-export * from "./scriptRuntimeMetadata";
-export * from "./scriptShellOption";

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

@@ -1,3 +0,0 @@
-export type * from "./outputStream";
-export * from "./multiProcessOutput";
-export * from "./processOutput";

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;