commit e7f26208d9214332c47500368647330d9579f80b
parent f2bb7cf1434108e9db85cabcb940f3efa464c01d
Author: Michal Sapka <michal@sapka.me>
Date: Fri, 26 Aug 2022 23:38:51 +0200
feat(fish, gh): add gh completitions
Diffstat:
1 file changed, 176 insertions(+), 0 deletions(-)
diff --git a/fish/.config/fish/completions/gh.fish b/fish/.config/fish/completions/gh.fish
@@ -0,0 +1,176 @@
+# fish completion for gh -*- shell-script -*-
+
+function __gh_debug
+ set -l file "$BASH_COMP_DEBUG_FILE"
+ if test -n "$file"
+ echo "$argv" >> $file
+ end
+end
+
+function __gh_perform_completion
+ __gh_debug "Starting __gh_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))
+
+ __gh_debug "args: $args"
+ __gh_debug "last arg: $lastArg"
+
+ set -l requestComp "$args[1] __complete $args[2..-1] $lastArg"
+
+ __gh_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")
+
+ __gh_debug "Comps: $comps"
+ __gh_debug "DirectiveLine: $directiveLine"
+ __gh_debug "flagPrefix: $flagPrefix"
+
+ for comp in $comps
+ printf "%s%s\n" "$flagPrefix" "$comp"
+ end
+
+ printf "%s\n" "$directiveLine"
+end
+
+# This function does two things:
+# - Obtain the completions and store them in the global __gh_comp_results
+# - Return false if file completion should be performed
+function __gh_prepare_completions
+ __gh_debug ""
+ __gh_debug "========= starting completion logic =========="
+
+ # Start fresh
+ set --erase __gh_comp_results
+
+ set -l results (__gh_perform_completion)
+ __gh_debug "Completion results: $results"
+
+ if test -z "$results"
+ __gh_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 $results[-1])
+ set --global __gh_comp_results $results[1..-2]
+
+ __gh_debug "Completions are: $__gh_comp_results"
+ __gh_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
+ __gh_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
+ __gh_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)
+
+ __gh_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)
+ __gh_debug "prefix: $prefix"
+
+ set -l completions (string match -r -- "^$prefix.*" $__gh_comp_results)
+ set --global __gh_comp_results $completions
+ __gh_debug "Filtered completions are: $__gh_comp_results"
+
+ # Important not to quote the variable for count to work
+ set -l numComps (count $__gh_comp_results)
+ __gh_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 $__gh_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.
+ __gh_debug "Adding second completion to perform nospace directive"
+ set --global __gh_comp_results $split[1] $split[1].
+ __gh_debug "Completions are now: $__gh_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
+ __gh_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 "gh"
+ # 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 "gh " > /dev/null 2>&1
+end
+
+# Remove any pre-existing completions for the program since we will be handling all of them.
+complete -c gh -e
+
+# The call to __gh_prepare_completions will setup __gh_comp_results
+# which provides the program's completion choices.
+complete -c gh -n '__gh_prepare_completions' -f -a '$__gh_comp_results'
+
