fzf: add check for OpenSUSE and OpenBSD packages (#9327)

plugins/fzf/README.md

@@ -1,33 +1,52 @@
 # fzf
 
-This plugin enables [junegunn's fzf](https://github.com/junegunn/fzf) fuzzy auto-completion and key bindings
+This plugin tries to find [junegunn's fzf](https://github.com/junegunn/fzf) based on where
+it's been installed, and enables its fuzzy auto-completion and key bindings.
 
 To use it, add `fzf` to the plugins array in your zshrc file:
+
 ```zsh
 plugins=(... fzf)
 ```
 
 ## Settings
 
-Add these before the `plugins=()` line in your zshrc file:
+All these settings should go in your zshrc file, before Oh My Zsh is sourced.
+
+### `FZF_BASE`
+
+Set to fzf installation directory path:
 
 ```zsh
-# Set fzf installation directory path
+export FZF_BASE=/path/to/fzf/install/dir
-# export FZF_BASE=/path/to/fzf/install/dir
-
-# Uncomment to set the FZF_DEFAULT_COMMAND
-# export FZF_DEFAULT_COMMAND='<your fzf default commmand>'
-
-# Uncomment the following line to disable fuzzy completion
-# DISABLE_FZF_AUTO_COMPLETION="true"
-
-# Uncomment the following line to disable key bindings (CTRL-T, CTRL-R, ALT-C)
-# DISABLE_FZF_KEY_BINDINGS="true"
 ```
 
-| Setting                     | Example value              | Description                                                 |
+### `FZF_DEFAULT_COMMAND`
-|-----------------------------|----------------------------|-------------------------------------------------------------|
+
-| FZF_BASE                    | `/path/to/fzf/install/dir` | Set fzf installation directory path (**export**)            |
+Set default command to use when input is tty:
-| FZF_DEFAULT_COMMAND         | `fd --type f`              | Set default command to use when input is tty (**export**)   |
+
-| DISABLE_FZF_AUTO_COMPLETION | `true`                     | Set whether to load fzf auto-completion                     |
+```zsh
-| DISABLE_FZF_KEY_BINDINGS    | `true`                     | Set whether to disable key bindings (CTRL-T, CTRL-R, ALT-C) |
+export FZF_DEFAULT_COMMAND='<your fzf default commmand>'
+```
+
+If not set, the plugin will try to set it to these, in the order in which they're found:
+
+- [`rg`](https://github.com/BurntSushi/ripgrep)
+- [`fd`](https://github.com/sharkdp/fd)
+- [`ag`](https://github.com/ggreer/the_silver_searcher)
+
+### `DISABLE_FZF_AUTO_COMPLETION`
+
+Set whether to load fzf auto-completion:
+
+```zsh
+DISABLE_FZF_AUTO_COMPLETION="true"
+```
+
+### `DISABLE_FZF_KEY_BINDINGS`
+
+Set whether to disable key bindings (CTRL-T, CTRL-R, ALT-C):
+
+```zsh
+DISABLE_FZF_KEY_BINDINGS="true"
+```

plugins/fzf/fzf.plugin.zsh

@@ -1,9 +1,5 @@
 function setup_using_base_dir() {
-    # Declare all variables local not no mess with outside env in any way
+    local fzf_base fzf_shell fzfdirs dir
-    local fzf_base
-    local fzf_shell
-    local fzfdirs
-    local dir
 
     test -d "${FZF_BASE}" && fzf_base="${FZF_BASE}"
 
@@ -31,7 +27,10 @@ function setup_using_base_dir() {
         fi
     fi
 
-    if [[ -d "${fzf_base}" ]]; then
+    if [[ ! -d "${fzf_base}" ]]; then
+        return 1
+    fi
+
     # Fix fzf shell directory for Arch Linux, NixOS or Void Linux packages
     if [[ ! -d "${fzf_base}/shell" ]]; then
         fzf_shell="${fzf_base}"
@@ -40,29 +39,25 @@ function setup_using_base_dir() {
     fi
 
     # Setup fzf binary path
-        if ! (( ${+commands[fzf]} )) && [[ ! "$PATH" == *$fzf_base/bin* ]]; then
+    if (( ! ${+commands[fzf]} )) && [[ "$PATH" != *$fzf_base/bin* ]]; then
         export PATH="$PATH:$fzf_base/bin"
     fi
 
     # Auto-completion
-        if [[ ! "$DISABLE_FZF_AUTO_COMPLETION" == "true" ]]; then
+    if [[ -o interactive && "$DISABLE_FZF_AUTO_COMPLETION" != "true" ]]; then
-          [[ $- == *i* ]] && source "${fzf_shell}/completion.zsh" 2> /dev/null
+        source "${fzf_shell}/completion.zsh" 2> /dev/null
     fi
 
     # Key bindings
-        if [[ ! "$DISABLE_FZF_KEY_BINDINGS" == "true" ]]; then
+    if [[ "$DISABLE_FZF_KEY_BINDINGS" != "true" ]]; then
         source "${fzf_shell}/key-bindings.zsh"
     fi
-    else
-        return 1
-    fi
 }
 
 
 function setup_using_debian_package() {
-    (( $+commands[dpkg] )) && dpkg -s fzf &> /dev/null
+    if (( ! $+commands[dpkg] )) || ! dpkg -s fzf &>/dev/null; then
-    if (( $? )); then
+        # Either not a debian based distro, or no fzf installed
-        # Either not a debian based distro, or no fzf installed. In any case skip ahead
         return 1
     fi
 
@@ -76,7 +71,7 @@ function setup_using_debian_package() {
     local key_bindings="/usr/share/doc/fzf/examples/key-bindings.zsh"
 
     # Auto-completion
-    if [[ $- == *i* ]] && [[ ! "$DISABLE_FZF_AUTO_COMPLETION" == "true" ]]; then
+    if [[ -o interactive && "$DISABLE_FZF_AUTO_COMPLETION" != "true" ]]; then
         source $completions 2> /dev/null
     fi
 
@@ -88,16 +83,74 @@ function setup_using_debian_package() {
     return 0
 }
 
-function indicate_error() {
+function setup_using_opensuse_package() {
-    print "[oh-my-zsh] fzf plugin: Cannot find fzf installation directory.\n"\
+    # OpenSUSE installs fzf in /usr/bin/fzf
-          "Please add \`export FZF_BASE=/path/to/fzf/install/dir\` to your .zshrc" >&2
+    # If the command is not found, the package isn't installed
+    (( $+commands[fzf] )) || return 1
+
+    # The fzf-zsh-completion package installs the auto-completion in
+    local completions="/usr/share/zsh/site-functions/_fzf"
+    # The fzf-zsh-completion package installs the key-bindings file in
+    local key_bindings="/etc/zsh_completion.d/fzf-key-bindings"
+
+    # If these are not found: (1) maybe we're not on OpenSUSE, or
+    # (2) maybe the fzf-zsh-completion package isn't installed.
+    if [[ ! -f "$completions" || ! -f "$key_bindings" ]]; then
+        return 1
+    fi
+
+    # Auto-completion
+    if [[ -o interactive && "$DISABLE_FZF_AUTO_COMPLETION" != "true" ]]; then
+        source "$completions" 2>/dev/null
+    fi
+
+    # Key bindings
+    if [[ "$DISABLE_FZF_KEY_BINDINGS" != "true" ]]; then
+        source "$key_bindings" 2>/dev/null
+    fi
+
+    return 0
 }
 
-# Check for debian package first, because it easy to short cut
+function setup_using_openbsd_package() {
-# Indicate to user that fzf installation not found if nothing worked
+    # openBSD installs fzf in /usr/local/bin/fzf
-setup_using_debian_package || setup_using_base_dir || indicate_error
+    if [[ "$OSTYPE" != openbsd* ]] || (( ! $+commands[fzf] )); then
+        return 1
+    fi
 
-unset -f setup_using_debian_package setup_using_base_dir indicate_error
+    # The fzf package installs the auto-completion in
+    local completions="/usr/local/share/zsh/site-functions/_fzf_completion"
+    # The fzf package installs the key-bindings file in
+    local key_bindings="/usr/local/share/zsh/site-functions/_fzf_key_bindings"
+
+    # Auto-completion
+    if [[ -o interactive && "$DISABLE_FZF_AUTO_COMPLETION" != "true" ]]; then
+        source "$completions" 2>/dev/null
+    fi
+
+    # Key bindings
+    if [[ "$DISABLE_FZF_KEY_BINDINGS" != "true" ]]; then
+        source "$key_bindings" 2>/dev/null
+    fi
+
+    return 0
+}
+
+function indicate_error() {
+    cat >&2 <<EOF
+[oh-my-zsh] fzf plugin: Cannot find fzf installation directory.
+Please add \`export FZF_BASE=/path/to/fzf/install/dir\` to your .zshrc
+EOF
+}
+
+# Indicate to user that fzf installation not found if nothing worked
+setup_using_openbsd_package \
+    || setup_using_debian_package \
+    || setup_using_opensuse_package \
+    || setup_using_base_dir \
+    || indicate_error
+
+unset -f setup_using_opensuse_package setup_using_debian_package setup_using_base_dir indicate_error
 
 if [[ -z "$FZF_DEFAULT_COMMAND" ]]; then
     if (( $+commands[rg] )); then