bun-workspaces 1.1.2 → 1.3.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 🤖

package/bin/cli.js

@@ -1,3 +1,3 @@
 #!/usr/bin/env bun
-import { createCli } from "bun-workspaces/src/cli";
+import { createCli } from "bun-workspaces/cli";
 createCli().run();

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "bun-workspaces",
-  "version": "1.1.2",
+  "version": "1.3.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",
-  "types": "src/index.d.ts",
+  "exports": {
+    ".": "./src/index.mjs",
+    "./cli": "./src/cli/index.mjs",
+    "./config": "./src/config/public.mjs"
+  },
+  "types": "./src/index.d.ts",
   "homepage": "https://bunworkspaces.com",
   "repository": {
     "type": "git",

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

@@ -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/config/public.d.ts

@@ -0,0 +1,10 @@
+export type { ResolvedRootConfig } from "./rootConfig";
+export type { ResolvedWorkspaceConfig } from "./workspaceConfig";
+export {
+  type RootConfig,
+  defineRootConfig,
+} from "./rootConfig/defineRootConfig";
+export {
+  type WorkspaceConfig,
+  defineWorkspaceConfig,
+} from "./workspaceConfig/defineWorkspaceConfig";

package/src/config/public.mjs

@@ -0,0 +1,6 @@
+import { defineRootConfig } from "./rootConfig/defineRootConfig.mjs";
+import { defineWorkspaceConfig } from "./workspaceConfig/defineWorkspaceConfig.mjs"; // CONCATENATED MODULE: external "./rootConfig/defineRootConfig.mjs"
+// CONCATENATED MODULE: external "./workspaceConfig/defineWorkspaceConfig.mjs"
+// CONCATENATED MODULE: ./src/config/public.ts
+
+export { defineRootConfig, defineWorkspaceConfig };

package/src/config/rootConfig/defineRootConfig.d.ts

@@ -0,0 +1,11 @@
+import { type ResolvedRootConfig } from "./rootConfig";
+export type RootConfig = {
+  defaults?: {
+    parallelMax?: number | string;
+    shell?: string;
+    includeRootWorkspace?: boolean;
+  };
+};
+export declare const defineRootConfig: (
+  config: RootConfig,
+) => ResolvedRootConfig;

package/src/config/rootConfig/defineRootConfig.mjs

@@ -0,0 +1,6 @@
+import { resolveRootConfig } from "./rootConfig.mjs"; // CONCATENATED MODULE: external "./rootConfig.mjs"
+// CONCATENATED MODULE: ./src/config/rootConfig/defineRootConfig.ts
+
+const defineRootConfig = (config) => resolveRootConfig(config);
+
+export { defineRootConfig };

package/src/config/util/configLocation.d.ts

@@ -1,4 +1,10 @@
-export declare const CONFIG_LOCATION_TYPES: string[];
+export declare const CONFIG_LOCATION_TYPES: readonly [
+  "tsFile",
+  "jsFile",
+  "jsoncFile",
+  "jsonFile",
+  "packageJson",
+];
 export type ConfigLocationType = (typeof CONFIG_LOCATION_TYPES)[number];
 export type ConfigLocation = {
   type: ConfigLocationType;

package/src/config/util/configLocation.mjs

@@ -1,6 +1,14 @@
 // CONCATENATED MODULE: ./src/config/util/configLocation.ts
-const CONFIG_LOCATION_TYPES = ["jsoncFile", "jsonFile", "packageJson"];
+const CONFIG_LOCATION_TYPES = [
+  "tsFile",
+  "jsFile",
+  "jsoncFile",
+  "jsonFile",
+  "packageJson",
+];
 const CONFIG_LOCATION_PATHS = {
+  tsFile: (name) => `${name}.ts`,
+  jsFile: (name) => `${name}.js`,
   jsoncFile: (name) => `${name}.jsonc`,
   jsonFile: (name) => `${name}.json`,
   packageJson: (_, packageJsonKey) => `package.json["${packageJsonKey}"]`,

package/src/config/util/loadConfig.d.ts

@@ -1,6 +1,8 @@
 import { type AnyFunction } from "../../internal/core";
 import { type ConfigLocation } from "./configLocation";
-export declare const InvalidJSONError: typeof import("../..").BunWorkspacesError;
+export declare const LOAD_CONFIG_ERRORS: import("../../internal/core").DefinedErrors<
+  "InvalidJSON" | "NoExportError" | "ModuleLoadFailure"
+>;
 export declare const getConfigLocation: (
   name: string,
   directory: string,

package/src/config/util/loadConfig.mjs

@@ -12,15 +12,52 @@ import {
 // CONCATENATED MODULE: external "./configLocation.mjs"
 // CONCATENATED MODULE: ./src/config/util/loadConfig.ts
 
-const InvalidJSONError = defineErrors("InvalidJSON").InvalidJSON;
+const LOAD_CONFIG_ERRORS = defineErrors(
+  "InvalidJSON",
+  "NoExportError",
+  "ModuleLoadFailure",
+);
 const parseJSON = (jsonString, path) => {
   try {
     return parseJSONC(jsonString);
   } catch (error) {
-    throw new InvalidJSONError(`Invalid JSON at ${path}: ${error.message}`);
+    throw new LOAD_CONFIG_ERRORS.InvalidJSON(
+      `Invalid JSON at ${path}: ${error.message}`,
+    );
+  }
+};
+const parseModule = (locationType, directory, fileName) => {
+  const configFilePath = path_0.join(
+    directory,
+    createConfigLocationPath(locationType, fileName, ""),
+  );
+  if (fs.existsSync(configFilePath)) {
+    let content;
+    try {
+      // eslint-disable-next-line
+      const module = require(configFilePath);
+      content = module.default;
+    } catch (error) {
+      throw new LOAD_CONFIG_ERRORS.ModuleLoadFailure(
+        `Failed to load module at ${configFilePath}: ${error.message}`,
+      );
+    }
+    if (!content) {
+      throw new LOAD_CONFIG_ERRORS.NoExportError(
+        `No default export found in ${configFilePath}. Expected config object.`,
+      );
+    }
+    return {
+      type: locationType,
+      content,
+      path: path_0.relative(process.cwd(), configFilePath),
+    };
   }
+  return null;
 };
 const LOCATION_FINDERS = {
+  tsFile: (directory, fileName) => parseModule("tsFile", directory, fileName),
+  jsFile: (directory, fileName) => parseModule("jsFile", directory, fileName),
   jsoncFile: (directory, fileName) => {
     const configFilePath = path_0.join(
       directory,
@@ -93,7 +130,7 @@ const getConfigLocation = (name, directory, fileName, packageJsonKey) => {
   }
   if (locations.length > 1) {
     logger.warn(
-      `Found multiple ${name} configs:\n${locations.map((location) => "  " + location.path).join("\n")}\n  Using config at ${locations[0]?.path}`,
+      `Found multiple ${name} configs:\n${locations.map((location) => "  " + location.path).join("\n")}\nUsing config at ${locations[0]?.path}`,
     );
   }
   return locations[0] ?? null;
@@ -115,4 +152,4 @@ const loadConfig = (
   return processContent(location.content);
 };
 
-export { InvalidJSONError, getConfigLocation, loadConfig };
+export { LOAD_CONFIG_ERRORS, getConfigLocation, loadConfig };

package/src/config/util/validateConfig.mjs

@@ -9,7 +9,7 @@ const executeValidator = (validator, name, config, ErrorType) => {
   if (!isValid) {
     const multipleErrors = (validator.errors?.length ?? 0) > 1;
     throw new ErrorType(
-      `Root config is invalid:${multipleErrors ? "\n" : ""}${validator.errors?.map((error) => `${multipleErrors ? "  " : " "}${`config${error.instancePath?.replace(/[/|\\](\d+)/g, "[$1]").replaceAll(/[/|\\]/g, ".") ?? ""}`.replace(/^config[^.]/, "config.")} ${error.message?.replace(/NOT/g, "not")}${suffixAdditionalPropertyName(error)}`).join("\n")}`,
+      `${name.replace("Config", "")} config is invalid:${multipleErrors ? "\n" : ""}${validator.errors?.map((error) => `${multipleErrors ? "  " : " "}${`config${error.instancePath?.replace(/[/|\\](\d+)/g, "[$1]").replaceAll(/[/|\\]/g, ".") ?? ""}`.replace(/^config[^.]/, "config.")} ${error.message?.replace(/NOT/g, "not")}${suffixAdditionalPropertyName(error)}`).join("\n")}`,
     );
   }
 };

package/src/config/workspaceConfig/defineWorkspaceConfig.d.ts

@@ -0,0 +1,11 @@
+import {
+  type ResolvedWorkspaceConfig,
+  type ScriptConfig,
+} from "./workspaceConfig";
+export type WorkspaceConfig = {
+  alias?: string | string[];
+  scripts?: Record<string, ScriptConfig>;
+};
+export declare const defineWorkspaceConfig: (
+  config: WorkspaceConfig,
+) => ResolvedWorkspaceConfig;

package/src/config/workspaceConfig/defineWorkspaceConfig.mjs

@@ -0,0 +1,15 @@
+import { resolveWorkspaceConfig } from "./workspaceConfig.mjs"; // CONCATENATED MODULE: external "./workspaceConfig.mjs"
+// CONCATENATED MODULE: ./src/config/workspaceConfig/defineWorkspaceConfig.ts
+
+const defineWorkspaceConfig = (config) => {
+  if (Array.isArray(config.aliases)) {
+    const { aliases, ...rest } = config;
+    return resolveWorkspaceConfig({
+      ...rest,
+      alias: aliases,
+    });
+  }
+  return resolveWorkspaceConfig(config);
+};
+
+export { defineWorkspaceConfig };

package/src/config/workspaceConfig/workspaceConfig.mjs

@@ -12,10 +12,23 @@ const workspaceConfig_validateWorkspaceConfig = (config) =>
   executeValidator(
     validate,
     "WorkspaceConfig",
-    config,
+    {
+      ...config,
+    },
     WORKSPACE_CONFIG_ERRORS.InvalidWorkspaceConfig,
   );
 const resolveWorkspaceConfig = (config) => {
+  if (Array.isArray(config.aliases)) {
+    const { aliases, ...rest } = config;
+    workspaceConfig_validateWorkspaceConfig({
+      ...rest,
+      alias: aliases,
+    });
+    return {
+      aliases,
+      ...rest,
+    };
+  }
   workspaceConfig_validateWorkspaceConfig(config);
   return {
     aliases: resolveOptionalArray(config.alias ?? []),

package/src/index.d.ts

@@ -24,6 +24,7 @@ export {
   type ScriptEventMetadata,
   type OnScriptEventCallback,
 } from "./project";
+export * from "./config/public";
 export {
   type ScriptEventName,
   type OutputStreamName,

package/src/index.mjs

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

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

@@ -12,3 +12,8 @@ export type RequiredDeep<T> = T extends object
       [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/project/implementations/memoryProject.d.ts

@@ -21,7 +21,7 @@ declare class _MemoryProject extends ProjectBase implements Project {
   readonly name: string;
   readonly sourceType = "memory";
   readonly config: {
-    root: import("../../config").ResolvedRootConfig;
+    root: import("../..").ResolvedRootConfig;
     workspaces: {};
   };
   readonly rootWorkspace: Workspace;

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}`);