Merge branch 'stable'

Author: mpilgrem

doc/shell_autocompletion.md

@@ -2,69 +2,69 @@
 
 # Shell auto-completion
 
-The following adds support for the tab completion of standard Stack arguments in
-the Bash shell or the Z shell (Zsh). Completion of file names and executables
-within Stack is still lacking. For further information, see issue
+The following adds support for the tab completion of standard Stack arguments to
+the following shell programs: Bash, Zsh (the Z shell) and fish. Completion of
+file names and executables within Stack is still lacking. For further
+information, see issue
 [#823](https://github.com/commercialhaskell/stack/issues/832).
 
-=== "Bash"
+!!! info
 
-    Issue the following command or add it to your `~/.bashrc` file:
+    Stack's completion library provides
+    [hidden options](https://github.com/pcapriotti/optparse-applicative#bash-zsh-and-fish-completions)
+    for Bash, Zsh, and fish which output commands used for shell
+    auto-completion. For example:
 
     ~~~bash
-    eval "$(stack --bash-completion-script stack)"
-    ~~~
+    $ stack --bash-completion-script stack
+    _stack()
+    {
+        local CMDLINE
+        local IFS=$'\n'
+        CMDLINE=(--bash-completion-index $COMP_CWORD)
 
-    !!! info
+        for arg in ${COMP_WORDS[@]}; do
+            CMDLINE=(${CMDLINE[@]} --bash-completion-word $arg)
+        done
 
-        Stack's hidden option `--bash-completion-script <stack_executable_name>`
-        outputs a command that can be evaluated by Bash. For example:
+        COMPREPLY=( $(stack "${CMDLINE[@]}") )
+    }
 
-        ~~~text
-        stack --bash-completion-script stack
-        _stack.exe()
-        {
-            local CMDLINE
-            local IFS=$'\n'
-            CMDLINE=(--bash-completion-index $COMP_CWORD)
+    complete -o filenames -F _stack stack
+    ~~~
 
-            for arg in ${COMP_WORDS[@]}; do
-                CMDLINE=(${CMDLINE[@]} --bash-completion-word $arg)
-            done
+=== "Bash"
 
-            COMPREPLY=( $(stack "${CMDLINE[@]}") )
-        }
-        ~~~
+    Add the output of the following command to your preferred completions file
+    (e.g. `~/.config/bash_completions.d/stack`).
 
-=== "Zsh"
+    ~~~bash
+    stack --bash-completion-script $(which stack)
+    ~~~
 
-    The Zsh
-    [manual](https://zsh.sourceforge.io/Doc/Release/Completion-System.html#Completion-System)
-    explains:
+    You may need to `source` this.
 
-    > The function `bashcompinit` provides compatibility with bash’s
-    programmable completion system. When run it will define the functions,
-    `compgen` and `complete` which correspond to the bash builtins with the same
-    names. It will then be possible to use completion specifications and
-    functions written for bash.
+=== "Zsh"
 
-    Consequently, you must:
+    Add the output of the following command to your preferred completions file
+    (e.g. `~/.config/zsh/completions/_stack`).
 
-    1.  launch `compinint`
-    2.  launch `bashcompinit`
-    3.  eval Stack's Bash completion script
+    ~~~zsh
+    stack --zsh-completion-script $(which stack)
+    ~~~
 
-    Issue the following commands or that them to your `~/.zshrc` file:
+    You won't need to `source` this, but do update your `fpath`:
 
     ~~~zsh
-    autoload -U +X compinit
-    compinit
-    autoload -U +X bashcompinit
-    bashcompinit
-    eval "$(stack --bash-completion-script stack)"
+    fpath=($HOME/.config/zsh/completions $fpath)
+    autoload -U compinit && compinit
     ~~~
 
-    !!! info
+=== "fish"
+
+    Add the output of the following command to your preferred completions file
+    (e.g. `~/.config/fish/completions/stack.fish`).
 
-        If you already have quite a large `.zshrc` file, or if you use
-        `oh-my-zsh`, `compinit` will probably already be loaded.
+    ~~~fish
+    stack --fish-completion-script $(which stack)
+    ~~~