feat(fish): install completions

Amolith created

Change summary

dot_config/private_fish/completions/bin.fish  | 235 +++++++++++++++++++++
dot_config/private_fish/completions/just.fish |  86 +++++++
dot_config/private_fish/completions/task.fish |  55 ++++
3 files changed, 376 insertions(+)

Detailed changes

dot_config/private_fish/completions/bin.fish 🔗

@@ -0,0 +1,235 @@
+# fish completion for bin                                  -*- shell-script -*-
+
+function __bin_debug
+    set -l file "$BASH_COMP_DEBUG_FILE"
+    if test -n "$file"
+        echo "$argv" >> $file
+    end
+end
+
+function __bin_perform_completion
+    __bin_debug "Starting __bin_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))
+
+    __bin_debug "args: $args"
+    __bin_debug "last arg: $lastArg"
+
+    # Disable ActiveHelp which is not supported for fish shell
+    set -l requestComp "BIN_ACTIVE_HELP=0 $args[1] __complete $args[2..-1] $lastArg"
+
+    __bin_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")
+
+    __bin_debug "Comps: $comps"
+    __bin_debug "DirectiveLine: $directiveLine"
+    __bin_debug "flagPrefix: $flagPrefix"
+
+    for comp in $comps
+        printf "%s%s\n" "$flagPrefix" "$comp"
+    end
+
+    printf "%s\n" "$directiveLine"
+end
+
+# this function limits calls to __bin_perform_completion, by caching the result behind $__bin_perform_completion_once_result
+function __bin_perform_completion_once
+    __bin_debug "Starting __bin_perform_completion_once"
+
+    if test -n "$__bin_perform_completion_once_result"
+        __bin_debug "Seems like a valid result already exists, skipping __bin_perform_completion"
+        return 0
+    end
+
+    set --global __bin_perform_completion_once_result (__bin_perform_completion)
+    if test -z "$__bin_perform_completion_once_result"
+        __bin_debug "No completions, probably due to a failure"
+        return 1
+    end
+
+    __bin_debug "Performed completions and set __bin_perform_completion_once_result"
+    return 0
+end
+
+# this function is used to clear the $__bin_perform_completion_once_result variable after completions are run
+function __bin_clear_perform_completion_once_result
+    __bin_debug ""
+    __bin_debug "========= clearing previously set __bin_perform_completion_once_result variable =========="
+    set --erase __bin_perform_completion_once_result
+    __bin_debug "Successfully erased the variable __bin_perform_completion_once_result"
+end
+
+function __bin_requires_order_preservation
+    __bin_debug ""
+    __bin_debug "========= checking if order preservation is required =========="
+
+    __bin_perform_completion_once
+    if test -z "$__bin_perform_completion_once_result"
+        __bin_debug "Error determining if order preservation is required"
+        return 1
+    end
+
+    set -l directive (string sub --start 2 $__bin_perform_completion_once_result[-1])
+    __bin_debug "Directive is: $directive"
+
+    set -l shellCompDirectiveKeepOrder 32
+    set -l keeporder (math (math --scale 0 $directive / $shellCompDirectiveKeepOrder) % 2)
+    __bin_debug "Keeporder is: $keeporder"
+
+    if test $keeporder -ne 0
+        __bin_debug "This does require order preservation"
+        return 0
+    end
+
+    __bin_debug "This doesn't require order preservation"
+    return 1
+end
+
+
+# This function does two things:
+# - Obtain the completions and store them in the global __bin_comp_results
+# - Return false if file completion should be performed
+function __bin_prepare_completions
+    __bin_debug ""
+    __bin_debug "========= starting completion logic =========="
+
+    # Start fresh
+    set --erase __bin_comp_results
+
+    __bin_perform_completion_once
+    __bin_debug "Completion results: $__bin_perform_completion_once_result"
+
+    if test -z "$__bin_perform_completion_once_result"
+        __bin_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 $__bin_perform_completion_once_result[-1])
+    set --global __bin_comp_results $__bin_perform_completion_once_result[1..-2]
+
+    __bin_debug "Completions are: $__bin_comp_results"
+    __bin_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
+        __bin_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
+        __bin_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)
+
+    __bin_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)
+        __bin_debug "prefix: $prefix"
+
+        set -l completions (string match -r -- "^$prefix.*" $__bin_comp_results)
+        set --global __bin_comp_results $completions
+        __bin_debug "Filtered completions are: $__bin_comp_results"
+
+        # Important not to quote the variable for count to work
+        set -l numComps (count $__bin_comp_results)
+        __bin_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 $__bin_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.
+                __bin_debug "Adding second completion to perform nospace directive"
+                set --global __bin_comp_results $split[1] $split[1].
+                __bin_debug "Completions are now: $__bin_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
+            __bin_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 "bin"
+    # 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 "bin " > /dev/null 2>&1
+end
+
+# Remove any pre-existing completions for the program since we will be handling all of them.
+complete -c bin -e
+
+# this will get called after the two calls below and clear the $__bin_perform_completion_once_result global
+complete -c bin -n '__bin_clear_perform_completion_once_result'
+# The call to __bin_prepare_completions will setup __bin_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 bin -n 'not __bin_requires_order_preservation && __bin_prepare_completions' -f -a '$__bin_comp_results'
+# otherwise we use the -k flag
+complete -k -c bin -n '__bin_requires_order_preservation && __bin_prepare_completions' -f -a '$__bin_comp_results'

dot_config/private_fish/completions/just.fish 🔗

@@ -0,0 +1,86 @@
+function __fish_just_complete_recipes
+        if string match -rq '(-f|--justfile)\s*=?(?<justfile>[^\s]+)' -- (string split -- ' -- ' (commandline -pc))[1]
+          set -fx JUST_JUSTFILE "$justfile"
+        end
+        printf "%s\n" (string split " " (just --summary))
+end
+
+# don't suggest files right off
+complete -c just -n "__fish_is_first_arg" --no-files
+
+# complete recipes
+complete -c just -a '(__fish_just_complete_recipes)'
+
+# autogenerated completions
+complete -c just -l alias-style -d 'Set list command alias display style' -r -f -a "left\t''
+right\t''
+separate\t''"
+complete -c just -l ceiling -d 'Do not ascend above <CEILING> directory when searching for a justfile.' -r -F
+complete -c just -l chooser -d 'Override binary invoked by `--choose`' -r
+complete -c just -l color -d 'Print colorful output' -r -f -a "always\t''
+auto\t''
+never\t''"
+complete -c just -l command-color -d 'Echo recipe lines in <COMMAND-COLOR>' -r -f -a "black\t''
+blue\t''
+cyan\t''
+green\t''
+purple\t''
+red\t''
+yellow\t''"
+complete -c just -l cygpath -d 'Use binary at <CYGPATH> to convert between unix and Windows paths.' -r -F
+complete -c just -l dotenv-filename -d 'Search for environment file named <DOTENV-FILENAME> instead of `.env`' -r
+complete -c just -s E -l dotenv-path -d 'Load <DOTENV-PATH> as environment file instead of searching for one' -r -F
+complete -c just -l dump-format -d 'Dump justfile as <FORMAT>' -r -f -a "json\t''
+just\t''"
+complete -c just -s f -l justfile -d 'Use <JUSTFILE> as justfile' -r -F
+complete -c just -l list-heading -d 'Print <TEXT> before list' -r
+complete -c just -l list-prefix -d 'Print <TEXT> before each list item' -r
+complete -c just -l set -d 'Override <VARIABLE> with <VALUE>' -r
+complete -c just -l shell -d 'Invoke <SHELL> to run recipes' -r
+complete -c just -l shell-arg -d 'Invoke shell with <SHELL-ARG> as an argument' -r
+complete -c just -l tempdir -d 'Save temporary files to <TEMPDIR>.' -r -F
+complete -c just -l timestamp-format -d 'Timestamp format string' -r
+complete -c just -s d -l working-directory -d 'Use <WORKING-DIRECTORY> as working directory. --justfile must also be set' -r -F
+complete -c just -s c -l command -d 'Run an arbitrary command with the working directory, `.env`, overrides, and exports set' -r
+complete -c just -l completions -d 'Print shell completion script for <SHELL>' -r -f -a "bash\t''
+elvish\t''
+fish\t''
+nushell\t''
+powershell\t''
+zsh\t''"
+complete -c just -s l -l list -d 'List available recipes in <MODULE> or root if omitted' -r
+complete -c just -l request -d 'Execute <REQUEST>. For internal testing purposes only. May be changed or removed at any time.' -r
+complete -c just -s s -l show -d 'Show recipe at <PATH>' -r
+complete -c just -l check -d 'Run `--fmt` in \'check\' mode. Exits with 0 if justfile is formatted correctly. Exits with 1 and prints a diff if formatting is required.'
+complete -c just -l clear-shell-args -d 'Clear shell arguments'
+complete -c just -s n -l dry-run -d 'Print what just would do without doing it'
+complete -c just -l explain -d 'Print recipe doc comment before running it'
+complete -c just -s g -l global-justfile -d 'Use global justfile'
+complete -c just -l highlight -d 'Highlight echoed recipe lines in bold'
+complete -c just -l list-submodules -d 'List recipes in submodules'
+complete -c just -l no-aliases -d 'Don\'t show aliases in list'
+complete -c just -l no-deps -d 'Don\'t run recipe dependencies'
+complete -c just -l no-dotenv -d 'Don\'t load `.env` file'
+complete -c just -l no-highlight -d 'Don\'t highlight echoed recipe lines in bold'
+complete -c just -l one -d 'Forbid multiple recipes from being invoked on the command line'
+complete -c just -s q -l quiet -d 'Suppress all output'
+complete -c just -l allow-missing -d 'Ignore missing recipe and module errors'
+complete -c just -l shell-command -d 'Invoke <COMMAND> with the shell used to run recipe lines and backticks'
+complete -c just -l timestamp -d 'Print recipe command timestamps'
+complete -c just -s u -l unsorted -d 'Return list and summary entries in source order'
+complete -c just -l unstable -d 'Enable unstable features'
+complete -c just -s v -l verbose -d 'Use verbose output'
+complete -c just -l yes -d 'Automatically confirm all recipes.'
+complete -c just -l changelog -d 'Print changelog'
+complete -c just -l choose -d 'Select one or more recipes to run using a binary chooser. If `--chooser` is not passed the chooser defaults to the value of $JUST_CHOOSER, falling back to `fzf`'
+complete -c just -l dump -d 'Print justfile'
+complete -c just -s e -l edit -d 'Edit justfile with editor given by $VISUAL or $EDITOR, falling back to `vim`'
+complete -c just -l evaluate -d 'Evaluate and print all variables. If a variable name is given as an argument, only print that variable\'s value.'
+complete -c just -l fmt -d 'Format and overwrite justfile'
+complete -c just -l groups -d 'List recipe groups'
+complete -c just -l init -d 'Initialize new justfile in project root'
+complete -c just -l man -d 'Print man page'
+complete -c just -l summary -d 'List names of available recipes'
+complete -c just -l variables -d 'List names of variables'
+complete -c just -s h -l help -d 'Print help'
+complete -c just -s V -l version -d 'Print version'

dot_config/private_fish/completions/task.fish 🔗

@@ -0,0 +1,55 @@
+set -l GO_TASK_PROGNAME task
+
+function __task_get_tasks --description "Prints all available tasks with their description" --inherit-variable GO_TASK_PROGNAME
+  # Check if the global task is requested
+  set -l global_task false
+  commandline --current-process | read --tokenize --list --local cmd_args
+  for arg in $cmd_args
+    if test "_$arg" = "_--"
+      break # ignore arguments to be passed to the task
+    end
+    if test "_$arg" = "_--global" -o "_$arg" = "_-g"
+      set global_task true
+      break
+    end
+  end
+
+  # Read the list of tasks (and potential errors)
+  if $global_task
+    $GO_TASK_PROGNAME --global --list-all
+  else
+    $GO_TASK_PROGNAME --list-all
+  end 2>&1 | read -lz rawOutput
+
+  # Return on non-zero exit code (for cases when there is no Taskfile found or etc.)
+  if test $status -ne 0
+    return
+  end
+
+  # Grab names and descriptions (if any) of the tasks
+  set -l output (echo $rawOutput | sed -e '1d; s/\* \(.*\):\s*\(.*\)\s*(\(aliases.*\))/\1\t\2\t\3/' -e 's/\* \(.*\):\s*\(.*\)/\1\t\2/'| string split0)
+  if test $output
+    echo $output
+  end
+end
+
+complete -c $GO_TASK_PROGNAME -d 'Runs the specified task(s). Falls back to the "default" task if no task name was specified, or lists all tasks if an unknown task name was
+specified.' -xa "(__task_get_tasks)"
+
+complete -c $GO_TASK_PROGNAME -s c -l color     -d 'colored output (default true)'
+complete -c $GO_TASK_PROGNAME -s d -l dir       -d 'sets directory of execution'
+complete -c $GO_TASK_PROGNAME      -l dry       -d 'compiles and prints tasks in the order that they would be run, without executing them'
+complete -c $GO_TASK_PROGNAME -s f -l force     -d 'forces execution even when the task is up-to-date'
+complete -c $GO_TASK_PROGNAME -s h -l help      -d 'shows Task usage'
+complete -c $GO_TASK_PROGNAME -s i -l init      -d 'creates a new Taskfile.yml in the current folder'
+complete -c $GO_TASK_PROGNAME -s l -l list      -d 'lists tasks with description of current Taskfile'
+complete -c $GO_TASK_PROGNAME -s o -l output    -d 'sets output style: [interleaved|group|prefixed]' -xa "interleaved group prefixed"
+complete -c $GO_TASK_PROGNAME -s p -l parallel  -d 'executes tasks provided on command line in parallel'
+complete -c $GO_TASK_PROGNAME -s s -l silent    -d 'disables echoing'
+complete -c $GO_TASK_PROGNAME      -l status    -d 'exits with non-zero exit code if any of the given tasks is not up-to-date'
+complete -c $GO_TASK_PROGNAME      -l summary   -d 'show summary about a task'
+complete -c $GO_TASK_PROGNAME -s t -l taskfile  -d 'choose which Taskfile to run. Defaults to "Taskfile.yml"'
+complete -c $GO_TASK_PROGNAME -s v -l verbose   -d 'enables verbose mode'
+complete -c $GO_TASK_PROGNAME      -l version   -d 'show Task version'
+complete -c $GO_TASK_PROGNAME -s w -l watch     -d 'enables watch of the given task'
+