@gunshi/shared 1.0.0-rc.1 → 1.0.0-rc.3

package/lib/index.d.ts

@@ -871,7 +871,8 @@ interface CommandEnvironment<G extends GunshiParamsConstraint = DefaultGunshiPar
    * The entry command of the CLI, marked with `entry: true`.
    *
    * It is available whether or not the CLI has sub-commands, while {@linkcode CommandEnvironment.subCommands}
-   * includes the entry command only when the sub-commands are given with {@linkcode CliOptions.subCommands}.
+   * includes the entry command only when the CLI has sub-commands, given with {@linkcode CliOptions.subCommands}
+   * or with {@linkcode Command.subCommands} of the entry command.
    * It is not frozen, like the commands in {@linkcode CommandEnvironment.subCommands}.
    */
   entryCommand?: Command<any> | LazyCommand<any>;
@@ -1056,9 +1057,11 @@ interface RenderingOptions<G extends GunshiParamsConstraint = DefaultGunshiParam
   usage?: ((ctx: Readonly<CommandContext<G>>) => Promise<string>) | null;
   /**
    * Validation errors rendering configuration
-   * - `null`: Disable rendering
+   * - `null`: Disable rendering. `cli()` rejects with the validation errors, for the caller to report them
    * - `function`: Use custom renderer
    * - `undefined` (when omitted): Use default renderer
+   *
+   * See {@linkcode CliOptions.renderValidationErrors} for where the rendered message goes.
    */
   validationErrors?: ((ctx: Readonly<CommandContext<G>>, error: AggregateError) => Promise<string>) | null;
 }
@@ -1123,10 +1126,13 @@ interface Command<G extends GunshiParamsConstraint = DefaultGunshiParams> {
    *
    * Allows building command trees like `git remote add`.
    * Each key is the sub-command name, and the value is a command or lazy command.
+   * An array of commands is keyed by the names of the commands.
+   *
+   * On the entry command, these are the top-level sub-commands when {@linkcode CliOptions.subCommands} is not given.
    *
    * @since v0.28.0
    */
-  subCommands?: Record<string, SubCommandable> | Map<string, SubCommandable>;
+  subCommands?: Record<string, SubCommandable> | Map<string, SubCommandable> | readonly SubCommandable[];
 }
 /**
  * Lazy command interface.
@@ -1209,7 +1215,7 @@ interface SubCommandable {
    * @see {@link Command.subCommands}
    * @since v0.28.0
    */
-  subCommands?: Record<string, any> | Map<string, any>;
+  subCommands?: Record<string, any> | Map<string, any> | readonly any[];
   /**
    * Index signature to allow additional properties
    */
@@ -1294,8 +1300,11 @@ declare function log(...args: unknown[]): void;
 /**
  * Get the sub-commands of a command as a normalized Map.
  *
+ * An array of sub-commands is keyed by the names of the commands (`commandName` for a lazy command).
+ *
  * @param cmd - A command or lazy command
  * @returns A Map of sub-commands, or undefined if the command has no sub-commands.
+ * @throws {TypeError} If a command in an array has no name, or two commands in an array have the same name.
  */
 declare function getCommandSubCommands<G extends GunshiParamsConstraint = DefaultGunshiParams>(cmd: Commandable<G> | Command<G> | LazyCommand<G>): Map<string, Command<G> | LazyCommand<G>> | undefined;
 /**

package/lib/index.js

@@ -111,13 +111,27 @@ function log(...args) {
 /**
 * Get the sub-commands of a command as a normalized Map.
 *
+* An array of sub-commands is keyed by the names of the commands (`commandName` for a lazy command).
+*
 * @param cmd - A command or lazy command
 * @returns A Map of sub-commands, or undefined if the command has no sub-commands.
+* @throws {TypeError} If a command in an array has no name, or two commands in an array have the same name.
 */
 function getCommandSubCommands(cmd) {
 	const subCommands = isLazyCommand(cmd) ? cmd.subCommands : typeof cmd === "object" ? cmd.subCommands : void 0;
 	if (!subCommands) return;
 	if (subCommands instanceof Map) return subCommands.size > 0 ? subCommands : void 0;
+	if (Array.isArray(subCommands)) {
+		if (subCommands.length === 0) return;
+		const map = /* @__PURE__ */ new Map();
+		for (const sub of subCommands) {
+			const name = isLazyCommand(sub) ? sub.commandName : sub?.name;
+			if (typeof name !== "string" || name === "") throw new TypeError(`Sub-command name must be a non-empty string in an array of 'subCommands'`);
+			if (map.has(name)) throw new TypeError(`Sub-command '${name}' is given twice in an array of 'subCommands'`);
+			map.set(name, sub);
+		}
+		return map;
+	}
 	if (typeof subCommands === "object") {
 		const entries = Object.entries(subCommands);
 		if (entries.length === 0) return;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/shared",
   "description": "shared utils for gunshi",
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0-rc.3",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -50,9 +50,9 @@
     }
   },
   "devDependencies": {
-    "@gunshi/resources": "1.0.0-rc.1",
+    "@gunshi/resources": "1.0.0-rc.3",
     "deno": "^2.7.14",
-    "gunshi": "1.0.0-rc.1",
+    "gunshi": "1.0.0-rc.3",
     "jsr": "^0.14.3",
     "jsr-exports-lint": "^0.4.2",
     "publint": "^0.3.20",