Add: RelayCommand.

Author: ya7010

cmdcomp/v2/command/__init__.py

@@ -90,6 +90,48 @@ def has_keyword_arguments(self) -> bool:
         ...
 
 
+class _V2EmptyCommand(_V2BaseCommand):
+    @property
+    @override
+    def subcommands(self) -> OrderedDict[SubcommandName, "V2Command"]:
+        return OrderedDict()
+
+    @property
+    @override
+    def positional_arguments(self) -> OrderedDict[Position, V2Argument]:
+        return OrderedDict()
+
+    @property
+    @override
+    def positional_wildcard_argument(self) -> V2Argument | None:
+        return None
+
+    @property
+    @override
+    def keyword_arguments(self) -> OrderedDict[Keyword, V2Argument]:
+        return OrderedDict()
+
+    @property
+    @override
+    def has_subcommands(self) -> bool:
+        return False
+
+    @property
+    @override
+    def has_positional_arguments(self) -> bool:
+        return False
+
+    @property
+    @override
+    def has_positional_wildcard_argument(self) -> bool:
+        return False
+
+    @property
+    @override
+    def has_keyword_arguments(self) -> bool:
+        return False
+
+
 class V2PoristionalArgumentsCommand(_V2BaseCommand):
     arguments: Annotated[
         OrderedDict[Position | Literal["*"] | Keyword, _InputArgument | None],
@@ -228,7 +270,28 @@ def has_keyword_arguments(self) -> bool:
         return len(self.keyword_arguments) != 0
 
 
-V2Command = V2PoristionalArgumentsCommand | V2SubcommandsCommand
+class V2RelayCommand(_V2EmptyCommand):
+    """relay completion of other command."""
+
+    type: Annotated[
+        Literal["relay"],
+        Field(title="relay completion of other command."),
+    ]
+
+    description: Annotated[
+        str | None,
+        Field(title="description of the argument."),
+    ] = None
+
+    alias: Annotated[
+        str | list[str] | None,
+        Field(title="alias of the argument."),
+    ] = None
+
+    target: Annotated[str, Field(title="relay target.")]
+
+
+V2Command = V2PoristionalArgumentsCommand | V2SubcommandsCommand | V2RelayCommand
 
 
 def _convert_argument(value: _InputArgument | None) -> V2Argument:

cmdcomp/v2/templates/zsh.sh.jinja

@@ -41,6 +41,10 @@
 
   case $cmd_name in
 {%- for cmd_name, command in commands.items() recursive %}
+{%- if command.type == "relay"  %}
+    {{ ([cmd_name] + command.aliases)|join("|") }})
+      ;;
+{%- else -%}
 {%- set scope = scope + "_" + cmd_name %}
     {{ ([cmd_name] + command.aliases)|join("|") }})
 {%- if command.has_subcommands %}
@@ -83,6 +87,7 @@
       esac
 {%- endif %}
       ;;
+{%- endif %}
 {% endfor %}
   esac
 

docs/config.schema.json

@@ -330,6 +330,9 @@
                         },
                         {
                             "$ref": "#/$defs/V2SubcommandsCommand"
+                        },
+                        {
+                            "$ref": "#/$defs/V2RelayCommand"
                         }
                     ],
                     "title": "Root"
@@ -502,9 +505,6 @@
                             {
                                 "$ref": "#/$defs/V2FlagArgument"
                             },
-                            {
-                                "$ref": "#/$defs/V2RelayArgument"
-                            },
                             {
                                 "type": "null"
                             }
@@ -521,14 +521,10 @@
             "title": "V2PoristionalArgumentsCommand",
             "type": "object"
         },
-        "V2RelayArgument": {
+        "V2RelayCommand": {
             "additionalProperties": false,
             "description": "relay completion of other command.",
             "properties": {
-                "type": {
-                    "const": "relay",
-                    "title": "relay completion of other command."
-                },
                 "description": {
                     "anyOf": [
                         {
@@ -559,6 +555,10 @@
                     "default": null,
                     "title": "alias of the argument."
                 },
+                "type": {
+                    "const": "relay",
+                    "title": "relay completion of other command."
+                },
                 "target": {
                     "title": "relay target.",
                     "type": "string"
@@ -568,7 +568,7 @@
                 "type",
                 "target"
             ],
-            "title": "V2RelayArgument",
+            "title": "V2RelayCommand",
             "type": "object"
         },
         "V2SelectArgument": {
@@ -610,16 +610,43 @@
                     "title": "alias of the argument."
                 },
                 "options": {
-                    "items": {
-                        "type": "string"
-                    },
-                    "title": "completion candidates.",
-                    "type": "array"
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ],
+                    "default": null,
+                    "title": "completion candidates."
+                },
+                "values": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "type": "string"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ],
+                    "default": null,
+                    "deprecated": true,
+                    "description": "this field is deprecated. use `options` instead.",
+                    "title": "completion candidates."
                 }
             },
             "required": [
-                "type",
-                "options"
+                "type"
             ],
             "title": "V2SelectArgument",
             "type": "object"
@@ -683,9 +710,6 @@
                                 {
                                     "$ref": "#/$defs/V2FlagArgument"
                                 },
-                                {
-                                    "$ref": "#/$defs/V2RelayArgument"
-                                },
                                 {
                                     "type": "null"
                                 }
@@ -704,6 +728,9 @@
                             {
                                 "$ref": "#/$defs/V2SubcommandsCommand"
                             },
+                            {
+                                "$ref": "#/$defs/V2RelayCommand"
+                            },
                             {
                                 "type": "null"
                             }

examples/v2/config.cmdcomp.toml

@@ -72,6 +72,11 @@ type = "command"
 description = "run script."
 execute = "echo 'script1.sh script2.sh script3.sh'"
 
+[root.subcommands.git]
+type = "relay"
+description = "git command."
+target = "git"
+
 [root.subcommands.test]
 description = "test command."
 

examples/v2/config.cmdcomp.yaml

@@ -63,6 +63,10 @@ root:
               type: command
               description: "run script."
               execute: "echo 'script1.sh script2.sh script3.sh'"
+    git:
+      type: relay
+      description: git command.
+      target: "git"
     test:
       description: "test command."
       subcommands:

examples/v2/output.bash

@@ -40,6 +40,11 @@ _cliname() {
         cur=$(( cur + opts_cur + 1 ))
         ;;
 
+      _cliname,git)
+        cmd="_cliname_git"
+        cur=$(( cur + opts_cur + 1 ))
+        ;;
+
       _cliname,test)
         cmd="_cliname_test"
         cur=$(( cur + opts_cur + 1 ))
@@ -120,7 +125,7 @@ _cliname() {
         COMPREPLY=( $(compgen -W "${opts}" -- "${COMP_WORDS[COMP_CWORD]}") )
         return 0
       elif [ $cur -eq $COMP_CWORD ] ; then
-        opts="list ls cd scripts test"
+        opts="list ls cd scripts git test"
         COMPREPLY=( $(compgen -W "${opts}" -- "${COMP_WORDS[COMP_CWORD]}") )
         return 0
       fi
@@ -261,6 +266,18 @@ _cliname() {
       return 0
       ;;
 
+    _cliname_git)
+      cmd_cur=$cur
+      while [ $cur -lt $COMP_CWORD ] ; do
+        cur=$(( cur + 1 ))
+      done
+
+      opts=""
+      COMPREPLY=( $(compgen -W "${opts}" -- "${COMP_WORDS[COMP_CWORD]}") )
+
+      return 0
+      ;;
+
     _cliname_test)
       cmd_cur=$cur
       while [ $cur -lt $COMP_CWORD ] ; do

examples/v2/output.zsh

@@ -17,6 +17,7 @@ _cliname() {
         {list,ls}'[list project files.]'
         cd'[cd project directory.]'
         scripts'[operate scripts.]'
+        git'[git command.]'
         test'[test command.]'
       )
 
@@ -78,6 +79,9 @@ _cliname() {
               esac
               ;;
 
+            git)
+              ;;
+
             test)
               local -a __test_subcmds
               __test_subcmds=(