bun-workspaces 1.5.1 → 1.6.0

package/src/internal/core/json/json.d.ts

@@ -1,49 +0,0 @@
-type JSONPrimitiveMap = {
-  string: string;
-  number: number;
-  boolean: boolean;
-  null: null;
-};
-export type JSONPrimitiveName = keyof JSONPrimitiveMap;
-export type JSONPrimitiveToName<P extends JSONPrimitive> = {
-  [key in keyof JSONPrimitiveMap]: P extends JSONPrimitiveMap[key]
-    ? key
-    : never;
-}[keyof JSONPrimitiveMap];
-export type NameToJSONPrimitive<Name extends JSONPrimitiveName> =
-  JSONPrimitiveMap[Name];
-export type JSONPrimitive<N extends JSONPrimitiveName = JSONPrimitiveName> =
-  NameToJSONPrimitive<N>;
-export interface JSONObject {
-  [key: string]: JSONData;
-}
-export type JSONItem = JSONPrimitive | JSONObject;
-export type JSONArrayItem =
-  | JSONItem
-  | JSONItem[]
-  | JSONItem[][]
-  | JSONItem[][][]
-  | JSONItem[][][][]
-  | JSONItem[][][][][]
-  | JSONItem[][][][][][]
-  | JSONItem[][][][][][][]
-  | JSONItem[][][][][][][][]
-  | JSONItem[][][][][][][][][]
-  | JSONItem[][][][][][][][][][]
-  | JSONItem[][][][][][][][][][][];
-export type JSONArray<Item extends JSONArrayItem = JSONArrayItem> = Item[];
-export type JSONArrayToItem<A extends JSONArray> = A extends (infer Item)[]
-  ? Item
-  : never;
-export type JSONData = JSONPrimitive | JSONObject | JSONArray;
-export declare const isJSONPrimitive: (
-  value: unknown,
-) => value is JSONPrimitive;
-export declare const isJSONArray: <T extends JSONArray = JSONArray>(
-  value: unknown,
-) => value is T;
-export declare const isJSONObject: <T extends JSONObject = JSONObject>(
-  value: unknown,
-) => value is T;
-export declare const isJSON: (value: unknown) => value is JSONData;
-export {};

package/src/internal/core/json/jsonc.d.ts

@@ -1,9 +0,0 @@
-export declare const convertJSONCToJSON: (
-  jsonString: string,
-  {
-    whitespace,
-  }?: {
-    whitespace?: boolean | undefined;
-  },
-) => string;
-export declare const parseJSONC: (jsonString: string) => any;

package/src/internal/core/language/array/index.d.ts

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

package/src/internal/core/language/array/optionalArray.d.ts

@@ -1,15 +0,0 @@
-/**
- * A value that may be its type T or an array of T.
- */
-export type OptionalArray<
-  T = unknown,
-  IncludeReadonly extends boolean = false,
-> = IncludeReadonly extends true ? T | T[] | readonly T[] : T | T[];
-export type ResolvedOptionalArray<T extends OptionalArray> =
-  T extends (infer Item)[] ? Item[] : T[];
-export type ResolvedOptionalArrayItem<T extends OptionalArray> =
-  T extends (infer Item)[] ? Item : T;
-/** Resolve `OptionalArray<T>` to `T[]` */
-export declare const resolveOptionalArray: <T extends OptionalArray>(
-  value: T,
-) => ResolvedOptionalArray<T>;

package/src/internal/core/language/asyncIterable/asyncIterableQueue.d.ts

@@ -1,16 +0,0 @@
-import type { SimpleAsyncIterable } from "../types";
-export type AsyncQueueItem<T> =
-  | {
-      type: "value";
-      value: T;
-    }
-  | {
-      type: "done";
-    };
-export declare const createAsyncIterableQueue: <
-  T,
->() => SimpleAsyncIterable<T> & {
-  push: (value: T) => void;
-  close: () => void;
-  closed: Promise<void>;
-};

package/src/internal/core/language/asyncIterable/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./asyncIterableQueue";
-export * from "./mergeAsyncIterables";

package/src/internal/core/language/asyncIterable/mergeAsyncIterables.d.ts

@@ -1,5 +0,0 @@
-import type { SimpleAsyncIterable } from "../types";
-/** Run multiple async iterables in parallel and yield the results in the order they are completed. */
-export declare const mergeAsyncIterables: <T>(
-  iterables: SimpleAsyncIterable<T>[],
-) => SimpleAsyncIterable<T>;

package/src/internal/core/language/events/typedEventTarget.d.ts

@@ -1,50 +0,0 @@
-export type TypedEvent<
-  TypeName extends string = string,
-  ExtraProperties extends object = object,
-> = Event & {
-  type: TypeName;
-} & ExtraProperties;
-export declare const TypedEvent: {
-  prototype: TypedEvent;
-  new <TypeName extends string = string>(
-    type: TypeName,
-    options?: EventInit,
-  ): TypedEvent<TypeName>;
-};
-type ExtraProperties<E> =
-  E extends TypedEvent<string, infer ExtraProperties>
-    ? Omit<ExtraProperties, "type">
-    : undefined;
-export declare const createTypedEventFactory: <
-  E extends TypedEvent = TypedEvent,
->(
-  type: E["type"],
-) => (properties: ExtraProperties<E>, options?: EventInit) => E;
-export type EventConfig = {
-  [key: string]: TypedEvent;
-};
-type EventFromName<
-  E extends keyof Config,
-  Config extends EventConfig,
-> = Config[E];
-export interface TypedEventTarget<Config extends EventConfig = EventConfig> {
-  addEventListener<EventName extends keyof Config>(
-    event: EventName,
-    listener: (event: EventFromName<EventName, Config>) => unknown,
-  ): void;
-  removeEventListener<EventName extends keyof Config>(
-    event: EventName,
-    listener: (event: EventFromName<EventName, Config>) => unknown,
-  ): void;
-  dispatchEvent<EventName extends keyof Config>(
-    event: EventFromName<EventName, Config>,
-  ): boolean;
-}
-/**
- * An EventTarget with typing for specific events.
- */
-export declare const TypedEventTarget: {
-  prototype: TypedEventTarget;
-  new <Config extends EventConfig = EventConfig>(): TypedEventTarget<Config>;
-};
-export {};

package/src/internal/core/language/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./asyncIterable";
-export * from "./array";
-export * from "./types";
-export * from "./regex";
-export * from "./string";

package/src/internal/core/language/regex/index.d.ts

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

package/src/internal/core/language/regex/regex.d.ts

@@ -1,3 +0,0 @@
-export declare const createRawPattern: (pattern: string) => string;
-export declare const createWildcardRegex: (pattern: string) => RegExp;
-export declare const sanitizeAnsi: (text: string) => string;

package/src/internal/core/language/string/id.d.ts

@@ -1 +0,0 @@
-export declare const createShortId: (bytes?: number) => string;

package/src/internal/core/language/string/index.d.ts

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

package/src/internal/core/language/string/utf/eastAsianWidth.d.ts

@@ -1,16 +0,0 @@
-/** A port of the package eastasianwidth */
-export declare const eaw: {
-  /**
-   * F: Full width
-   * H: Half width
-   * W: Wide
-   * Na: Narrow
-   * A: Ambiguous
-   * N: Neutral
-   */
-  eastAsianWidth: (character: string) => "F" | "H" | "W" | "Na" | "A" | "N";
-  characterLength: (character: string) => 1 | 2;
-  stringToArray: (s: string) => [] | RegExpMatchArray;
-  length: (string: string) => number;
-  slice: (text: string, start: number, end: number) => string;
-};

package/src/internal/core/language/string/utf/visibleLength.d.ts

@@ -1,5 +0,0 @@
-export declare const calculateVisibleLength: (str: string) => number;
-export declare const truncateTerminalString: (
-  str: string,
-  maxVisible: number,
-) => string;

package/src/internal/core/language/types/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./typeof";
-export type * from "./types";

package/src/internal/core/language/types/typeof.d.ts

@@ -1,102 +0,0 @@
-import { type OptionalArray } from "../array/optionalArray";
-import { type AnyFunction } from "./types";
-export declare const InvalidJSTypeError: typeof import("../..").BunWorkspacesError;
-export declare const InvalidJSNumberError: typeof import("../..").BunWorkspacesError;
-export declare const VALIDATE_NUMBER_ERRORS: import("../..").DefinedErrors<
-  "NoNaN" | "NoNonFinite" | "NoInfinity" | "NoNegInfinity"
->;
-export declare const VALIDATE_TYPEOF_ERRORS: import("../..").DefinedErrors<
-  "NoNull" | "InvalidType"
->;
-interface JSTypeofToTypeMap {
-  string: string;
-  number: number;
-  boolean: boolean;
-  undefined: undefined;
-  bigint: bigint;
-  function: (...args: unknown[]) => unknown;
-  object: null | object;
-  symbol: symbol;
-}
-export type JSDataTypeofName = keyof JSTypeofToTypeMap;
-export type TypeToJSTypeofName<T> = {
-  [K in keyof JSTypeofToTypeMap]: T extends AnyFunction
-    ? "function"
-    : T extends JSTypeofToTypeMap[K]
-      ? K
-      : never;
-}[keyof JSTypeofToTypeMap];
-export type JSTypeofNameToType<Name extends JSDataTypeofName> =
-  JSTypeofToTypeMap[Name];
-export type TypeToJSTypeof<T> = JSTypeofNameToType<TypeToJSTypeofName<T>>;
-export declare const isTypeof: <T, D extends JSDataTypeofName>(
-  value: T,
-  ...types: D[]
-) => value is Extract<T, JSTypeofNameToType<D>>;
-export declare const isPlainObject: (value: unknown) => value is object;
-export type ValidateNumberRules = {
-  noNaN?: boolean;
-  noNonFinite?: boolean;
-  noInfinity?: boolean;
-  noNegInfinity?: boolean;
-};
-export type ValidateJSTypeOptions = {
-  value: unknown;
-  typeofName: OptionalArray<JSDataTypeofName>;
-  /** For use in error message */
-  valueLabel?: string;
-  numberRules?: ValidateNumberRules;
-  optional?: boolean;
-};
-export type ValidateJSTypesTypeEntry = Omit<
-  ValidateJSTypeOptions,
-  "valueLabel"
-> & {
-  array?: false;
-};
-export type ValidateJSTypesArrayEntry = Omit<
-  ValidateJSArrayOptions,
-  "valueLabel"
-> & {
-  array: true;
-};
-export type ValidateJSTypesConfigEntry =
-  | ValidateJSTypesTypeEntry
-  | ValidateJSTypesArrayEntry;
-export type ValidateJSTypesConfig = {
-  [valueLabel: string]: ValidateJSTypesConfigEntry;
-};
-export declare const validateNumber: (
-  value: number,
-  rules: ValidateNumberRules,
-  valueLabel?: string,
-) => InstanceType<typeof InvalidJSNumberError> | null;
-export declare const validateJSType: ({
-  value,
-  typeofName,
-  numberRules,
-  valueLabel,
-  optional,
-}: ValidateJSTypeOptions) => InstanceType<typeof InvalidJSTypeError> | null;
-export type ValidateJSArrayOptions = {
-  value: unknown;
-  /** For use in error messages */
-  valueLabel?: string;
-  optional?: boolean;
-  /** Options to validate each item in the array */
-  itemOptions?: Omit<ValidateJSTypeOptions, "value" | "valueLabel">;
-};
-export declare const validateJSArray: ({
-  value,
-  valueLabel,
-  optional,
-  itemOptions,
-}: ValidateJSArrayOptions) => InstanceType<typeof InvalidJSTypeError> | null;
-export type ValidateJSTypesOptions = {
-  throw?: boolean;
-};
-export declare const validateJSTypes: (
-  config: ValidateJSTypesConfig,
-  options?: ValidateJSTypesOptions,
-) => InstanceType<typeof InvalidJSTypeError> | null;
-export {};

package/src/internal/core/language/types/types.d.ts

@@ -1,19 +0,0 @@
-/** 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 type AnyFunction<Args extends unknown[] = any[], Return = any> = (
-  ...args: Args
-) => Return;
-export type RequiredDeep<T> = T extends object
-  ? Required<{
-      [K in keyof T]: RequiredDeep<T[K]>;
-    }>
-  : T;
-export type PartialDeep<T> = T extends object
-  ? Partial<{
-      [K in keyof T]: PartialDeep<T[K]>;
-    }>
-  : T;

package/src/internal/core/runtime/env.d.ts

@@ -1,6 +0,0 @@
-export type RuntimeMode = "development" | "production" | "test";
-export declare const RUNTIME_MODE: RuntimeMode;
-export declare const IS_INTERNAL_TEST: boolean;
-export declare const IS_TEST: boolean;
-export declare const IS_PRODUCTION: boolean;
-export declare const IS_DEVELOPMENT: boolean;

package/src/internal/core/runtime/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./env";
-export * from "./os";
-export * from "./onExit";
-export * from "./tempFile";
-export * from "./terminal";

package/src/internal/core/runtime/onExit.d.ts

@@ -1,4 +0,0 @@
-type ExitCodeOrSignal = NodeJS.Signals | number;
-type ExitHandler = (exit?: ExitCodeOrSignal) => unknown;
-export declare const runOnExit: <F extends ExitHandler>(fn: F) => void;
-export {};

package/src/internal/core/runtime/os.d.ts

@@ -1,6 +0,0 @@
-export declare const IS_WINDOWS: boolean;
-export declare const IS_MACOS: boolean;
-export declare const IS_LINUX: boolean;
-export declare const IS_POSIX: boolean;
-/** Expands a leading `~` or `~/` to the user's home directory */
-export declare const expandHomePath: (filePath: string) => string;

package/src/internal/core/runtime/tempFile.d.ts

@@ -1,20 +0,0 @@
-import fs from "fs";
-export type CreateTempFileOptions = {
-  name: string;
-  content: string;
-  mode?: fs.Mode;
-};
-declare class TempDir {
-  readonly id: string;
-  readonly dir: string;
-  constructor();
-  initialize(clean?: boolean): void;
-  createFilePath(fileName: string): string;
-  createFile({ name, content, mode }: CreateTempFileOptions): {
-    filePath: string;
-    cleanup: () => void;
-  };
-  cleanup(): void;
-}
-export declare let DEFAULT_TEMP_DIR: TempDir;
-export {};

package/src/internal/core/runtime/terminal.d.ts

@@ -1 +0,0 @@
-export declare const IS_TTY: boolean;

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

@@ -1,3 +0,0 @@
-export declare const RUN_WORKSPACE_SCRIPT_EXAMPLE: string;
-export declare const RUN_SCRIPT_ACROSS_WORKSPACES_EXAMPLE: string;
-export declare const API_QUICKSTART: string;

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