feat(complete): group options by tag (in zsh)

clap_complete/examples/dynamic.rs

@@ -12,6 +12,12 @@ fn command() -> clap::Command {
                 .short('F')
                 .value_parser(["json", "yaml", "toml"]),
         )
+        .arg(
+            clap::Arg::new("verbose")
+                .long("verbose")
+                .short('v')
+                .global(true),
+        )
         .args_conflicts_with_subcommands(true)
 }
 

clap_complete/tests/snapshots/home/dynamic-env/dynamic/zsh/zsh/_dynamic

@@ -0,0 +1,50 @@
+#compdef dynamic
+function _clap_dynamic_completer_dynamic() {
+    local _CLAP_COMPLETE_INDEX=$(expr $CURRENT - 1)
+    local _CLAP_IFS=$'\n'
+
+    local completions=("${(@f)$( \
+        _CLAP_IFS="$_CLAP_IFS" \
+        _CLAP_COMPLETE_INDEX="$_CLAP_COMPLETE_INDEX" \
+        COMPLETE="zsh" \
+        dynamic -- "${words[@]}" 2>/dev/null \
+    )}")
+
+    if [[ -n $completions ]]; then
+        local -A tag_map
+        local -a dirs=()
+        local completion
+        local tag
+        local value
+
+        for completion in $completions; do
+            IFS=: read -r tag value <<< "$completion"
+            if [[ "$value" == */ ]]; then
+                local dir_no_slash="${value%/}"
+                if [[ "$value" == *:* ]]; then
+                    local desc="${value#*:}"
+                    dirs+=("$dir_no_slash:$desc")
+                else
+                    dirs+=("$dir_no_slash")
+                fi
+            else
+                if (( ${+tag_map["$tag"]} )); then # key exists?
+                    tag_map["$tag"]+=$'\n'"$value"
+                else
+                    tag_map["$tag"]="$value"
+                fi
+            fi
+        done
+        [[ -n $dirs ]] && _describe -t dirs 'values' dirs -S '/' -r '/'
+        for tag in ${(k)tag_map}; do
+            values=("${(@f)tag_map[$tag]}") # split on newline
+            if [[ -n $tag ]]; then
+              _describe -t "$tag" "$tag options" values
+            else
+              _describe "options" values
+            fi
+        done
+    fi
+}
+
+compdef _clap_dynamic_completer_dynamic dynamic

clap_complete/tests/testsuite/zsh.rs

@@ -235,6 +235,7 @@ pacman  action  global  alias  value  quote  empty  last  --
 #[cfg(feature = "unstable-shell-tests")]
 fn register_dynamic_env() {
     common::register_example::<RuntimeBuilder>("dynamic-env", "exhaustive");
+    common::register_example::<RuntimeBuilder>("dynamic-env", "dynamic");
 }
 
 #[test]
@@ -253,7 +254,7 @@ fn complete_dynamic_env_toplevel() {
 % exhaustive
 --generate      -- generate
 --help          -- Print help
-help            -- Print this message or the help of the given subcommand(s)
+help    -- Print this message or the help of the given subcommand(s)
 --empty-choice  alias           global          last            quote           
 action          empty           hint            pacman          value           
 "#]];
@@ -275,15 +276,21 @@ fn complete_dynamic_env_quoted_help() {
     let input = "exhaustive quote \t\t";
     let expected = snapbox::str![[r#"
 % exhaustive quote
---help                              -- Print help (see more with '--help')                                            
-cmd-backslash      --backslash      -- Avoid '/n'                                                                     
-cmd-backticks      --backticks      -- For more information see `echo test`                                           
-cmd-brackets       --brackets       -- List packages [filter]                                                         
-cmd-double-quotes  --double-quotes  -- Can be "always", "auto", or "never"                                            
-cmd-expansions     --expansions     -- Execute the shell command with $SHELL                                          
-cmd-single-quotes  --single-quotes  -- Can be 'always', 'auto', or 'never'                                            
-escape-help                         -- /tab/t"'                                                                       
-help                                -- Print this message or the help of the given subcommand(s)                      
+--backslash      -- Avoid '/n'
+--backticks      -- For more information see `echo test`
+--brackets       -- List packages [filter]
+--double-quotes  -- Can be "always", "auto", or "never"
+--expansions     -- Execute the shell command with $SHELL
+--help           -- Print help (see more with '--help')
+--single-quotes  -- Can be 'always', 'auto', or 'never'
+cmd-backslash      -- Avoid '/n'
+cmd-backticks      -- For more information see `echo test`
+cmd-brackets       -- List packages [filter]
+cmd-double-quotes  -- Can be "always", "auto", or "never"
+cmd-expansions     -- Execute the shell command with $SHELL
+cmd-single-quotes  -- Can be 'always', 'auto', or 'never'
+escape-help        -- /tab      "'
+help               -- Print this message or the help of the given subcommand(s)
 --choice
 "#]];
     let actual = runtime.complete(input, &term).unwrap();
@@ -392,15 +399,21 @@ fn complete_dynamic_empty_space() {
     let input = "exhaustive quote  -\x1b[D\x1b[D\t\t";
     let expected = snapbox::str![[r#"
 % exhaustive quote  -
---help                              -- Print help (see more with '--help')                                            
-cmd-backslash      --backslash      -- Avoid '/n'                                                                     
-cmd-backticks      --backticks      -- For more information see `echo test`                                           
-cmd-brackets       --brackets       -- List packages [filter]                                                         
-cmd-double-quotes  --double-quotes  -- Can be "always", "auto", or "never"                                            
-cmd-expansions     --expansions     -- Execute the shell command with $SHELL                                          
-cmd-single-quotes  --single-quotes  -- Can be 'always', 'auto', or 'never'                                            
-escape-help                         -- /tab/t"'                                                                       
-help                                -- Print this message or the help of the given subcommand(s)                      
+--backslash      -- Avoid '/n'
+--backticks      -- For more information see `echo test`
+--brackets       -- List packages [filter]
+--double-quotes  -- Can be "always", "auto", or "never"
+--expansions     -- Execute the shell command with $SHELL
+--help           -- Print help (see more with '--help')
+--single-quotes  -- Can be 'always', 'auto', or 'never'
+cmd-backslash      -- Avoid '/n'
+cmd-backticks      -- For more information see `echo test`
+cmd-brackets       -- List packages [filter]
+cmd-double-quotes  -- Can be "always", "auto", or "never"
+cmd-expansions     -- Execute the shell command with $SHELL
+cmd-single-quotes  -- Can be 'always', 'auto', or 'never'
+escape-help        -- /tab      "'
+help               -- Print this message or the help of the given subcommand(s)
 --choice
 "#]];
     let actual = runtime.complete(input, &term).unwrap();