Merge pull request #1118 from scop/feat/env

feat(env): complete commands and variable assignments

Author: scop

bash_completion

@@ -2201,7 +2201,7 @@ _comp_realcommand()
 {
     REPLY=""
     local file
-    file=$(type -P "$1") || return $?
+    file=$(type -P -- "$1") || return $?
     if type -p realpath >/dev/null; then
         REPLY=$(realpath "$file")
     elif type -p greadlink >/dev/null; then
@@ -2991,7 +2991,7 @@ _comp_complete_longopt()
 # makeinfo and texi2dvi are defined elsewhere.
 complete -F _comp_complete_longopt \
     a2ps awk base64 bash bc bison cat chroot colordiff cp \
-    csplit cut date df diff dir du enscript env expand fmt fold gperf \
+    csplit cut date df diff dir du enscript expand fmt fold gperf \
     grep grub head irb ld ldd less ln ls m4 mkdir mkfifo mknod \
     mv netstat nl nm objcopy objdump od paste pr ptx readelf rm rmdir \
     sed seq shar sort split strip sum tac tail tee \
@@ -3153,7 +3153,7 @@ _comp_load()
 
     # Resolve absolute path to $cmd
     local REPLY pathcmd origcmd=$cmd
-    if pathcmd=$(type -P "$cmd"); then
+    if pathcmd=$(type -P -- "$cmd"); then
         _comp_abspath "$pathcmd"
         cmd=$REPLY
     fi

completions/Makefile.am

@@ -100,6 +100,7 @@ bashcomp_DATA = 2to3 \
 		ebtables \
 		ecryptfs-migrate-home \
 		_eject \
+		env \
 		eog \
 		ether-wake \
 		evince \

completions/env

@@ -0,0 +1,56 @@
+# bash completion for env(1)                              -*- shell-script -*-
+
+_comp_cmd_env()
+{
+    local cur prev words cword was_split comp_args
+    _comp_initialize -s -- "$@" || return
+
+    local i noargopts='!(-*|*[uCS]*)'
+    for ((i = 1; i <= cword; i++)); do
+        if [[ ${words[i]} != -* || ${words[i]} == -?(-) && i -lt cword ]]; then
+            [[ ${words[i]} == -?(-) ]] && ((i++))
+            for (( ; i <= cword; i++)); do
+                if [[ ${words[i]} != *=* ]]; then
+                    _comp_command_offset "$i"
+                    return
+                fi
+            done
+            break
+        fi
+
+        # shellcheck disable=SC2254
+        [[ ${words[i]} == @(--@(unset|chdir|split-string)|-${noargopts}[uCS]) ]] &&
+            ((i++))
+    done
+
+    # shellcheck disable=SC2254
+    case "$prev" in
+        --unset | -${noargopts}u)
+            _comp_compgen -- -A variable
+            return
+            ;;
+        --chdir | -${noargopts}C)
+            _comp_compgen_filedir -d
+            return
+            ;;
+        --split-string | -${noargopts}S)
+            return
+            ;;
+        --block-signal | --default-signal | --ignore-signal)
+            # TODO signals, but only if completing with a =SIG
+            ;;
+    esac
+
+    [[ $was_split ]] && return
+
+    _comp_variable_assignments "$cur" && return
+
+    if [[ $cur == -* ]]; then
+        _comp_compgen_help || _comp_compgen_usage
+        [[ ${COMPREPLY-} == *= ]] && compopt -o nospace
+        return
+    fi
+} &&
+    complete -F _comp_cmd_env env
+
+# ex: filetype=sh

test/t/test_env.py

@@ -1,7 +1,44 @@
 import pytest
 
+from conftest import assert_complete
+
 
 class TestEnv:
     @pytest.mark.complete("env --", require_longopt=True)
     def test_1(self, completion):
         assert completion
+
+    @pytest.mark.complete("env __unknown_variable__=")
+    def test_unknown_variable_falls_back_to_filedir(self, completion):
+        assert "shared/" in completion
+
+    @pytest.mark.complete("env LANG=", xfail="! locale -a &>/dev/null")
+    def test_lang_envvar(self, completion):
+        assert any(x == "C" or x.startswith("C.") for x in completion)
+
+    @pytest.mark.parametrize(
+        "opts",
+        [
+            "",
+            "foo=bar",
+            "--debug",
+            "--debug foo=bar",
+            "-",
+            "- foo=bar",
+        ],
+    )
+    def test_command(self, bash, opts):
+        completion = assert_complete(bash, "env %s s" % opts)
+        assert completion == "h" or "sh" in completion
+
+    @pytest.mark.parametrize(
+        "opts",
+        [
+            "foo=bar --non-existent",
+            "- --non-existent",
+            "-- --non-existent",
+        ],
+    )
+    def test_option_like_command(self, bash, opts):
+        completion = assert_complete(bash, "env %s s" % opts)
+        assert not (completion == "h" or "sh" in completion)

test/t/unit/test_unit_load.py

@@ -128,3 +128,6 @@ def test_cmd_intree_precedence(self, bash, fixture_dir):
             # The in-tree `sh` completion should be loaded here,
             # and cause no output, unlike our `$PWD/prefix1/bin/sh` canary.
             assert_bash_exec(bash, "_comp_load sh", want_output=False)
+
+    def test_option_like_cmd_name(self, bash):
+        assert_bash_exec(bash, "! _comp_load -- --non-existent")

test/t/unit/test_unit_realcommand.py

@@ -88,3 +88,11 @@ def test_absolute_nonexistent(self, bash, functions):
             want_output=False,
         )
         assert output.strip() == ""
+
+    def test_option_like_cmd_name(self, bash, functions):
+        output = assert_bash_exec(
+            bash,
+            "! __tester --non-existent",
+            want_output=False,
+        )
+        assert output.strip() == ""