Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-15 07:12:32 +00:00
Code Issues Projects Releases Packages Wiki Activity
clap/clap_complete/tests/snapshots/basic.bash

111 lines
3.1 KiB
Bash
Raw Normal View History

test(complete): Switch to snapshot testing - This will make it easier to update - We now uniformly test each shell
2022-03-07 20:03:46 +00:00
_my-app() {
fix: Bash test cases
2023-01-23 18:20:09 +00:00
local i cur prev opts cmd
test(complete): Switch to snapshot testing - This will make it easier to update - We now uniformly test each shell
2022-03-07 20:03:46 +00:00
COMPREPLY=()
cur="${COMP_WORDS[COMP_CWORD]}"
prev="${COMP_WORDS[COMP_CWORD-1]}"
cmd=""
opts=""
for i in ${COMP_WORDS[@]}
do
fix(complete): Fix `git diff git <TAB>` for Bash Early in the Bash-completion script, we build up a string that identifies the command or subcommand. When we see the top-level command's name (e.g. `git`) we set the command so far to that value. We do that regardless of where in the argument list it appears. For example, if the argument list is `git diff git`, we set the current command to `git` when run into it the second time. We therefore suggest arguments to the top-level command afterwards, which is not correct. This patch fixes that by also considering the string that identifies the command so far, so we only set the overall command to `git` if the command so far is the empty string. This is actually just a step on the way to getting completion to work for aliases of subcommands. Closes #4273
2022-09-28 14:33:31 +00:00
case "${cmd},${i}" in
",$1")
test(complete): Switch to snapshot testing - This will make it easier to update - We now uniformly test each shell
2022-03-07 20:03:46 +00:00
cmd="my__app"
;;
fix(complete): Fix `git diff log <TAB>` for Bash This continues the work started with the fix for #4273. There was another bug caused by using the subcommand names without considering their position in the argument list. If the user enters `git diff log <TAB>`, we build up a string that identifies the subcommand. We ended up making the string `git__diff__log` in this case because we appended `__log` without considering the current state. Since `git__diff__log` does not correspond to an actual command, we wouldn't provide any suggestions. This commit restructures the code so we walk subcommands and subsubcommands in `bash.rs`. While walking those, we build up a list containing triples of the parent `$cmd` name (e.g. `git__diff`), the current command's name (e.g. `log`), and the `$cmd` for the current command. We then build the shell script's case arms based on that information. We could instead have fixed #4280 by using the second element in the pair returned from `utils::all_subcommands()` (a stringified list of the subcommand path) instead of the first one. However, that would not have helped us solve #4265. Closes #4280
2022-09-28 21:33:59 +00:00
my__app,help)
cmd="my__app__help"
test(complete): Switch to snapshot testing - This will make it easier to update - We now uniformly test each shell
2022-03-07 20:03:46 +00:00
;;
fix(complete): Fix `git diff log <TAB>` for Bash This continues the work started with the fix for #4273. There was another bug caused by using the subcommand names without considering their position in the argument list. If the user enters `git diff log <TAB>`, we build up a string that identifies the subcommand. We ended up making the string `git__diff__log` in this case because we appended `__log` without considering the current state. Since `git__diff__log` does not correspond to an actual command, we wouldn't provide any suggestions. This commit restructures the code so we walk subcommands and subsubcommands in `bash.rs`. While walking those, we build up a list containing triples of the parent `$cmd` name (e.g. `git__diff`), the current command's name (e.g. `log`), and the `$cmd` for the current command. We then build the shell script's case arms based on that information. We could instead have fixed #4280 by using the second element in the pair returned from `utils::all_subcommands()` (a stringified list of the subcommand path) instead of the first one. However, that would not have helped us solve #4265. Closes #4280
2022-09-28 21:33:59 +00:00
my__app,test)
cmd="my__app__test"
;;
my__app__help,help)
cmd="my__app__help__help"
;;
my__app__help,test)
cmd="my__app__help__test"
test(complete): Switch to snapshot testing - This will make it easier to update - We now uniformly test each shell
2022-03-07 20:03:46 +00:00
;;
*)
;;
esac
done
case "${cmd}" in
my__app)
fix!: Require explicit help/version disabling Before we introduced actions, it required specific setups to engage with claps version and help printing. With actions making that more explicit, we don't get as much benefit from our multiple, obscure, ways of users customizing help Before - Modify existing help or version with `mut_arg` which would automatically be pushed down the command tree like `global(true)` - Create an new help or version and have it treated as if it was the built-in on (I think) - Use the same flags as built-in and have the built-in flags automatically disabled - Users could explicitly disable the built-in functionality and do what they want Now - `mut_arg` no longer works as we define help and version flags at the end - If someone defines a flag that overlaps with the built-ins by id, long, or short, a debug assert will tell them to explicitly disable the built-in - Any customization has to be done by a user providing their own. To propagate through the command tree, they need to set `global(true)`. Benefits - Hopefully, this makes it less confusing on how to override help behavior. Someone creates an arg and we then tell them how to disable the built-in - This greatly simplifies the arg handling by pushing more responsibility onto the developer in what are hopefully just corner cases - This removes about 1Kb from .text Fixes #3405 Fixes #4033
2022-08-08 21:08:47 +00:00
opts="-c -v -h --help test help"
test(complete): Switch to snapshot testing - This will make it easier to update - We now uniformly test each shell
2022-03-07 20:03:46 +00:00
if [[ ${cur} == -* || ${COMP_CWORD} -eq 1 ]] ; then
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
fi
case "${prev}" in
*)
COMPREPLY=()
;;
esac
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
;;
my__app__help)
fix(help): Do not propagate global args to help This prevents global args from showing in help completions, since help completions should only suggest subcommands. Adds tests to ensure the args still show in the generated help messages of subcommands.
2022-08-27 00:40:48 +00:00
opts="test help"
test(complete): Switch to snapshot testing - This will make it easier to update - We now uniformly test each shell
2022-03-07 20:03:46 +00:00
if [[ ${cur} == -* || ${COMP_CWORD} -eq 2 ]] ; then
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
fi
case "${prev}" in
*)
COMPREPLY=()
;;
esac
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
;;
feat(complete): Add completion for help subcommands Adds parser flags to toggle whether to run the expensive clone logic for completions case. Help completion will only suggest subcommands, not args. clap_complete generator sets the flag.
2022-08-25 05:44:07 +00:00
my__app__help__help)
fix(help): Do not propagate global args to help This prevents global args from showing in help completions, since help completions should only suggest subcommands. Adds tests to ensure the args still show in the generated help messages of subcommands.
2022-08-27 00:40:48 +00:00
opts=""
feat(complete): Add completion for help subcommands Adds parser flags to toggle whether to run the expensive clone logic for completions case. Help completion will only suggest subcommands, not args. clap_complete generator sets the flag.
2022-08-25 05:44:07 +00:00
if [[ ${cur} == -* || ${COMP_CWORD} -eq 3 ]] ; then
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
fi
case "${prev}" in
*)
COMPREPLY=()
;;
esac
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
;;
my__app__help__test)
fix(help): Do not propagate global args to help This prevents global args from showing in help completions, since help completions should only suggest subcommands. Adds tests to ensure the args still show in the generated help messages of subcommands.
2022-08-27 00:40:48 +00:00
opts=""
feat(complete): Add completion for help subcommands Adds parser flags to toggle whether to run the expensive clone logic for completions case. Help completion will only suggest subcommands, not args. clap_complete generator sets the flag.
2022-08-25 05:44:07 +00:00
if [[ ${cur} == -* || ${COMP_CWORD} -eq 3 ]] ; then
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
fi
case "${prev}" in
*)
COMPREPLY=()
;;
esac
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
;;
test(complete): Switch to snapshot testing - This will make it easier to update - We now uniformly test each shell
2022-03-07 20:03:46 +00:00
my__app__test)
fix!: Require explicit help/version disabling Before we introduced actions, it required specific setups to engage with claps version and help printing. With actions making that more explicit, we don't get as much benefit from our multiple, obscure, ways of users customizing help Before - Modify existing help or version with `mut_arg` which would automatically be pushed down the command tree like `global(true)` - Create an new help or version and have it treated as if it was the built-in on (I think) - Use the same flags as built-in and have the built-in flags automatically disabled - Users could explicitly disable the built-in functionality and do what they want Now - `mut_arg` no longer works as we define help and version flags at the end - If someone defines a flag that overlaps with the built-ins by id, long, or short, a debug assert will tell them to explicitly disable the built-in - Any customization has to be done by a user providing their own. To propagate through the command tree, they need to set `global(true)`. Benefits - Hopefully, this makes it less confusing on how to override help behavior. Someone creates an arg and we then tell them how to disable the built-in - This greatly simplifies the arg handling by pushing more responsibility onto the developer in what are hopefully just corner cases - This removes about 1Kb from .text Fixes #3405 Fixes #4033
2022-08-08 21:08:47 +00:00
opts="-d -c -h --help"
test(complete): Switch to snapshot testing - This will make it easier to update - We now uniformly test each shell
2022-03-07 20:03:46 +00:00
if [[ ${cur} == -* || ${COMP_CWORD} -eq 2 ]] ; then
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
fi
case "${prev}" in
*)
COMPREPLY=()
;;
esac
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
;;
esac
}
fix: Skip nosort option below bash 4.4
2024-01-02 12:31:50 +00:00
if [[ "${BASH_VERSINFO[0]}" -eq 4 && "${BASH_VERSINFO[1]}" -ge 4 || "${BASH_VERSINFO[0]}" -gt 4 ]]; then
complete -F _my-app -o nosort -o bashdefault -o default my-app
else
complete -F _my-app -o bashdefault -o default my-app
fi
Reference in a new issue Copy permalink