Merge pull request scop#678 from scop/refactor/variable-renames

refactor: public config variable naming changes

Author: scop

bash_completion

@@ -623,7 +623,8 @@ _filedir()
         # the fallback condition with the "plus" dirs.
         local opts=(-f -X "$xspec")
         [[ $xspec ]] && plusdirs=(-o plusdirs)
-        [[ ${COMP_FILEDIR_FALLBACK-} || -z ${plusdirs-} ]] ||
+        [[ ${BASH_COMPLETION_FILEDIR_FALLBACK-${COMP_FILEDIR_FALLBACK-}} ||
+            -z ${plusdirs-} ]] ||
             opts+=("${plusdirs[@]}")
 
         reset=$(shopt -po noglob)
@@ -634,7 +635,8 @@ _filedir()
         IFS=$'\n'
 
         # Try without filter if it failed to produce anything and configured to
-        [[ -n ${COMP_FILEDIR_FALLBACK-} && -n $arg && ${#toks[@]} -lt 1 ]] && {
+        [[ ${BASH_COMPLETION_FILEDIR_FALLBACK-${COMP_FILEDIR_FALLBACK-}} &&
+            -n $arg && ${#toks[@]} -lt 1 ]] && {
             reset=$(shopt -po noglob)
             set -o noglob
             toks+=($(compgen -f ${plusdirs+"${plusdirs[@]}"} -- $quoted))
@@ -1350,7 +1352,7 @@ _backup_glob='@(#*#|*@(~|.@(bak|orig|rej|swp|dpkg*|rpm@(orig|new|save))))'
 #
 _xinetd_services()
 {
-    local xinetddir=${BASHCOMP_XINETDDIR:-/etc/xinetd.d}
+    local xinetddir=${_comp__test_xinetd_dir:-/etc/xinetd.d}
     if [[ -d $xinetddir ]]; then
         local IFS=$' \t\n' reset=$(shopt -p nullglob)
         shopt -s nullglob
@@ -1754,9 +1756,9 @@ _included_ssh_config_files()
 # Helper function for completing _known_hosts.
 # This function performs host completion based on ssh's config and known_hosts
 # files, as well as hostnames reported by avahi-browse if
-# COMP_KNOWN_HOSTS_WITH_AVAHI is set to a non-empty value.  Also hosts from
-# HOSTFILE (compgen -A hostname) are added, unless
-# COMP_KNOWN_HOSTS_WITH_HOSTFILE is set to an empty value.
+# BASH_COMPLETION_KNOWN_HOSTS_WITH_AVAHI is set to a non-empty value.
+# Also hosts from HOSTFILE (compgen -A hostname) are added, unless
+# BASH_COMPLETION_KNOWN_HOSTS_WITH_HOSTFILE is set to an empty value.
 # Usage: _known_hosts_real [OPTIONS] CWORD
 # Options:  -a             Use aliases from ssh config files
 #           -c             Use `:' suffix
@@ -1927,7 +1929,7 @@ _known_hosts_real()
     fi
 
     # Add hosts reported by avahi-browse, if desired and it's available.
-    if [[ ${COMP_KNOWN_HOSTS_WITH_AVAHI-} ]] &&
+    if [[ ${BASH_COMPLETION_KNOWN_HOSTS_WITH_AVAHI-${COMP_KNOWN_HOSTS_WITH_AVAHI-}} ]] &&
         type avahi-browse &>/dev/null; then
         # Some old versions of avahi-browse reportedly didn't have -k
         # (even if mentioned in the manpage); those we do not support any more.
@@ -1945,8 +1947,8 @@ _known_hosts_real()
     fi
 
     # Add results of normal hostname completion, unless
-    # `COMP_KNOWN_HOSTS_WITH_HOSTFILE' is set to an empty value.
-    if [[ -n ${COMP_KNOWN_HOSTS_WITH_HOSTFILE-1} ]]; then
+    # `BASH_COMPLETION_KNOWN_HOSTS_WITH_HOSTFILE' is set to an empty value.
+    if [[ -n ${BASH_COMPLETION_KNOWN_HOSTS_WITH_HOSTFILE-${COMP_KNOWN_HOSTS_WITH_HOSTFILE-1}} ]]; then
         COMPREPLY+=(
             $(compgen -A hostname -P "$prefix" -S "$suffix" -- "$cur"))
     fi
@@ -2267,7 +2269,8 @@ _filedir_xspec()
     ))
 
     # Try without filter if it failed to produce anything and configured to
-    [[ -n ${COMP_FILEDIR_FALLBACK:-} && ${#toks[@]} -lt 1 ]] && {
+    [[ ${BASH_COMPLETION_FILEDIR_FALLBACK-${COMP_FILEDIR_FALLBACK-}} &&
+        ${#toks[@]} -lt 1 ]] && {
         local reset=$(shopt -po noglob)
         set -o noglob
         toks+=($(compgen -f -- "$(quote_readline "$cur")"))

completions/configure

@@ -25,9 +25,9 @@ _configure()
         return
     fi
 
-    # if $COMP_CONFIGURE_HINTS is not null, then completions of the form
-    # --option=SETTING will include 'SETTING' as a contextual hint
-    if [[ ${COMP_CONFIGURE_HINTS-} ]]; then
+    # if $BASH_COMPLETION_CMD_CONFIGURE_HINTS is not null, then completions of
+    # the form --option=SETTING will include 'SETTING' as a contextual hint
+    if [[ ${BASH_COMPLETION_CMD_CONFIGURE_HINTS-${COMP_CONFIGURE_HINTS-}} ]]; then
         COMPREPLY=($(compgen -W "$($1 --help 2>&1 |
             awk '/^  --[A-Za-z]/ { print $1; \
             if ($2 ~ /--[A-Za-z]/) print $2 }' | command sed -e 's/[[,].*//g')" \

completions/cvs

@@ -248,10 +248,10 @@ _cvs()
             esac
 
             if [[ $cur != -* ]]; then
-                # if $COMP_CVS_REMOTE is not null, 'cvs commit' will
-                # complete on remotely checked-out files (requires
+                # if $BASH_COMPLETION_CMD_CVS_REMOTE is not null, 'cvs commit'
+                # will complete on remotely checked-out files (requires
                 # passwordless access to the remote repository
-                if [[ -n ${COMP_CVS_REMOTE:-} ]]; then
+                if [[ -n ${BASH_COMPLETION_CMD_CVS_REMOTE-${COMP_CVS_REMOTE-}} ]]; then
                     # this is the least computationally intensive way found so
                     # far, but other changes (something other than
                     # changed/removed/new) may be missing

completions/iwconfig

@@ -13,7 +13,7 @@ _iwconfig()
             ;;
         essid)
             COMPREPLY=($(compgen -W 'on off any' -- "$cur"))
-            if [[ -n ${COMP_IWLIST_SCAN:-} ]]; then
+            if [[ ${BASH_COMPLETION_CMD_IWCONFIG_SCAN-${COMP_IWLIST_SCAN-}} ]]; then
                 COMPREPLY+=($(compgen -W \
                     "$(iwlist ${words[1]} scan |
                         awk -F'\"' '/ESSID/ {print $2}')" -- "$cur"))
@@ -37,7 +37,7 @@ _iwconfig()
             ;;
         ap)
             COMPREPLY=($(compgen -W 'on off any' -- "$cur"))
-            if [[ -n ${COMP_IWLIST_SCAN:-} ]]; then
+            if [[ ${BASH_COMPLETION_CMD_IWCONFIG_SCAN-${COMP_IWLIST_SCAN-}} ]]; then
                 COMPREPLY+=($(compgen -W \
                     "$(iwlist ${words[1]} scan |
                         awk -F ': ' '/Address/ {print $2}')" -- "$cur"))

completions/tar

@@ -53,7 +53,7 @@
 # It's more important to have proper completion of paths to tar files than it
 # is to have completion for their contents, so this sacrifice was made and
 # `-o filenames` is used with complete instead by default. Setting the
-# `$COMP_TAR_INTERNAL_PATHS` environment variable to a non-null
+# `$BASH_COMPLETION_CMD_TAR_INTERNAL_PATHS` environment variable to a non-null
 # value *before sourcing* this completion toggles that the other way around.
 
 __gtar_parse_help_opt()
@@ -499,7 +499,7 @@ _gtar()
     # FIXME: handle long options
     local tar_mode_arg=
 
-    if [[ -v BASHCOMP_TAR_OPT_DEBUG ]]; then
+    if [[ -v _comp_cmd_tar__debug ]]; then
         set -x
         local PS4='$BASH_SOURCE:$LINENO: '
     fi
@@ -652,7 +652,7 @@ _gtar()
         break
     done # just-for-easy-break while
 
-    if [[ -v BASHCOMP_TAR_OPT_DEBUG ]]; then
+    if [[ -v _comp_cmd_tar__debug ]]; then
         set +x
     fi
 }
@@ -732,15 +732,15 @@ _tar()
     $func "$@"
 
     # Install real completion for subsequent completions
-    if [[ ${COMP_TAR_INTERNAL_PATHS-} ]]; then
+    if [[ ${BASH_COMPLETION_CMD_TAR_INTERNAL_PATHS-${COMP_TAR_INTERNAL_PATHS-}} ]]; then
         complete -F $func -o dirnames tar
     else
         complete -F $func tar
     fi
     unset -f _tar
 }
 
-if [[ ${COMP_TAR_INTERNAL_PATHS-} ]]; then
+if [[ ${BASH_COMPLETION_CMD_TAR_INTERNAL_PATHS-${COMP_TAR_INTERNAL_PATHS-}} ]]; then
     complete -F _tar -o dirnames tar
     complete -F _gtar -o dirnames gtar
     complete -F _posix_tar -o dirnames bsdtar

doc/configuration.md

@@ -25,32 +25,19 @@ completion files that are loaded eagerly from `bash_completion` when it is
 loaded. If unset or null, the default compatibility directory to use is
 `/etc/bash_completion.d`.
 
-### `COMP_CONFIGURE_HINTS`
-
-If set and not null, `configure` completion will return the entire option
-string (e.g. `--this-option=DESCRIPTION`) so one can see what kind of data
-is required and then simply delete the descriptive text and add one's own
-data. If unset or null (default), `configure` completion will strip
-everything after the `=` when returning completions.
-
-### `COMP_CVS_REMOTE`
-
-If set and not null, `cvs commit` completion will try to complete on
-remotely checked-out files. This requires passwordless access to the
-remote repository. Default is unset.
-
-### `COMP_FILEDIR_FALLBACK`
+### `BASH_COMPLETION_FILEDIR_FALLBACK`
 
 If set and not null, completions that look for filenames based on their
 "extensions" will fall back to suggesting all files if there are none
 matching the sought ones.
 
-### `COMP_IWLIST_SCAN`
+### `BASH_COMPLETION_KNOWN_HOSTS_WITH_AVAHI`
 
-If set and not null, `iwconfig` completion will try to complete on
-available wireless networks identifiers. Default is unset.
+If set and not null, known hosts completion will try to use `avahi-browse`
+for additional completions. This may be a slow operation in some setups.
+Default is unset.
 
-### `COMP_KNOWN_HOSTS_WITH_HOSTFILE`
+### `BASH_COMPLETION_KNOWN_HOSTS_WITH_HOSTFILE`
 
 If set and not null (default), known hosts completion will complement
 hostnames from ssh's known_hosts files with hostnames taken from the file
@@ -59,13 +46,26 @@ known hosts completion will omit hostnames from `HOSTFILE`. Omitting
 hostnames from `HOSTFILE` is useful if `HOSTFILE` contains many entries for
 local web development or ad-blocking.
 
-### `COMP_KNOWN_HOSTS_WITH_AVAHI`
+### `BASH_COMPLETION_CMD_CONFIGURE_HINTS`
 
-If set and not null, known hosts completion will try to use `avahi-browse`
-for additional completions. This may be a slow operation in some setups.
-Default is unset.
+If set and not null, `configure` completion will return the entire option
+string (e.g. `--this-option=DESCRIPTION`) so one can see what kind of data
+is required and then simply delete the descriptive text and add one's own
+data. If unset or null (default), `configure` completion will strip
+everything after the `=` when returning completions.
+
+### `BASH_COMPLETION_CMD_CVS_REMOTE`
+
+If set and not null, `cvs commit` completion will try to complete on
+remotely checked-out files. This requires passwordless access to the
+remote repository. Default is unset.
+
+### `BASH_COMPLETION_CMD_IWCONFIG_SCAN`
+
+If set and not null, `iwconfig` completion will try to complete on
+available wireless networks identifiers. Default is unset.
 
-### `COMP_TAR_INTERNAL_PATHS`
+### `BASH_COMPLETION_CMD_TAR_INTERNAL_PATHS`
 
 If set and not null _before sourcing_ the `tar` completion, it will do
 correct path completion for tar file _contents_. If unset or null,

test/config/bashrc

@@ -45,8 +45,16 @@ export XDG_DATA_DIRS=/var/empty
 
 # Make sure default settings are in effect
 unset -v \
+    BASH_COMPLETION_CMD_CONFIGURE_HINTS \
+    BASH_COMPLETION_CMD_CVS_REMOTE \
+    BASH_COMPLETION_CMD_IWCONFIG_SCAN \
+    BASH_COMPLETION_CMD_TAR_INTERNAL_PATHS \
+    BASH_COMPLETION_FILEDIR_FALLBACK \
+    BASH_COMPLETION_KNOWN_HOSTS_WITH_HOSTFILE \
     COMP_CONFIGURE_HINTS \
     COMP_CVS_REMOTE \
+    COMP_FILEDIR_FALLBACK \
+    COMP_IWLIST_SCAN \
     COMP_KNOWN_HOSTS_WITH_HOSTFILE \
     COMP_TAR_INTERNAL_PATHS
 

test/t/conftest.py

@@ -191,8 +191,8 @@ def bash(request) -> pexpect.spawn:
     tmpdir = None
     bash = None
 
-    if os.environ.get("BASHCOMP_TEST_LOGFILE"):
-        logfile = open(os.environ["BASHCOMP_TEST_LOGFILE"], "w")
+    if os.environ.get("BASH_COMPLETION_TEST_LOGFILE"):
+        logfile = open(os.environ["BASH_COMPLETION_TEST_LOGFILE"], "w")
     elif os.environ.get("CI"):
         logfile = sys.stdout
 
@@ -256,8 +256,10 @@ def bash(request) -> pexpect.spawn:
 
         # Start bash
         bash = pexpect.spawn(
-            "%s --norc" % os.environ.get("BASHCOMP_TEST_BASH", "bash"),
-            maxread=os.environ.get("BASHCOMP_TEST_PEXPECT_MAXREAD", 20000),
+            "%s --norc" % os.environ.get("BASH_COMPLETION_TEST_BASH", "bash"),
+            maxread=os.environ.get(
+                "BASH_COMPLETION_TEST_PEXPECT_MAXREAD", 20000
+            ),
             logfile=logfile,
             cwd=cwd,
             env=env,
@@ -444,7 +446,7 @@ class bash_env_saved:
 
     def __init__(self, bash: pexpect.spawn, sendintr: bool = False):
         bash_env_saved.counter += 1
-        self.prefix: str = "_BASHCOMP_TEST%d" % bash_env_saved.counter
+        self.prefix: str = "_comp__test_%d" % bash_env_saved.counter
 
         self.bash = bash
         self.cwd_changed: bool = False
@@ -655,7 +657,7 @@ def diff_env(before: List[str], after: List[str], ignore: str):
         if not re.search(r"^(---|\+\+\+|@@ )", x)
         # Ignore variables expected to change:
         and not re.search(
-            r"^[-+](_|PPID|BASH_REMATCH|_BASHCOMP_TEST\w+)=",
+            r"^[-+](_|PPID|BASH_REMATCH|_comp__test_\d+_\w+)=",
             x,
             re.ASCII,
         )

test/t/unit/test_unit_known_hosts_real.py

@@ -7,7 +7,7 @@
 
 @pytest.mark.bashcomp(
     cmd=None,
-    ignore_env="^[+-](COMP(REPLY|_KNOWN_HOSTS_WITH_HOSTFILE))=",
+    ignore_env="^[+-](COMPREPLY|BASH_COMPLETION_KNOWN_HOSTS_WITH_HOSTFILE)=",
 )
 class TestUnitKnownHostsReal:
     @pytest.mark.parametrize(
@@ -43,9 +43,9 @@ def test_basic(
         )
         assert_bash_exec(
             bash,
-            "unset -v COMP_KNOWN_HOSTS_WITH_HOSTFILE"
+            "unset -v BASH_COMPLETION_KNOWN_HOSTS_WITH_HOSTFILE"
             if hostfile
-            else "COMP_KNOWN_HOSTS_WITH_HOSTFILE=",
+            else "BASH_COMPLETION_KNOWN_HOSTS_WITH_HOSTFILE=",
         )
         output = assert_bash_exec(
             bash,
@@ -66,11 +66,12 @@ def test_basic(
     )
     def test_ip_filtering(self, bash, family, result):
         assert_bash_exec(
-            bash, "unset -v COMPREPLY COMP_KNOWN_HOSTS_WITH_HOSTFILE"
+            bash,
+            "unset -v COMPREPLY BASH_COMPLETION_KNOWN_HOSTS_WITH_HOSTFILE",
         )
         output = assert_bash_exec(
             bash,
-            "COMP_KNOWN_HOSTS_WITH_HOSTFILE= "
+            "BASH_COMPLETION_KNOWN_HOSTS_WITH_HOSTFILE= "
             "_known_hosts_real -%sF _known_hosts_real/localhost_config ''; "
             r'printf "%%s\n" "${COMPREPLY[@]}"' % family,
             want_output=True,
@@ -88,7 +89,7 @@ def test_consecutive_spaces(self, bash, hosts):
 
         output = assert_bash_exec(
             bash,
-            "unset -v COMPREPLY COMP_KNOWN_HOSTS_WITH_HOSTFILE; "
+            "unset -v COMPREPLY BASH_COMPLETION_KNOWN_HOSTS_WITH_HOSTFILE; "
             "_known_hosts_real -aF '_known_hosts_real/spaced  conf' ''; "
             r'printf "%s\n" "${COMPREPLY[@]}"',
             want_output=True,
@@ -108,8 +109,8 @@ def test_files_starting_with_tilde(self, bash, hosts):
             bash_env.write_variable("HOME", bash.cwd)
             output = assert_bash_exec(
                 bash,
-                "unset -v COMPREPLY COMP_KNOWN_HOSTS_WITH_HOSTFILE; "
-                "_known_hosts_real -aF _known_hosts_real/config_tilde ''; "
+                "unset -v COMPREPLY BASH_COMPLETION_KNOWN_HOSTS_WITH_HOSTFILE;"
+                " _known_hosts_real -aF _known_hosts_real/config_tilde ''; "
                 r'printf "%s\n" "${COMPREPLY[@]}"',
                 want_output=True,
             )
@@ -131,8 +132,8 @@ def test_included_configs(self, bash, hosts):
             bash_env.write_variable("HOME", "%s/_known_hosts_real" % bash.cwd)
             output = assert_bash_exec(
                 bash,
-                "unset -v COMPREPLY COMP_KNOWN_HOSTS_WITH_HOSTFILE; "
-                "_known_hosts_real -aF _known_hosts_real/config_include ''; "
+                "unset -v COMPREPLY BASH_COMPLETION_KNOWN_HOSTS_WITH_HOSTFILE;"
+                " _known_hosts_real -aF _known_hosts_real/config_include ''; "
                 r'printf "%s\n" "${COMPREPLY[@]}"',
                 want_output=True,
             )
@@ -144,8 +145,8 @@ def test_no_globbing(self, bash):
             bash_env.chdir("_known_hosts_real")
             output = assert_bash_exec(
                 bash,
-                "unset -v COMPREPLY COMP_KNOWN_HOSTS_WITH_HOSTFILE; "
-                "_known_hosts_real -aF config ''; "
+                "unset -v COMPREPLY BASH_COMPLETION_KNOWN_HOSTS_WITH_HOSTFILE;"
+                " _known_hosts_real -aF config ''; "
                 r'printf "%s\n" "${COMPREPLY[@]}"',
                 want_output=True,
             )

test/t/unit/test_unit_xinetd_services.py

@@ -17,7 +17,7 @@ def test_env_non_pollution(self, bash):
     def test_basic(self, bash):
         output = assert_bash_exec(
             bash,
-            "foo() { local BASHCOMP_XINETDDIR=$PWD/shared/bin;unset -v COMPREPLY; "
+            "foo() { local _comp__test_xinetd_dir=$PWD/shared/bin; unset -v COMPREPLY; "
             '_xinetd_services; printf "%s\\n" "${COMPREPLY[@]}"; }; foo; unset -f foo',
             want_output=True,
         )