fix(complete): Improve help output

clap-rs · Aug 9, 2024 · 219a191 · 219a191
1 parent 734cac7
commit 219a191
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/clap_complete/src/dynamic/shells/mod.rs b/clap_complete/src/dynamic/shells/mod.rs
@@ -187,14 +187,19 @@ impl CompleteCommand {
 #[command(about = None, long_about = None)]
 pub struct CompleteArgs {
     /// Path to write completion-registration to
-    #[arg(long)]
+    #[arg(long, value_name = "PATH")]
     register: Option<std::path::PathBuf>,
 
-    #[arg(raw = true, hide = true, conflicts_with = "register")]
+    #[arg(
+        raw = true,
+        value_name = "ARG",
+        hide = true,
+        conflicts_with = "register"
+    )]
     comp_words: Option<Vec<OsString>>,
 
     /// Specify shell to complete for
-    #[arg(long)]
+    #[arg(long, value_name = "NAME")]
     shell: Option<Shell>,
 }
 

diff --git a/clap_complete/tests/snapshots/home/static/exhaustive/bash/.bashrc b/clap_complete/tests/snapshots/home/static/exhaustive/bash/.bashrc
@@ -238,7 +238,7 @@ _exhaustive() {
             return 0
             ;;
         exhaustive__complete)
-            opts="-h -V --register --shell --global --help --version [COMP_WORDS]..."
+            opts="-h -V --register --shell --global --help --version [ARG]..."
             if [[ ${cur} == -* || ${COMP_CWORD} -eq 2 ]] ; then
                 COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
                 return 0

diff --git a/clap_complete/tests/snapshots/home/static/exhaustive/zsh/zsh/_exhaustive b/clap_complete/tests/snapshots/home/static/exhaustive/zsh/zsh/_exhaustive
@@ -325,8 +325,8 @@ _arguments "${_arguments_options[@]}" : \
 ;;
 (complete)
 _arguments "${_arguments_options[@]}" : \
-'--register=[Path to write completion-registration to]:REGISTER:_files' \
-'--shell=[Specify shell to complete for]:SHELL:(bash elvish fish powershell zsh)' \
+'--register=[Path to write completion-registration to]:PATH:_files' \
+'--shell=[Specify shell to complete for]:NAME:(bash elvish fish powershell zsh)' \
 '--global[everywhere]' \
 '-h[Print help]' \
 '--help[Print help]' \