Added shell completion for K9S and Yazi

This commit is contained in:
Fabio Scotto di Santolo
2024-08-15 15:09:13 +02:00
parent 08726961ab
commit 56395b5f8d
3 changed files with 296 additions and 0 deletions

View File

@@ -0,0 +1,235 @@
# fish completion for k9s -*- shell-script -*-
function __k9s_debug
set -l file "$BASH_COMP_DEBUG_FILE"
if test -n "$file"
echo "$argv" >> $file
end
end
function __k9s_perform_completion
__k9s_debug "Starting __k9s_perform_completion"
# Extract all args except the last one
set -l args (commandline -opc)
# Extract the last arg and escape it in case it is a space
set -l lastArg (string escape -- (commandline -ct))
__k9s_debug "args: $args"
__k9s_debug "last arg: $lastArg"
# Disable ActiveHelp which is not supported for fish shell
set -l requestComp "K9S_ACTIVE_HELP=0 $args[1] __complete $args[2..-1] $lastArg"
__k9s_debug "Calling $requestComp"
set -l results (eval $requestComp 2> /dev/null)
# Some programs may output extra empty lines after the directive.
# Let's ignore them or else it will break completion.
# Ref: https://github.com/spf13/cobra/issues/1279
for line in $results[-1..1]
if test (string trim -- $line) = ""
# Found an empty line, remove it
set results $results[1..-2]
else
# Found non-empty line, we have our proper output
break
end
end
set -l comps $results[1..-2]
set -l directiveLine $results[-1]
# For Fish, when completing a flag with an = (e.g., <program> -n=<TAB>)
# completions must be prefixed with the flag
set -l flagPrefix (string match -r -- '-.*=' "$lastArg")
__k9s_debug "Comps: $comps"
__k9s_debug "DirectiveLine: $directiveLine"
__k9s_debug "flagPrefix: $flagPrefix"
for comp in $comps
printf "%s%s\n" "$flagPrefix" "$comp"
end
printf "%s\n" "$directiveLine"
end
# this function limits calls to __k9s_perform_completion, by caching the result behind $__k9s_perform_completion_once_result
function __k9s_perform_completion_once
__k9s_debug "Starting __k9s_perform_completion_once"
if test -n "$__k9s_perform_completion_once_result"
__k9s_debug "Seems like a valid result already exists, skipping __k9s_perform_completion"
return 0
end
set --global __k9s_perform_completion_once_result (__k9s_perform_completion)
if test -z "$__k9s_perform_completion_once_result"
__k9s_debug "No completions, probably due to a failure"
return 1
end
__k9s_debug "Performed completions and set __k9s_perform_completion_once_result"
return 0
end
# this function is used to clear the $__k9s_perform_completion_once_result variable after completions are run
function __k9s_clear_perform_completion_once_result
__k9s_debug ""
__k9s_debug "========= clearing previously set __k9s_perform_completion_once_result variable =========="
set --erase __k9s_perform_completion_once_result
__k9s_debug "Successfully erased the variable __k9s_perform_completion_once_result"
end
function __k9s_requires_order_preservation
__k9s_debug ""
__k9s_debug "========= checking if order preservation is required =========="
__k9s_perform_completion_once
if test -z "$__k9s_perform_completion_once_result"
__k9s_debug "Error determining if order preservation is required"
return 1
end
set -l directive (string sub --start 2 $__k9s_perform_completion_once_result[-1])
__k9s_debug "Directive is: $directive"
set -l shellCompDirectiveKeepOrder 32
set -l keeporder (math (math --scale 0 $directive / $shellCompDirectiveKeepOrder) % 2)
__k9s_debug "Keeporder is: $keeporder"
if test $keeporder -ne 0
__k9s_debug "This does require order preservation"
return 0
end
__k9s_debug "This doesn't require order preservation"
return 1
end
# This function does two things:
# - Obtain the completions and store them in the global __k9s_comp_results
# - Return false if file completion should be performed
function __k9s_prepare_completions
__k9s_debug ""
__k9s_debug "========= starting completion logic =========="
# Start fresh
set --erase __k9s_comp_results
__k9s_perform_completion_once
__k9s_debug "Completion results: $__k9s_perform_completion_once_result"
if test -z "$__k9s_perform_completion_once_result"
__k9s_debug "No completion, probably due to a failure"
# Might as well do file completion, in case it helps
return 1
end
set -l directive (string sub --start 2 $__k9s_perform_completion_once_result[-1])
set --global __k9s_comp_results $__k9s_perform_completion_once_result[1..-2]
__k9s_debug "Completions are: $__k9s_comp_results"
__k9s_debug "Directive is: $directive"
set -l shellCompDirectiveError 1
set -l shellCompDirectiveNoSpace 2
set -l shellCompDirectiveNoFileComp 4
set -l shellCompDirectiveFilterFileExt 8
set -l shellCompDirectiveFilterDirs 16
if test -z "$directive"
set directive 0
end
set -l compErr (math (math --scale 0 $directive / $shellCompDirectiveError) % 2)
if test $compErr -eq 1
__k9s_debug "Received error directive: aborting."
# Might as well do file completion, in case it helps
return 1
end
set -l filefilter (math (math --scale 0 $directive / $shellCompDirectiveFilterFileExt) % 2)
set -l dirfilter (math (math --scale 0 $directive / $shellCompDirectiveFilterDirs) % 2)
if test $filefilter -eq 1; or test $dirfilter -eq 1
__k9s_debug "File extension filtering or directory filtering not supported"
# Do full file completion instead
return 1
end
set -l nospace (math (math --scale 0 $directive / $shellCompDirectiveNoSpace) % 2)
set -l nofiles (math (math --scale 0 $directive / $shellCompDirectiveNoFileComp) % 2)
__k9s_debug "nospace: $nospace, nofiles: $nofiles"
# If we want to prevent a space, or if file completion is NOT disabled,
# we need to count the number of valid completions.
# To do so, we will filter on prefix as the completions we have received
# may not already be filtered so as to allow fish to match on different
# criteria than the prefix.
if test $nospace -ne 0; or test $nofiles -eq 0
set -l prefix (commandline -t | string escape --style=regex)
__k9s_debug "prefix: $prefix"
set -l completions (string match -r -- "^$prefix.*" $__k9s_comp_results)
set --global __k9s_comp_results $completions
__k9s_debug "Filtered completions are: $__k9s_comp_results"
# Important not to quote the variable for count to work
set -l numComps (count $__k9s_comp_results)
__k9s_debug "numComps: $numComps"
if test $numComps -eq 1; and test $nospace -ne 0
# We must first split on \t to get rid of the descriptions to be
# able to check what the actual completion will be.
# We don't need descriptions anyway since there is only a single
# real completion which the shell will expand immediately.
set -l split (string split --max 1 \t $__k9s_comp_results[1])
# Fish won't add a space if the completion ends with any
# of the following characters: @=/:.,
set -l lastChar (string sub -s -1 -- $split)
if not string match -r -q "[@=/:.,]" -- "$lastChar"
# In other cases, to support the "nospace" directive we trick the shell
# by outputting an extra, longer completion.
__k9s_debug "Adding second completion to perform nospace directive"
set --global __k9s_comp_results $split[1] $split[1].
__k9s_debug "Completions are now: $__k9s_comp_results"
end
end
if test $numComps -eq 0; and test $nofiles -eq 0
# To be consistent with bash and zsh, we only trigger file
# completion when there are no other completions
__k9s_debug "Requesting file completion"
return 1
end
end
return 0
end
# Since Fish completions are only loaded once the user triggers them, we trigger them ourselves
# so we can properly delete any completions provided by another script.
# Only do this if the program can be found, or else fish may print some errors; besides,
# the existing completions will only be loaded if the program can be found.
if type -q "k9s"
# The space after the program name is essential to trigger completion for the program
# and not completion of the program name itself.
# Also, we use '> /dev/null 2>&1' since '&>' is not supported in older versions of fish.
complete --do-complete "k9s " > /dev/null 2>&1
end
# Remove any pre-existing completions for the program since we will be handling all of them.
complete -c k9s -e
# this will get called after the two calls below and clear the $__k9s_perform_completion_once_result global
complete -c k9s -n '__k9s_clear_perform_completion_once_result'
# The call to __k9s_prepare_completions will setup __k9s_comp_results
# which provides the program's completion choices.
# If this doesn't require order preservation, we don't use the -k flag
complete -c k9s -n 'not __k9s_requires_order_preservation && __k9s_prepare_completions' -f -a '$__k9s_comp_results'
# otherwise we use the -k flag
complete -k -c k9s -n '__k9s_requires_order_preservation && __k9s_prepare_completions' -f -a '$__k9s_comp_results'

View File

@@ -0,0 +1,52 @@
# Print an optspec for argparse to handle cmd's options that are independent of any subcommand.
function __fish_ya_global_optspecs
string join \n V/version h/help
end
function __fish_ya_needs_command
# Figure out if the current invocation already has a command.
set -l cmd (commandline -opc)
set -e cmd[1]
argparse -s (__fish_ya_global_optspecs) -- $cmd 2>/dev/null
or return
if set -q argv[1]
# Also print the command, so this can be used to figure out what it is.
echo $argv[1]
return 1
end
return 0
end
function __fish_ya_using_subcommand
set -l cmd (__fish_ya_needs_command)
test -z "$cmd"
and return 1
contains -- $cmd[1] $argv
end
complete -c ya -n "__fish_ya_needs_command" -s V -l version -d 'Print version'
complete -c ya -n "__fish_ya_needs_command" -s h -l help -d 'Print help'
complete -c ya -n "__fish_ya_needs_command" -f -a "pub" -d 'Publish a message to the current instance'
complete -c ya -n "__fish_ya_needs_command" -f -a "pub-to" -d 'Publish a message to the specified instance'
complete -c ya -n "__fish_ya_needs_command" -f -a "sub" -d 'Subscribe to messages from all remote instances'
complete -c ya -n "__fish_ya_needs_command" -f -a "pack" -d 'Manage packages'
complete -c ya -n "__fish_ya_needs_command" -f -a "help" -d 'Print this message or the help of the given subcommand(s)'
complete -c ya -n "__fish_ya_using_subcommand pub" -l str -d 'Send the message with a string body' -r
complete -c ya -n "__fish_ya_using_subcommand pub" -l json -d 'Send the message with a JSON body' -r
complete -c ya -n "__fish_ya_using_subcommand pub" -l list -d 'Send the message as string of list' -r
complete -c ya -n "__fish_ya_using_subcommand pub" -s h -l help -d 'Print help'
complete -c ya -n "__fish_ya_using_subcommand pub-to" -l str -d 'Send the message with a string body' -r
complete -c ya -n "__fish_ya_using_subcommand pub-to" -l json -d 'Send the message with a JSON body' -r
complete -c ya -n "__fish_ya_using_subcommand pub-to" -l list -d 'Send the message as string of list' -r
complete -c ya -n "__fish_ya_using_subcommand pub-to" -s h -l help -d 'Print help'
complete -c ya -n "__fish_ya_using_subcommand sub" -s h -l help -d 'Print help'
complete -c ya -n "__fish_ya_using_subcommand pack" -s a -l add -d 'Add a package' -r
complete -c ya -n "__fish_ya_using_subcommand pack" -s i -l install -d 'Install all packages'
complete -c ya -n "__fish_ya_using_subcommand pack" -s l -l list -d 'List all packages'
complete -c ya -n "__fish_ya_using_subcommand pack" -s u -l upgrade -d 'Upgrade all packages'
complete -c ya -n "__fish_ya_using_subcommand pack" -s h -l help -d 'Print help'
complete -c ya -n "__fish_ya_using_subcommand help; and not __fish_seen_subcommand_from pub pub-to sub pack help" -f -a "pub" -d 'Publish a message to the current instance'
complete -c ya -n "__fish_ya_using_subcommand help; and not __fish_seen_subcommand_from pub pub-to sub pack help" -f -a "pub-to" -d 'Publish a message to the specified instance'
complete -c ya -n "__fish_ya_using_subcommand help; and not __fish_seen_subcommand_from pub pub-to sub pack help" -f -a "sub" -d 'Subscribe to messages from all remote instances'
complete -c ya -n "__fish_ya_using_subcommand help; and not __fish_seen_subcommand_from pub pub-to sub pack help" -f -a "pack" -d 'Manage packages'
complete -c ya -n "__fish_ya_using_subcommand help; and not __fish_seen_subcommand_from pub pub-to sub pack help" -f -a "help" -d 'Print this message or the help of the given subcommand(s)'

View File

@@ -0,0 +1,9 @@
complete -c yazi -l cwd-file -d 'Write the cwd on exit to this file' -r -F
complete -c yazi -l chooser-file -d 'Write the selected files to this file on open fired' -r -F
complete -c yazi -l client-id -d 'Use the specified client ID, must be a globally unique number' -r
complete -c yazi -l local-events -d 'Report the specified local events to stdout' -r
complete -c yazi -l remote-events -d 'Report the specified remote events to stdout' -r
complete -c yazi -l clear-cache -d 'Clear the cache directory'
complete -c yazi -l debug -d 'Print debug information'
complete -c yazi -s V -l version -d 'Print version'
complete -c yazi -s h -l help -d 'Print help'