bun-workspaces 1.5.0 → 1.5.2

package/src/internal/docs/apiQuickstart.mjs

@@ -1,132 +0,0 @@
-// CONCATENATED MODULE: ./src/internal/docs/apiQuickstart.ts
-const RUN_WORKSPACE_SCRIPT_EXAMPLE = `
-const { output, exit } = project.runWorkspaceScript({
-  workspaceNameOrAlias: "my-workspace",
-  script: "my-script",
-
-  // Optional. Arguments to add to the command
-  // Can be a string or an array of strings
-  // If string, the argv will be parsed POSIX-style
-  args: ["--my", "--appended", "--args"],
-
-  // Optional. Whether to ignore all output from the script.
-  // This saves memory when you don't need script output.
-  ignoreOutput: false,
-});
-
-// Get a stream of the script subprocess's output
-for await (const { chunk, metadata } of output.text()) {
-  // console.log(chunk); // The output chunk's content (string)
-  // console.log(metadata.streamName); // The output stream, "stdout" or "stderr"
-  // console.log(metadata.workspace); // The target Workspace
-}
-
-// Get data about the script execution after it exits
-const exitResult = await exit;
-
-// exitResult.exitCode // The exit code (number)
-// exitResult.signal // The exit signal (string), or null
-// exitResult.success // true if exit code was 0
-// exitResult.startTimeISO // Start time (string)
-// exitResult.endTimeISO // End time (string)
-// exitResult.durationMs // Duration in milliseconds (number)
-// exitResult.metadata.workspace // The target workspace (Workspace)
-
-`.trim();
-const RUN_SCRIPT_ACROSS_WORKSPACES_EXAMPLE = `
-
-const { output, summary } = project.runScriptAcrossWorkspaces({
-  // Optional. This will run in all matching workspaces that have my-script
-  // Accepts same values as the CLI run-script command's workspace patterns
-  // When not provided, all workspaces that have the script will be used.
-  workspacePatterns: ["my-workspace", "my-name-pattern-*"],
-
-  // Required. The package.json "scripts" field name to run
-  script: "my-script",
-
-  // Optional. Arguments to add to the command (same as for runWorkspaceScript)
-  args: ["--my", "--appended", "--args"],
-
-  // Optional. Whether to run the scripts in parallel (default: true)
-  parallel: true,
-
-  // Optional. When true, a workspace's script will wait
-  // until any workspaces it depends on have completed
-  dependencyOrder: false,
-
-  // Optional. When true and dependencyOrder is true,
-  // continue running scripts even if a dependency fails
-  ignoreDependencyFailure: false,
-
-  // Optional. Whether to ignore all output from the scripts.
-  // This saves memory when you don't need script output.
-  ignoreOutput: false,
-
-  // Optional, callback when script starts, skips, or exits
-  onScriptEvent: (event, { workspace, exitResult }) => {
-    // event: "start", "skip", "exit"
-  }
-});
-
-// Get a stream of script output
-for await (const { chunk, metadata } of output.text()) {
-  // console.log(chunk); // the output chunk's content (string)
-  // console.log(metadata.streamName); // "stdout" or "stderr"
-  // console.log(metadata.workspace); // the Workspace that the output came from
-}
-
-// Get final summary data and script exit details after all scripts have completed
-const summaryResult = await summary;
-
-// summaryResult.totalCount // Total number of scripts
-// summaryResult.allSuccess // true if all scripts succeeded
-// summaryResult.successCount // Number of scripts that succeeded
-// summaryResult.failureCount // Number of scripts that failed
-// summaryResult.startTimeISO // Start time (string)
-// summaryResult.endTimeISO // End time (string)
-// summaryResult.durationMs // Total duration in milliseconds (number)
-
-// The exit details of each workspace script
-for (const exitResult of summaryResult.scriptResults) {
-  // exitResult.exitCode // The exit code (number)
-  // exitResult.signal // The exit signal (string), or null
-  // exitResult.success // true if exit code was 0
-  // exitResult.startTimeISO // Start time (ISO string)
-  // exitResult.endTimeISO // End time (ISO string)
-  // exitResult.durationMs // Duration in milliseconds (number)
-  // exitResult.metadata.workspace // The target workspace (Workspace)
-}
-`.trim();
-const API_QUICKSTART = `
-import { createFileSystemProject } from "bun-workspaces";
-
-// A Project contains the core functionality of bun-workspaces.
-// Below defaults to process.cwd() for the project root directory
-// Pass { rootDirectory: "path/to/your/project" } to use a different root directory
-const project = createFileSystemProject();
-
-// A Workspace that matches the name or alias "my-workspace"
-const myWorkspace = project.findWorkspaceByNameOrAlias("my-workspace");
-
-// Array of workspaces whose names match the wildcard pattern
-const wildcardWorkspaces = project.findWorkspacesByPattern("my-workspace-*");
-
-// Array of workspaces that have "my-script" in their package.json "scripts"
-const workspacesWithScript = project.listWorkspacesWithScript("my-script");
-
-// Run a script in a workspace
-const runSingleScript = async () => {
-  ${RUN_WORKSPACE_SCRIPT_EXAMPLE.split("\n").join("\n  ")}
-}
-
-// Run a script in all workspaces that have it in their package.json "scripts" field
-const runManyScripts = async () => {
-  ${RUN_SCRIPT_ACROSS_WORKSPACES_EXAMPLE.split("\n").join("\n  ")}
-}
-`.trim();
-
-export {
-  API_QUICKSTART,
-  RUN_SCRIPT_ACROSS_WORKSPACES_EXAMPLE,
-  RUN_WORKSPACE_SCRIPT_EXAMPLE,
-};

package/src/internal/docs/cliQuickstart.d.ts

@@ -1,2 +0,0 @@
-export declare const CLI_QUICKSTART: string;
-export declare const INLINE_SCRIPT_EXAMPLE: string;

package/src/internal/docs/cliQuickstart.mjs

@@ -1,86 +0,0 @@
-// CONCATENATED MODULE: ./src/internal/docs/cliQuickstart.ts
-const CLI_QUICKSTART = `
-# You can add this to .bashrc, .zshrc, or similar.
-# You can also invoke "bw" in your root package.json scripts.
-alias bw="bunx bun-workspaces"
-
-# List all workspaces in your project
-bw list-workspaces
-
-# ls is an alias for list-workspaces
-bw ls --json --pretty # Output as formatted JSON
-
-# Get info about a workspace
-bw workspace-info my-workspace
-bw info my-workspace --json --pretty # info is alias for workspace-info
-
-# Get info about a script, such as the workspaces that have it
-bw script-info my-script
-
-# Run the lint script for all workspaces
-# that have it in their package.json "scripts" field
-bw run-script lint
-
-# run is an alias for run-script
-bw run lint my-workspace # Run for a single workspace
-bw run lint my-workspace-a my-workspace-b # Run for multiple workspaces
-bw run lint my-alias-a my-alias-b # Run by alias (set by optional config)
-
-# A workspace's script will wait until any workspaces it depends on have completed
-# Similar to Bun's --filter behavior
-bw run lint --dep-order
-
-# Continue running scripts even if a dependency fails
-bw run lint --dep-order --ignore-dep-failure
-
-bw run lint "my-workspace-*" # Run for matching workspace names
-bw run lint "alias:my-alias-*" "path:my-glob/**/*" "tag:my-tag" # Use matching specifiers
-bw run lint "*" "not:path:my-path/*" # Run for all workspaces not in my-path/
-
-bw run lint --args="--my-appended-args" # Add args to each script call
-bw run lint --args="--my-arg=<workspaceName>" # Use the workspace name in args
-
-bw run "bun build" --inline # Run an inline command via the Bun shell
-
-# Scripts run in parallel by default
-bw run lint --parallel=false # Run in series
-bw run lint --parallel=2 # Run in parallel with a max of 2 concurrent scripts
-bw run lint --parallel=auto # Default, based on number of available logical CPUs
-bw run lint --parallel=50% # Run in parallel with a max of 50% of the "auto" limit
-
-# Use the grouped output style (default when on a TTY)
-bw run my-script --output-style=grouped
-
-# Set the max preview lines for script output in grouped output style
-bw run my-script --output-style=grouped --grouped-lines=auto
-bw run my-script --output-style=grouped --grouped-lines=10
-
-# Use simple script output with workspace prefixes (default when not on a TTY)
-bw run my-script --output-style=prefixed
-
-# Use the plain output style (no workspace prefixes)
-bw run my-script --output-style=plain
-
-# Silence all output of the run command
-bw --log-level=silent run my-script --output-style=none
-
-# Show usage (you can pass --help to any command)
-bw help
-bw --help
-
-# Show version
-bw --version
-
-# Pass --cwd to any command
-bw --cwd=/path/to/your/project ls
-bw --cwd=/path/to/your/project run my-script
-
-# Pass --log-level to any command (debug, info, warn, error, or silent)
-bw --log-level=debug ls
-`.trim();
-const INLINE_SCRIPT_EXAMPLE = `
-# Run an inline command from the workspace directory
-bw run "bun run build" --inline
-`.trim();
-
-export { CLI_QUICKSTART, INLINE_SCRIPT_EXAMPLE };

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

@@ -1,2 +0,0 @@
-export * from "./cliQuickstart";
-export * from "./apiQuickstart";

package/src/internal/docs/index.mjs

@@ -1,2 +0,0 @@
-export * from "./cliQuickstart.mjs";
-export * from "./apiQuickstart.mjs"; // CONCATENATED MODULE: ./src/internal/docs/index.ts

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";