bun-workspaces 1.0.0-alpha.8 → 1.0.0

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

@@ -0,0 +1,351 @@
+export interface CliCommandConfig {
+  command: string;
+  isGlobal: boolean;
+  aliases: string[] | readonly string[];
+  description: string;
+  options: Record<
+    string,
+    {
+      flags: string[] | readonly string[];
+      description: string;
+      values?: string[];
+      deprecated?: boolean;
+    }
+  >;
+}
+export type CliCommandName = keyof typeof CLI_COMMANDS_CONFIG;
+export type CliGlobalCommandName = {
+  [K in CliCommandName]: (typeof CLI_COMMANDS_CONFIG)[K] extends {
+    isGlobal: true;
+  }
+    ? K
+    : never;
+}[CliCommandName];
+export type CliProjectCommandName = Exclude<
+  CliCommandName,
+  CliGlobalCommandName
+>;
+export declare const JSON_FLAGS: readonly ["-j", "--json"];
+export declare const DEFAULT_GROUPED_LINES = 20;
+export declare const CLI_COMMANDS_CONFIG: {
+  readonly doctor: {
+    readonly command: "doctor";
+    readonly isGlobal: true;
+    readonly aliases: [];
+    readonly description: "Print diagnostic information";
+    readonly options: {
+      readonly json: {
+        readonly flags: readonly ["-j", "--json"];
+        readonly description: "Output as JSON";
+      };
+      readonly pretty: {
+        readonly flags: ["-p", "--pretty"];
+        readonly description: "Pretty print JSON";
+      };
+    };
+  };
+  readonly listWorkspaces: {
+    readonly command: "list-workspaces [workspacePatterns...]";
+    readonly isGlobal: false;
+    readonly aliases: ["ls", "list"];
+    readonly description: "List all workspaces";
+    readonly options: {
+      readonly workspacePatterns: {
+        readonly flags: ["-W", "--workspace-patterns <patterns>"];
+        readonly description: "Workspace patterns to match, separated by spaces";
+      };
+      readonly nameOnly: {
+        readonly flags: ["-n", "--name-only"];
+        readonly description: "Only show workspace names";
+      };
+      readonly json: {
+        readonly flags: readonly ["-j", "--json"];
+        readonly description: "Output as JSON";
+      };
+      readonly pretty: {
+        readonly flags: ["-p", "--pretty"];
+        readonly description: "Pretty print JSON";
+      };
+    };
+  };
+  readonly listScripts: {
+    readonly command: "list-scripts";
+    readonly isGlobal: false;
+    readonly aliases: ["ls-scripts"];
+    readonly description: "List all scripts available with their workspaces";
+    readonly options: {
+      readonly nameOnly: {
+        readonly flags: ["-n", "--name-only"];
+        readonly description: "Only show script names";
+      };
+      readonly json: {
+        readonly flags: readonly ["-j", "--json"];
+        readonly description: "Output as JSON";
+      };
+      readonly pretty: {
+        readonly flags: ["-p", "--pretty"];
+        readonly description: "Pretty print JSON";
+      };
+    };
+  };
+  readonly workspaceInfo: {
+    readonly command: "workspace-info <workspaceName>";
+    readonly isGlobal: false;
+    readonly aliases: ["info"];
+    readonly description: "Show information about a workspace";
+    readonly options: {
+      readonly json: {
+        readonly flags: readonly ["-j", "--json"];
+        readonly description: "Output as JSON";
+      };
+      readonly pretty: {
+        readonly flags: ["-p", "--pretty"];
+        readonly description: "Pretty print JSON";
+      };
+    };
+  };
+  readonly scriptInfo: {
+    readonly command: "script-info <script>";
+    readonly isGlobal: false;
+    readonly aliases: [];
+    readonly description: "Show information about a script";
+    readonly options: {
+      readonly workspacesOnly: {
+        readonly flags: ["-w", "--workspaces-only"];
+        readonly description: "Only show script's workspace names";
+      };
+      readonly json: {
+        readonly flags: readonly ["-j", "--json"];
+        readonly description: "Output as JSON";
+      };
+      readonly pretty: {
+        readonly flags: ["-p", "--pretty"];
+        readonly description: "Pretty print JSON";
+      };
+    };
+  };
+  readonly runScript: {
+    readonly command: "run-script [script] [workspacePatterns...]";
+    readonly isGlobal: false;
+    readonly aliases: ["run"];
+    readonly description: 'Run a script in all workspaces that have it in their "scripts" field in package.json';
+    readonly options: {
+      readonly script: {
+        readonly flags: ["-S", "--script <script>"];
+        readonly description: "The script to run.";
+      };
+      readonly workspacePatterns: {
+        readonly flags: ["-W", "--workspace-patterns <patterns>"];
+        readonly description: "Workspace patterns to match, separated by spaces.";
+      };
+      readonly parallel: {
+        readonly flags: ["-P", "--parallel [max]"];
+        readonly description: 'Run the scripts in parallel. Pass "false" for series, or a concurrency limit as a number, percentage ("50%"), "auto", "default", or"unbounded"';
+      };
+      readonly args: {
+        readonly flags: ["-a", "--args <args>"];
+        readonly description: "Args to append to the script command";
+      };
+      readonly outputStyle: {
+        readonly flags: ["-o", "--output-style <style>"];
+        readonly description: "The output style to use";
+        readonly values: ["grouped", "prefixed", "plain"];
+      };
+      readonly groupedLines: {
+        readonly flags: ["-L", "--grouped-lines <count>"];
+        readonly description: 'With "grouped" output, the max preview lines (number or "all", default 20)';
+      };
+      readonly noPrefix: {
+        readonly flags: ["-N", "--no-prefix"];
+        readonly description: "(DEPRECATED) Use --output-style=plain instead";
+        readonly deprecated: true;
+      };
+      readonly inline: {
+        readonly flags: ["-i", "--inline"];
+        readonly description: "Run the script as an inline command from the workspace directory";
+      };
+      readonly inlineName: {
+        readonly flags: ["-I", "--inline-name <name>"];
+        readonly description: "An optional name for the script when --inline is passed";
+      };
+      readonly shell: {
+        readonly flags: ["-s", "--shell <shell>"];
+        readonly values: ["bun", "system", "default"];
+        readonly description: "When using --inline, the shell to use to run the script";
+      };
+      readonly depOrder: {
+        readonly flags: ["-d", "--dep-order"];
+        readonly description: "Scripts for dependent workspaces run only after their dependencies";
+      };
+      readonly ignoreDepFailure: {
+        readonly flags: ["-f", "--ignore-dep-failure"];
+        readonly description: "In dependency order, continue running scripts even if a dependency fails";
+      };
+      readonly jsonOutfile: {
+        readonly flags: ["-j", "--json-outfile <file>"];
+        readonly description: "Output results in a JSON file";
+      };
+    };
+  };
+};
+export declare const getCliCommandConfig: (commandName: CliCommandName) =>
+  | {
+      readonly command: "doctor";
+      readonly isGlobal: true;
+      readonly aliases: [];
+      readonly description: "Print diagnostic information";
+      readonly options: {
+        readonly json: {
+          readonly flags: readonly ["-j", "--json"];
+          readonly description: "Output as JSON";
+        };
+        readonly pretty: {
+          readonly flags: ["-p", "--pretty"];
+          readonly description: "Pretty print JSON";
+        };
+      };
+    }
+  | {
+      readonly command: "list-workspaces [workspacePatterns...]";
+      readonly isGlobal: false;
+      readonly aliases: ["ls", "list"];
+      readonly description: "List all workspaces";
+      readonly options: {
+        readonly workspacePatterns: {
+          readonly flags: ["-W", "--workspace-patterns <patterns>"];
+          readonly description: "Workspace patterns to match, separated by spaces";
+        };
+        readonly nameOnly: {
+          readonly flags: ["-n", "--name-only"];
+          readonly description: "Only show workspace names";
+        };
+        readonly json: {
+          readonly flags: readonly ["-j", "--json"];
+          readonly description: "Output as JSON";
+        };
+        readonly pretty: {
+          readonly flags: ["-p", "--pretty"];
+          readonly description: "Pretty print JSON";
+        };
+      };
+    }
+  | {
+      readonly command: "list-scripts";
+      readonly isGlobal: false;
+      readonly aliases: ["ls-scripts"];
+      readonly description: "List all scripts available with their workspaces";
+      readonly options: {
+        readonly nameOnly: {
+          readonly flags: ["-n", "--name-only"];
+          readonly description: "Only show script names";
+        };
+        readonly json: {
+          readonly flags: readonly ["-j", "--json"];
+          readonly description: "Output as JSON";
+        };
+        readonly pretty: {
+          readonly flags: ["-p", "--pretty"];
+          readonly description: "Pretty print JSON";
+        };
+      };
+    }
+  | {
+      readonly command: "workspace-info <workspaceName>";
+      readonly isGlobal: false;
+      readonly aliases: ["info"];
+      readonly description: "Show information about a workspace";
+      readonly options: {
+        readonly json: {
+          readonly flags: readonly ["-j", "--json"];
+          readonly description: "Output as JSON";
+        };
+        readonly pretty: {
+          readonly flags: ["-p", "--pretty"];
+          readonly description: "Pretty print JSON";
+        };
+      };
+    }
+  | {
+      readonly command: "script-info <script>";
+      readonly isGlobal: false;
+      readonly aliases: [];
+      readonly description: "Show information about a script";
+      readonly options: {
+        readonly workspacesOnly: {
+          readonly flags: ["-w", "--workspaces-only"];
+          readonly description: "Only show script's workspace names";
+        };
+        readonly json: {
+          readonly flags: readonly ["-j", "--json"];
+          readonly description: "Output as JSON";
+        };
+        readonly pretty: {
+          readonly flags: ["-p", "--pretty"];
+          readonly description: "Pretty print JSON";
+        };
+      };
+    }
+  | {
+      readonly command: "run-script [script] [workspacePatterns...]";
+      readonly isGlobal: false;
+      readonly aliases: ["run"];
+      readonly description: 'Run a script in all workspaces that have it in their "scripts" field in package.json';
+      readonly options: {
+        readonly script: {
+          readonly flags: ["-S", "--script <script>"];
+          readonly description: "The script to run.";
+        };
+        readonly workspacePatterns: {
+          readonly flags: ["-W", "--workspace-patterns <patterns>"];
+          readonly description: "Workspace patterns to match, separated by spaces.";
+        };
+        readonly parallel: {
+          readonly flags: ["-P", "--parallel [max]"];
+          readonly description: 'Run the scripts in parallel. Pass "false" for series, or a concurrency limit as a number, percentage ("50%"), "auto", "default", or"unbounded"';
+        };
+        readonly args: {
+          readonly flags: ["-a", "--args <args>"];
+          readonly description: "Args to append to the script command";
+        };
+        readonly outputStyle: {
+          readonly flags: ["-o", "--output-style <style>"];
+          readonly description: "The output style to use";
+          readonly values: ["grouped", "prefixed", "plain"];
+        };
+        readonly groupedLines: {
+          readonly flags: ["-L", "--grouped-lines <count>"];
+          readonly description: 'With "grouped" output, the max preview lines (number or "all", default 20)';
+        };
+        readonly noPrefix: {
+          readonly flags: ["-N", "--no-prefix"];
+          readonly description: "(DEPRECATED) Use --output-style=plain instead";
+          readonly deprecated: true;
+        };
+        readonly inline: {
+          readonly flags: ["-i", "--inline"];
+          readonly description: "Run the script as an inline command from the workspace directory";
+        };
+        readonly inlineName: {
+          readonly flags: ["-I", "--inline-name <name>"];
+          readonly description: "An optional name for the script when --inline is passed";
+        };
+        readonly shell: {
+          readonly flags: ["-s", "--shell <shell>"];
+          readonly values: ["bun", "system", "default"];
+          readonly description: "When using --inline, the shell to use to run the script";
+        };
+        readonly depOrder: {
+          readonly flags: ["-d", "--dep-order"];
+          readonly description: "Scripts for dependent workspaces run only after their dependencies";
+        };
+        readonly ignoreDepFailure: {
+          readonly flags: ["-f", "--ignore-dep-failure"];
+          readonly description: "In dependency order, continue running scripts even if a dependency fails";
+        };
+        readonly jsonOutfile: {
+          readonly flags: ["-j", "--json-outfile <file>"];
+          readonly description: "Output results in a JSON file";
+        };
+      };
+    };
+export declare const getCliCommandNames: () => CliCommandName[];

package/src/cli/commands/commandsConfig.mjs

@@ -0,0 +1,183 @@
+import { SCRIPT_SHELL_OPTIONS } from "../../runScript/scriptShellOption.mjs";
+import { OUTPUT_STYLE_VALUES } from "./runScript/output/outputStyle.mjs"; // CONCATENATED MODULE: external "../../runScript/scriptShellOption.mjs"
+// CONCATENATED MODULE: external "./runScript/output/outputStyle.mjs"
+// CONCATENATED MODULE: ./src/cli/commands/commandsConfig.ts
+
+const JSON_FLAGS = ["-j", "--json"];
+const DEFAULT_GROUPED_LINES = 20;
+const CLI_COMMANDS_CONFIG = {
+  doctor: {
+    command: "doctor",
+    isGlobal: true,
+    aliases: [],
+    description: "Print diagnostic information",
+    options: {
+      json: {
+        flags: JSON_FLAGS,
+        description: "Output as JSON",
+      },
+      pretty: {
+        flags: ["-p", "--pretty"],
+        description: "Pretty print JSON",
+      },
+    },
+  },
+  listWorkspaces: {
+    command: "list-workspaces [workspacePatterns...]",
+    isGlobal: false,
+    aliases: ["ls", "list"],
+    description: "List all workspaces",
+    options: {
+      workspacePatterns: {
+        flags: ["-W", "--workspace-patterns <patterns>"],
+        description: "Workspace patterns to match, separated by spaces",
+      },
+      nameOnly: {
+        flags: ["-n", "--name-only"],
+        description: "Only show workspace names",
+      },
+      json: {
+        flags: JSON_FLAGS,
+        description: "Output as JSON",
+      },
+      pretty: {
+        flags: ["-p", "--pretty"],
+        description: "Pretty print JSON",
+      },
+    },
+  },
+  listScripts: {
+    command: "list-scripts",
+    isGlobal: false,
+    aliases: ["ls-scripts"],
+    description: "List all scripts available with their workspaces",
+    options: {
+      nameOnly: {
+        flags: ["-n", "--name-only"],
+        description: "Only show script names",
+      },
+      json: {
+        flags: JSON_FLAGS,
+        description: "Output as JSON",
+      },
+      pretty: {
+        flags: ["-p", "--pretty"],
+        description: "Pretty print JSON",
+      },
+    },
+  },
+  workspaceInfo: {
+    command: "workspace-info <workspaceName>",
+    isGlobal: false,
+    aliases: ["info"],
+    description: "Show information about a workspace",
+    options: {
+      json: {
+        flags: JSON_FLAGS,
+        description: "Output as JSON",
+      },
+      pretty: {
+        flags: ["-p", "--pretty"],
+        description: "Pretty print JSON",
+      },
+    },
+  },
+  scriptInfo: {
+    command: "script-info <script>",
+    isGlobal: false,
+    aliases: [],
+    description: "Show information about a script",
+    options: {
+      workspacesOnly: {
+        flags: ["-w", "--workspaces-only"],
+        description: "Only show script's workspace names",
+      },
+      json: {
+        flags: JSON_FLAGS,
+        description: "Output as JSON",
+      },
+      pretty: {
+        flags: ["-p", "--pretty"],
+        description: "Pretty print JSON",
+      },
+    },
+  },
+  runScript: {
+    command: "run-script [script] [workspacePatterns...]",
+    isGlobal: false,
+    aliases: ["run"],
+    description:
+      'Run a script in all workspaces that have it in their "scripts" field in package.json',
+    options: {
+      script: {
+        flags: ["-S", "--script <script>"],
+        description: "The script to run.",
+      },
+      workspacePatterns: {
+        flags: ["-W", "--workspace-patterns <patterns>"],
+        description: "Workspace patterns to match, separated by spaces.",
+      },
+      parallel: {
+        flags: ["-P", "--parallel [max]"],
+        description:
+          'Run the scripts in parallel. Pass "false" for series, or a concurrency limit as a number, percentage ("50%"), "auto", "default", or"unbounded"',
+      },
+      args: {
+        flags: ["-a", "--args <args>"],
+        description: "Args to append to the script command",
+      },
+      outputStyle: {
+        flags: ["-o", "--output-style <style>"],
+        description: "The output style to use",
+        values: [...OUTPUT_STYLE_VALUES],
+      },
+      groupedLines: {
+        flags: ["-L", "--grouped-lines <count>"],
+        description: `With "grouped" output, the max preview lines (number or "all", default ${DEFAULT_GROUPED_LINES})`,
+      },
+      noPrefix: {
+        flags: ["-N", "--no-prefix"],
+        description: "(DEPRECATED) Use --output-style=plain instead",
+        deprecated: true,
+      },
+      inline: {
+        flags: ["-i", "--inline"],
+        description:
+          "Run the script as an inline command from the workspace directory",
+      },
+      inlineName: {
+        flags: ["-I", "--inline-name <name>"],
+        description: "An optional name for the script when --inline is passed",
+      },
+      shell: {
+        flags: ["-s", "--shell <shell>"],
+        values: [...SCRIPT_SHELL_OPTIONS, "default"],
+        description: `When using --inline, the shell to use to run the script`,
+      },
+      depOrder: {
+        flags: ["-d", "--dep-order"],
+        description:
+          "Scripts for dependent workspaces run only after their dependencies",
+      },
+      ignoreDepFailure: {
+        flags: ["-f", "--ignore-dep-failure"],
+        description:
+          "In dependency order, continue running scripts even if a dependency fails",
+      },
+      jsonOutfile: {
+        flags: ["-j", "--json-outfile <file>"],
+        description: "Output results in a JSON file",
+      },
+    },
+  },
+};
+const getCliCommandConfig = (commandName) => CLI_COMMANDS_CONFIG[commandName];
+const getCliCommandNames = () => Object.keys(CLI_COMMANDS_CONFIG);
+
+export {
+  CLI_COMMANDS_CONFIG,
+  DEFAULT_GROUPED_LINES,
+  JSON_FLAGS,
+  getCliCommandConfig,
+  getCliCommandNames,
+};

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

@@ -0,0 +1,15 @@
+export declare const doctor: (
+  context: import("./commandHandlerUtils").GlobalCommandContext,
+) => import("commander").Command;
+export declare const listWorkspaces: (
+  context: import("./commandHandlerUtils").ProjectCommandContext,
+) => import("commander").Command;
+export declare const listScripts: (
+  context: import("./commandHandlerUtils").ProjectCommandContext,
+) => import("commander").Command;
+export declare const workspaceInfo: (
+  context: import("./commandHandlerUtils").ProjectCommandContext,
+) => import("commander").Command;
+export declare const scriptInfo: (
+  context: import("./commandHandlerUtils").ProjectCommandContext,
+) => import("commander").Command;