bun-workspaces 1.1.1 → 1.2.0

package/README.md

@@ -6,7 +6,14 @@
 
 ### [**See Full Documentation Here**: _https://bunworkspaces.com_](https://bunworkspaces.com)
 
-A CLI and API to enhance your monorepo development with Bun's [native workspaces](https://bun.sh/docs/install/workspaces) feature for nested JavaScript/TypeScript packages.
+**Big Recent Updates!**
+
+- Version 1 is here after the initial alpha! 🍔🍔👁️🍔🍔
+- You can demo the CLI [directly in the browser](https://bunworkspaces.com/web-cli)
+- There's now [an official blog](https://bunworkspaces.com/blog/bun-workspaces-v1) to cover noteworthy releases and more!
+<hr/>
+
+This is a CLI and TypeScript API to enhance your monorepo development with Bun's [native workspaces](https://bun.sh/docs/install/workspaces) feature for nested JavaScript/TypeScript packages.
 
 - Works right away, with no boilerplate required 🍔🍴
 - Get metadata about your monorepo 🤖
@@ -65,9 +72,6 @@ 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)
 
-bw run lint "my-workspace-*" # Run for matching workspace names
-bw run lint "alias:my-alias-pattern-*" "path:my-glob/**/*" # Use matching specifiers
-
 # 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
@@ -75,6 +79,9 @@ 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-pattern-*" "path:my-glob/**/*" # Use matching specifiers
+
 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
 
@@ -140,14 +147,22 @@ const runSingleScript = async () => {
   const { output, exit } = project.runWorkspaceScript({
     workspaceNameOrAlias: "my-workspace",
     script: "my-script",
-    args: "--my --appended --args", // optional, arguments to add to the command
+
+    // 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 content (string)
-    // console.log(metadata.streamName); // "stdout" or "stderr"
-    // console.log(metadata.workspace); // the workspace that the output came from
+    // 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
@@ -173,8 +188,8 @@ const runManyScripts = async () => {
     // Required. The package.json "scripts" field name to run
     script: "my-script",
 
-    // Optional. Arguments to add to the command
-    args: "--my --appended --args",
+    // 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,
@@ -187,6 +202,10 @@ const runManyScripts = async () => {
     // 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"
@@ -195,9 +214,9 @@ const runManyScripts = async () => {
 
   // Get a stream of script output
   for await (const { chunk, metadata } of output.text()) {
-    // console.log(chunk); // the content (string)
+    // 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
+    // console.log(metadata.workspace); // the Workspace that the output came from
   }
 
   // Get final summary data and script exit details after all scripts have completed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bun-workspaces",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "A monorepo management tool for Bun, with a CLI and API to enhance Bun's native workspaces.",
   "license": "MIT",
   "main": "src/index.mjs",
@@ -32,6 +32,7 @@
     }
   },
   "dependencies": {
-    "commander": "^12.1.0"
+    "commander": "^12.1.0",
+    "shell-quote": "^1.8.3"
   }
 }

package/src/cli/commands/commandsConfig.d.ts

@@ -148,7 +148,7 @@ export declare const CLI_COMMANDS_CONFIG: {
       readonly outputStyle: {
         readonly flags: ["-o", "--output-style <style>"];
         readonly description: "The output style to use";
-        readonly values: ["grouped", "prefixed", "plain"];
+        readonly values: ["grouped", "prefixed", "plain", "none"];
       };
       readonly groupedLines: {
         readonly flags: ["-L", "--grouped-lines <count>"];
@@ -309,7 +309,7 @@ export declare const getCliCommandConfig: (commandName: CliCommandName) =>
         readonly outputStyle: {
           readonly flags: ["-o", "--output-style <style>"];
           readonly description: "The output style to use";
-          readonly values: ["grouped", "prefixed", "plain"];
+          readonly values: ["grouped", "prefixed", "plain", "none"];
         };
         readonly groupedLines: {
           readonly flags: ["-L", "--grouped-lines <count>"];

package/src/cli/commands/runScript/handleRunScript.mjs

@@ -58,7 +58,7 @@ const runScript = handleProjectCommand(
       process.exit(1);
     }
     const scriptArgs = postTerminatorArgs.length
-      ? postTerminatorArgs.join(" ")
+      ? postTerminatorArgs
       : options.args;
     if (positionalWorkspacePatterns.length && options.workspacePatterns) {
       logger.error(
@@ -73,6 +73,10 @@ const runScript = handleProjectCommand(
       `Command: Run ${options.inline ? "inline " : ""}script ${JSON.stringify(script)} for ${workspacePatterns.length ? "workspaces " + workspacePatterns.join(", ") : "all workspaces"}`,
     );
     logger.debug(`Options: ${JSON.stringify(options)}`);
+    const outputStyle = options.outputStyle
+      ? validateOutputStyle(options.outputStyle)
+      : getDefaultOutputStyle();
+    logger.debug(`Effective output style: ${outputStyle}`);
     const scriptEventTarget = createScriptEventTarget();
     const { output, summary, workspaces } = project.runScriptAcrossWorkspaces({
       workspacePatterns: workspacePatterns.length
@@ -90,7 +94,7 @@ const runScript = handleProjectCommand(
       args: scriptArgs,
       dependencyOrder: options.depOrder,
       ignoreDependencyFailure: options.ignoreDepFailure,
-      ignoreOutput: logger.printLevel === "silent",
+      ignoreOutput: outputStyle === "none",
       onScriptEvent: (event, { workspace, exitResult }) => {
         setTimeout(() =>
           // place at end of call stack so listeners in render func receive event
@@ -168,11 +172,10 @@ const runScript = handleProjectCommand(
           prefix: false,
           stripDisruptiveControls,
         }),
+      none: async () => {
+        // no-op
+      },
     };
-    const outputStyle = options.outputStyle
-      ? validateOutputStyle(options.outputStyle)
-      : getDefaultOutputStyle();
-    logger.debug(`Effective output style: ${outputStyle}`);
     await outputStyleHandlers[outputStyle]();
     const exitResults = await summary;
     exitResults.scriptResults.forEach(

package/src/cli/commands/runScript/output/outputStyle.d.ts

@@ -2,6 +2,7 @@ export declare const OUTPUT_STYLE_VALUES: readonly [
   "grouped",
   "prefixed",
   "plain",
+  "none",
 ];
 export type OutputStyleName = (typeof OUTPUT_STYLE_VALUES)[number];
 export declare const getDefaultOutputStyle: () => OutputStyleName;

package/src/cli/commands/runScript/output/outputStyle.mjs

@@ -3,7 +3,7 @@ import { IS_TTY } from "../../../../internal/core/runtime/terminal.mjs"; // CONC
 // CONCATENATED MODULE: external "../../../../internal/core/runtime/terminal.mjs"
 // CONCATENATED MODULE: ./src/cli/commands/runScript/output/outputStyle.ts
 
-const OUTPUT_STYLE_VALUES = ["grouped", "prefixed", "plain"];
+const OUTPUT_STYLE_VALUES = ["grouped", "prefixed", "plain", "none"];
 const getDefaultOutputStyle = () => (IS_TTY ? "grouped" : "prefixed");
 const validateOutputStyle = (style) => {
   if (!OUTPUT_STYLE_VALUES.includes(style)) {

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

@@ -39,8 +39,8 @@ export type RunWorkspaceScriptOptions = {
   script: string;
   /** Whether to run the script as an inline command */
   inline?: boolean | InlineScriptOptions;
-  /** The arguments to append to the script command */
-  args?: string;
+  /** 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;
 };
@@ -89,8 +89,8 @@ export type RunScriptAcrossWorkspacesOptions = {
   script: string;
   /** Whether to run the script as an inline command */
   inline?: boolean | InlineScriptOptions;
-  /** The arguments to append to the script command. `<workspaceName>` will be replaced with the workspace name */
-  args?: string;
+  /** 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 */

package/src/project/implementations/fileSystemProject.mjs

@@ -1,11 +1,15 @@
 import fs from "fs";
 import path from "path";
+import { parse, quote } from "shell-quote/";
 import { loadRootConfig } from "../../config/index.mjs";
 import { getUserEnvVar } from "../../config/userEnvVars/index.mjs";
 import {
   DEFAULT_TEMP_DIR,
+  IS_WINDOWS,
+  InvalidJSTypeError,
   expandHomePath,
   isPlainObject,
+  validateJSArray,
   validateJSTypes,
 } from "../../internal/core/index.mjs";
 import { logger } from "../../internal/logger/index.mjs";
@@ -27,6 +31,7 @@ import {
   resolveWorkspacePath,
 } from "./projectBase.mjs"; // CONCATENATED MODULE: external "fs"
 // CONCATENATED MODULE: external "path"
+// CONCATENATED MODULE: external "shell-quote/"
 // CONCATENATED MODULE: external "../../config/index.mjs"
 // CONCATENATED MODULE: external "../../config/userEnvVars/index.mjs"
 // CONCATENATED MODULE: external "../../internal/core/index.mjs"
@@ -40,6 +45,41 @@ import {
 // CONCATENATED MODULE: external "./projectBase.mjs"
 // CONCATENATED MODULE: ./src/project/implementations/fileSystemProject.ts
 
+const quoteArg = (arg, shell) =>
+  IS_WINDOWS && shell === "system"
+    ? `"${arg.replace(/"/g, '""')}"`
+    : quote([arg]);
+const serializeArgs = (args, metadata, shell) => {
+  if (!args || args.length === 0) return "";
+  if (Array.isArray(args)) {
+    return args
+      .map((arg) =>
+        quoteArg(interpolateScriptRuntimeMetadata(arg, metadata, shell), shell),
+      )
+      .join(" ");
+  }
+  const interpolated = interpolateScriptRuntimeMetadata(args, metadata, shell);
+  // Escape backslashes in interpolated values before POSIX parse on Windows,
+  // so that path separators survive parse's escape processing (\\→\)
+  const parseInput =
+    IS_WINDOWS && shell === "system"
+      ? interpolated.replace(/\\/g, "\\\\")
+      : interpolated;
+  return parse(parseInput)
+    .flatMap((entry) => {
+      if (typeof entry === "string") {
+        return [quoteArg(entry, shell)];
+      }
+      if ("comment" in entry) {
+        return [];
+      }
+      if ("pattern" in entry) {
+        return [entry.pattern];
+      }
+      return [entry.op];
+    })
+    .join(" ");
+};
 class _FileSystemProject extends ProjectBase {
   rootDirectory;
   workspaces;
@@ -122,11 +162,6 @@ class _FileSystemProject extends ProjectBase {
           typeofName: ["boolean", "object"],
           optional: true,
         },
-        "args option": {
-          value: options.args,
-          typeofName: "string",
-          optional: true,
-        },
         "ignoreOutput option": {
           value: options.ignoreOutput,
           typeofName: "boolean",
@@ -137,6 +172,23 @@ class _FileSystemProject extends ProjectBase {
         throw: true,
       },
     );
+    if (options.args !== undefined) {
+      if (typeof options.args !== "string" && !Array.isArray(options.args)) {
+        throw new InvalidJSTypeError(
+          `Type error: args option expects type string | string[], received ${typeof options.args}`,
+        );
+      }
+      if (Array.isArray(options.args)) {
+        const argsError = validateJSArray({
+          value: options.args,
+          valueLabel: "args option",
+          itemOptions: {
+            typeofName: "string",
+          },
+        });
+        if (argsError) throw argsError;
+      }
+    }
     if (isPlainObject(options.inline)) {
       validateJSTypes(
         {
@@ -185,11 +237,7 @@ class _FileSystemProject extends ProjectBase {
       workspaceName: workspace.name,
       scriptName: options.inline ? inlineScriptName : options.script,
     };
-    const args = interpolateScriptRuntimeMetadata(
-      options.args ?? "",
-      scriptRuntimeMetadata,
-      shell,
-    );
+    const args = serializeArgs(options.args, scriptRuntimeMetadata, shell);
     const script = options.inline
       ? interpolateScriptRuntimeMetadata(
           options.script,
@@ -243,11 +291,6 @@ class _FileSystemProject extends ProjectBase {
           typeofName: ["boolean", "object"],
           optional: true,
         },
-        "args option": {
-          value: options.args,
-          typeofName: "string",
-          optional: true,
-        },
         "parallel option": {
           value: options.parallel,
           typeofName: ["boolean", "object"],
@@ -297,6 +340,23 @@ class _FileSystemProject extends ProjectBase {
         },
       );
     }
+    if (options.args !== undefined) {
+      if (typeof options.args !== "string" && !Array.isArray(options.args)) {
+        throw new InvalidJSTypeError(
+          `Type error: args option expects type string | string[], received ${typeof options.args}`,
+        );
+      }
+      if (Array.isArray(options.args)) {
+        const argsError = validateJSArray({
+          value: options.args,
+          valueLabel: "args option",
+          itemOptions: {
+            typeofName: "string",
+          },
+        });
+        if (argsError) throw argsError;
+      }
+    }
     if (isPlainObject(options.parallel)) {
       validateJSTypes(
         {
@@ -384,11 +444,7 @@ class _FileSystemProject extends ProjectBase {
           workspaceName: workspace.name,
           scriptName: options.inline ? inlineScriptName : options.script,
         };
-        const args = interpolateScriptRuntimeMetadata(
-          options.args ?? "",
-          scriptRuntimeMetadata,
-          shell,
-        );
+        const args = serializeArgs(options.args, scriptRuntimeMetadata, shell);
         const script = options.inline
           ? interpolateScriptRuntimeMetadata(
               options.script,

package/src/workspaces/findWorkspaces.mjs

@@ -125,8 +125,9 @@ const findWorkspaces = ({
         path.dirname(packageJsonPath),
       );
       const matchPattern =
-        workspaceGlobs.find((glob) => new bun.Glob(glob).match(relativePath)) ??
-        "";
+        workspaceGlobs.find((glob) =>
+          new bun.Glob(glob.replace(/\/+$/, "")).match(relativePath),
+        ) ?? "";
       const isRootWorkspace = workspacePath === rootDirectory;
       if (!matchPattern && !isRootWorkspace) {
         logger.debug(`No match pattern found for ${relativePath}`);