@gunshi/definition 0.27.6 → 0.28.2

package/lib/index.d.ts

@@ -1057,6 +1057,15 @@ interface CommandContext<G extends GunshiParamsConstraint = DefaultGunshiParams>
    * The command call mode is `entry` when the command is executed as an entry command, and `subCommand` when the command is executed as a sub-command.
    */
   callMode: CommandCallMode;
+  /**
+   * The path of nested sub-commands that were resolved to reach the current command.
+   *
+   * For example, if the user runs `git remote add`, `commandPath` would be `['remote', 'add']`.
+   * For the entry command, this is an empty array.
+   *
+   * @since v0.28.0
+   */
+  commandPath: string[];
   /**
    * Whether to convert the camel-case style argument name to kebab-case.
    * This context value is set from {@linkcode Command.toKebab} option.
@@ -1198,6 +1207,15 @@ interface Command<G extends GunshiParamsConstraint = DefaultGunshiParams> {
    * @since v0.27.0
    */
   rendering?: RenderingOptions<G>;
+  /**
+   * Nested sub-commands for this command.
+   *
+   * Allows building command trees like `git remote add`.
+   * Each key is the sub-command name, and the value is a command or lazy command.
+   *
+   * @since v0.28.0
+   */
+  subCommands?: Record<string, SubCommandable> | Map<string, SubCommandable>;
 }
 /**
  * Lazy command interface.
@@ -1268,6 +1286,13 @@ interface SubCommandable {
    * see {@link LazyCommand.commandName}
    */
   commandName?: string;
+  /**
+   * Nested sub-commands for this command.
+   *
+   * @see {@link Command.subCommands}
+   * @since v0.28.0
+   */
+  subCommands?: Record<string, any> | Map<string, any>;
   /**
    * Index signature to allow additional properties
    */
@@ -1354,6 +1379,10 @@ interface CommandContextParams<G extends GunshiParams | {
    * Command call mode.
    */
   callMode?: CommandCallMode;
+  /**
+   * The path of nested sub-commands resolved to reach the current command.
+   */
+  commandPath?: string[];
   /**
    * A target command
    */
@@ -1389,6 +1418,7 @@ declare function createCommandContext<G extends GunshiParamsConstraint = Default
   extensions,
   cliOptions,
   callMode,
+  commandPath,
   omitted,
   validationError
 }: CommandContextParams<G, V, C, E>): Promise<{} extends ExtractExtensions<E> ? Readonly<CommandContext<G>> : Readonly<CommandContext<GunshiParams<{

package/lib/index.js

@@ -90,7 +90,7 @@ function deepFreeze(obj, ignores = []) {
 * @param param - A {@link CommandContextParams | parameters} to create a command context.
 * @returns A {@link CommandContext | command context}, which is readonly.
 */
-async function createCommandContext({ args = {}, explicit = {}, values = {}, positionals = [], rest = [], argv = [], tokens = [], command = {}, extensions = {}, cliOptions = {}, callMode = "entry", omitted = false, validationError = void 0 }) {
+async function createCommandContext({ args = {}, explicit = {}, values = {}, positionals = [], rest = [], argv = [], tokens = [], command = {}, extensions = {}, cliOptions = {}, callMode = "entry", commandPath = [], omitted = false, validationError = void 0 }) {
 	/**
 	* normailize the options schema and values, to avoid prototype pollution
 	*/
@@ -119,6 +119,7 @@ async function createCommandContext({ args = {}, explicit = {}, values = {}, pos
 		description: command.description,
 		omitted,
 		callMode,
+		commandPath,
 		env,
 		args: _args,
 		explicit,
@@ -219,6 +220,7 @@ function lazy(loader, definition) {
 		lazyCommand.internal = definition.internal;
 		lazyCommand.entry = definition.entry;
 		lazyCommand.toKebab = definition.toKebab;
+		if (definition.subCommands) lazyCommand.subCommands = definition.subCommands;
 		if ("resource" in definition) lazyCommand.resource = definition.resource;
 	}
 	return lazyCommand;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/definition",
   "description": "utilities for gunshi command definition",
-  "version": "0.27.6",
+  "version": "0.28.2",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -57,7 +57,7 @@
     "jsr-exports-lint": "^0.4.1",
     "publint": "^0.3.16",
     "tsdown": "0.15.12",
-    "gunshi": "0.27.6"
+    "gunshi": "0.28.2"
   },
   "scripts": {
     "build": "tsdown",