@gunshi/definition 1.0.0-rc.2 → 1.0.0-rc.3

package/lib/index.d.ts

@@ -1034,7 +1034,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>;
@@ -1109,8 +1110,11 @@ interface CliOptions<G extends GunshiParamsConstraint = DefaultGunshiParams> {
   version?: string;
   /**
    * Sub commands.
+   *
+   * An object or a Map keyed by the sub-command names, or an array of commands, which are keyed by their names.
+   * When this is not given, the {@linkcode Command.subCommands} of the entry command are the sub-commands.
    */
-  subCommands?: Record<string, SubCommandable> | Map<string, SubCommandable>;
+  subCommands?: Record<string, SubCommandable> | Map<string, SubCommandable> | readonly SubCommandable[];
   /**
    * Left margin of the command output.
    */
@@ -1442,10 +1446,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.
@@ -1522,7 +1529,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
    */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/definition",
   "description": "utilities for gunshi command definition",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0-rc.3",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -53,7 +53,7 @@
   },
   "devDependencies": {
     "deno": "^2.7.14",
-    "gunshi": "1.0.0-rc.2",
+    "gunshi": "1.0.0-rc.3",
     "jsr": "^0.14.3",
     "jsr-exports-lint": "^0.4.2",
     "publint": "^0.3.20",