debian: fix alias completion, rename ag and clean up README (#7698)

* Use double quotes to cache value of $apt_pref and $apt_upgr
* Clean up and fix syntax of command checks
* Clean up README and document $apt_pref/$apt_upgr overriding mechanism
* Rename `ag` alias (apt upgrade) to `au`
* Clean up README and fix syntax

Fixes #3686 
Fixes #4660 
Closes #5906

Co-authored-by: Noah Vesely <fowlslegs@riseup.net>

plugins/debian/README.md

@@ -1,75 +1,85 @@
 # debian
 
-This plugin provides debian related zsh aliases.
+This plugin provides Debian-related aliases and functions for zsh.
+
 To use it add `debian` to the plugins array in your zshrc file.
 
 ```zsh
 plugins=(... debian)
 ```
 
+## Settings
+
+- `$apt_pref`: use apt or aptitude if installed, fallback is apt-get.
+- `$apt_upgr`: use upgrade or safe-upgrade (for aptitude).
+
+Set `$apt_pref` and `$apt_upgr` to whatever command you want (before sourcing Oh My Zsh) to override this behavior.
+
 ## Common Aliases
 
-| Alias    | Command                                                                       | Description                                                                |
-| -------- | ------------------------------------------------------------------------------|--------------------------------------------------------------------------- |
-| `age`    | apt-get                                                                       | Command line tool for handling packages                                    |
-| `api`    | aptitude                                                                      | Same functionality as `apt-get`, provides extra options while installation |
-| `acs`    | apt-cache search                                                              | Command line tool for searching apt software package cache                 |
-| `aps`    | aptitude search                                                               | Searches installed packages using aptitude                                 |
-| `as`     | aptitude -F \"* %p -> %d \n(%v/%V)\" \ -no-gui --disable-columns search       | -                                                                          |
-| `afs`    | apt-file search --regexp                                                      | Search file in packages                                                    |
-| `asrc`   | apt-get source                                                                | Fetch source packages through `apt-get`                                    |
-| `app`    | apt-cache policy                                                              | Displays priority of package sources                                       |
+| Alias  | Command                                                                | Description                                                |
+| ------ | ---------------------------------------------------------------------- | ---------------------------------------------------------- |
+| `age`  | `apt-get`                                                              | Command line tool for handling packages                    |
+| `api`  | `aptitude`                                                             | Same functionality as `apt-get`, provides extra options    |
+| `acs`  | `apt-cache search`                                                     | Command line tool for searching apt software package cache |
+| `aps`  | `aptitude search`                                                      | Searches installed packages using aptitude                 |
+| `as`   | `aptitude -F '* %p -> %d \n(%v/%V)' --no-gui --disable-columns search` | Print searched packages using a custom format              |
+| `afs`  | `apt-file search --regexp`                                             | Search file in packages                                    |
+| `asrc` | `apt-get source`                                                       | Fetch source packages through `apt-get`                    |
+| `app`  | `apt-cache policy`                                                     | Displays priority of package sources                       |
 
 ## Superuser Operations Aliases
 
-| Alias    | Command                                                                                          | Description                                                                                 |
-| -------- | -------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------- |
-| `aac`    | sudo $apt_pref autoclean                                                                         | Clears out the local repository of retrieved package files                                  |
-| `abd`    | sudo $apt_pref build-dep                                                                         | Installs all dependencies for building packages                                             |
-| `ac`     | sudo $apt_pref clean                                                                             | Clears out the local repository of retrieved package files except lock files                |
-| `ad`     | sudo $apt_pref update                                                                            | Updates the package lists for upgrades for packages                                         | 
-| `adg`    | sudo $apt_pref update && sudo $apt_pref $apt_upgr                                                | Update and upgrade packages                                                                 |
-| `adu`    | sudo $apt_pref update && sudo $apt_pref dist-upgrade                                             | Smart upgrade that handles dependencies                                                     |
-| `afu`    | sudo apt-file update                                                                             | Update the files in packages                                                                |
-| `au`     | sudo $apt_pref $apt_upgr                                                                         | -                                                                                           |
-| `ai`     | sudo $apt_pref install                                                                           | Command-line tool to install package                                                        |
-| `ail`    | sed -e 's/  */ /g' -e 's/ *//' | cut -s -d ' ' -f 1 | "' xargs sudo $apt_pref install  | Install all packages given on the command line while using only the first word of each line |
-| `ap`     | sudo $apt_pref purge                                                                             | Removes packages along with configuration files                                             |
-| `ar`     | sudo $apt_pref remove                                                                            | Removes packages, keeps the configuration files                                             |
-| `ads`    | sudo apt-get dselect-upgrade                                                                     | Installs packages from list and removes all not in the list                                 |
-| `dia`    | sudo dpkg -i ./*.deb                                                                             | Install all .deb files in the current directory                                             |
-| `di`     | sudo dpkg -i                                                                                     | Install all .deb files in the current directory                                             |
-| `kclean` | sudo aptitude remove -P ?and(~i~nlinux-(ima|hea) ?not(~n`uname -r`))                        | Remove ALL kernel images and headers EXCEPT the one in use                                  |
-
-- `$apt_pref` - Use apt or aptitude if installed, fallback is apt-get.
-- `$apt_upgr` - Use upgrade.
+| Alias    | Command                                                                                | Description                                                                                 |
+| -------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
+| `aac`    | `sudo $apt_pref autoclean`                                                             | Clears out the local repository of retrieved package files                                  |
+| `abd`    | `sudo $apt_pref build-dep`                                                             | Installs all dependencies for building packages                                             |
+| `ac`     | `sudo $apt_pref clean`                                                                 | Clears out the local repository of retrieved package files except lock files                |
+| `ad`     | `sudo $apt_pref update`                                                                | Updates the package lists for upgrades for packages                                         |
+| `adg`    | `sudo $apt_pref update && sudo $apt_pref $apt_upgr`                                    | Update and upgrade packages                                                                 |
+| `adu`    | `sudo $apt_pref update && sudo $apt_pref dist-upgrade`                                 | Smart upgrade that handles dependencies                                                     |
+| `afu`    | `sudo apt-file update`                                                                 | Update the files in packages                                                                |
+| `au`     | `sudo $apt_pref $apt_upgr`                                                             | Install package upgrades                                                                    |
+| `ai`     | `sudo $apt_pref install`                                                               | Command-line tool to install package                                                        |
+| `ail`    | `sed -e 's/  */ /g' -e 's/ *//' \| cut -s -d ' ' -f 1 \| xargs sudo $apt_pref install` | Install all packages given on the command line while using only the first word of each line |
+| `ap`     | `sudo $apt_pref purge`                                                                 | Removes packages along with configuration files                                             |
+| `ar`     | `sudo $apt_pref remove`                                                                | Removes packages, keeps the configuration files                                             |
+| `ads`    | `sudo apt-get dselect-upgrade`                                                         | Installs packages from list and removes all not in the list                                 |
+| `dia`    | `sudo dpkg -i ./*.deb`                                                                 | Install all .deb files in the current directory                                             |
+| `di`     | `sudo dpkg -i`                                                                         | Install all .deb files in the current directory                                             |
+| `kclean` | `sudo aptitude remove -P ?and(~i~nlinux-(ima\|hea) ?not(~n$(uname -r)))`               | Remove ALL kernel images and headers EXCEPT the one in use                                  |
 
 ## Aliases - Commands using `su`
 
-| Alias    | Command                                                                       |
-| -------- | ------------------------------------------------------------------------------|
-| `aac`    | su -ls \'$apt_pref autoclean\' root                                           |
-| `ac`     | su -ls \'$apt_pref clean\' root                                               |
-| `ad`     | su -lc \'$apt_pref update\' root                                              |
-| `adg`    | su -lc \'$apt_pref update && aptitude $apt_upgr\' root                        |
-| `adu`    | su -lc \'$apt_pref update && aptitude dist-upgrade\' root                     |
-| `afu`    | su -lc "apt-file update                                                       |
-| `ag`     | su -lc \'$apt_pref $apt_upgr\' root                                           |
-| `dia`    | su -lc "dpkg -i ./*.deb" root                                                 |
+| Alias | Command                                                   |
+| ----- | --------------------------------------------------------- |
+| `aac` | `su -ls "$apt_pref autoclean" root`                       |
+| `ac`  | `su -ls "$apt_pref clean" root`                           |
+| `ad`  | `su -lc "$apt_pref update" root`                          |
+| `adg` | `su -lc "$apt_pref update && aptitude $apt_upgr" root`    |
+| `adu` | `su -lc "$apt_pref update && aptitude dist-upgrade" root` |
+| `afu` | `su -lc "apt-file update"`                                |
+| `au`  | `su -lc "$apt_pref $apt_upgr" root`                       |
+| `dia` | `su -lc "dpkg -i ./*.deb" root`                           |
 
 ## Miscellaneous Aliases
 
-| Alias    | Command                                          | Description                             |
-| -------- | -------------------------------------------------|---------------------------------------- |
-| `allpkgs`| aptitude search -F "%p" --disable-columns ~i     | Display all installed packages          |  
-| `mydeb`  | time dpkg-buildpackage -rfakeroot -us -uc        | Create a basic .deb package             |
+| Alias     | Command                                        | Description                    |
+| --------- | ---------------------------------------------- | ------------------------------ |
+| `allpkgs` | `aptitude search -F "%p" --disable-columns ~i` | Display all installed packages |
+| `mydeb`   | `time dpkg-buildpackage -rfakeroot -us -uc`    | Create a basic .deb package    |
 
 ## Functions
 
-| Fucntion              | Description                                                                   |
-|-----------------------|-------------------------------------------------------------------------------|
-| `apt-copy`            | Create a simple script that can be used to 'duplicate' a system               |
-| `apt-history`         | Displays apt history for a command                                            | 
-| `kerndeb`             | Builds kernel packages                                                        |
-| `apt-list-packages`   | List packages by size                                                         |
+| Function            | Description                                                     |
+| ------------------- | --------------------------------------------------------------- |
+| `apt-copy`          | Create a simple script that can be used to 'duplicate' a system |
+| `apt-history`       | Displays apt history for a command                              |
+| `kerndeb`           | Builds kernel packages                                          |
+| `apt-list-packages` | List packages by size                                           |
+
+## Authors
 
+- [@AlexBio](https://github.com/AlexBio)
+- [@dbb](https://github.com/dbb)
+- [@Mappleconfusers](https://github.com/Mappleconfusers)

plugins/debian/debian.plugin.zsh

@@ -1,25 +1,21 @@
-# Authors:
-# https://github.com/AlexBio
-# https://github.com/dbb
-# https://github.com/Mappleconfusers
-#
-# Debian-related zsh aliases and functions for zsh
-
 # Use apt or aptitude if installed, fallback is apt-get
 # You can just set apt_pref='apt-get' to override it.
-if [[ -e $( which -p apt 2>&1 ) ]]; then
-    apt_pref='apt'
-    apt_upgr='upgrade'
-elif [[ -e $( which -p aptitude 2>&1 ) ]]; then
-    apt_pref='aptitude'
-    apt_upgr='safe-upgrade'
-else
-    apt_pref='apt-get'
-    apt_upgr='upgrade'
+
+if [[ -z $apt_pref || -z $apt_upgr ]]; then
+    if [[ -e $commands[apt] ]]; then
+        apt_pref='apt'
+        apt_upgr='upgrade'
+    elif [[ -e $commands[aptitude] ]]; then
+        apt_pref='aptitude'
+        apt_upgr='safe-upgrade'
+    else
+        apt_pref='apt-get'
+        apt_upgr='upgrade'
+    fi
 fi
 
 # Use sudo by default if it's installed
-if [[ -e $( which -p sudo 2>&1 ) ]]; then
+if [[ -e $commands[sudo] ]]; then
     use_sudo=1
 fi
 
@@ -32,8 +28,7 @@ alias api='aptitude'
 # Some self-explanatory aliases
 alias acs="apt-cache search"
 alias aps='aptitude search'
-alias as="aptitude -F \"* %p -> %d \n(%v/%V)\" \
-		--no-gui --disable-columns search"	# search package
+alias as="aptitude -F '* %p -> %d \n(%v/%V)' --no-gui --disable-columns search"
 
 # apt-file
 alias afs='apt-file search --regexp'
@@ -46,49 +41,48 @@ alias app='apt-cache policy'
 # superuser operations ######################################################
 if [[ $use_sudo -eq 1 ]]; then
 # commands using sudo #######
-    alias aac='sudo $apt_pref autoclean'
-    alias abd='sudo $apt_pref build-dep'
-    alias ac='sudo $apt_pref clean'
-    alias ad='sudo $apt_pref update'
-    alias adg='sudo $apt_pref update && sudo $apt_pref $apt_upgr'
-    alias adu='sudo $apt_pref update && sudo $apt_pref dist-upgrade'
-    alias afu='sudo apt-file update'
-    alias au='sudo $apt_pref $apt_upgr'
-    alias ai='sudo $apt_pref install'
+    alias aac="sudo $apt_pref autoclean"
+    alias abd="sudo $apt_pref build-dep"
+    alias ac="sudo $apt_pref clean"
+    alias ad="sudo $apt_pref update"
+    alias adg="sudo $apt_pref update && sudo $apt_pref $apt_upgr"
+    alias adu="sudo $apt_pref update && sudo $apt_pref dist-upgrade"
+    alias afu="sudo apt-file update"
+    alias au="sudo $apt_pref $apt_upgr"
+    alias ai="sudo $apt_pref install"
     # Install all packages given on the command line while using only the first word of each line:
     # acs ... | ail
-    alias ail="sed -e 's/  */ /g' -e 's/ *//' | cut -s -d ' ' -f 1 | "' xargs sudo $apt_pref install'
-    alias ap='sudo $apt_pref purge'
-    alias ar='sudo $apt_pref remove'
+    alias ail="sed -e 's/  */ /g' -e 's/ *//' | cut -s -d ' ' -f 1 | xargs sudo $apt_pref install"
+    alias ap="sudo $apt_pref purge"
+    alias ar="sudo $apt_pref remove"
 
     # apt-get only
-    alias ads='sudo apt-get dselect-upgrade'
+    alias ads="sudo apt-get dselect-upgrade"
 
     # Install all .deb files in the current directory.
     # Warning: you will need to put the glob in single quotes if you use:
     # glob_subst
-    alias dia='sudo dpkg -i ./*.deb'
-    alias di='sudo dpkg -i'
+    alias dia="sudo dpkg -i ./*.deb"
+    alias di="sudo dpkg -i"
 
     # Remove ALL kernel images and headers EXCEPT the one in use
-    alias kclean='sudo aptitude remove -P ?and(~i~nlinux-(ima|hea) \
-        ?not(~n`uname -r`))'
+    alias kclean='sudo aptitude remove -P ?and(~i~nlinux-(ima|hea) ?not(~n$(uname -r)))'
 
 
 # commands using su #########
 else
-    alias aac='su -ls \'$apt_pref autoclean\' root'
+    alias aac="su -ls '$apt_pref autoclean' root"
     abd() {
         cmd="su -lc '$apt_pref build-dep $@' root"
         print "$cmd"
         eval "$cmd"
     }
-    alias ac='su -ls \'$apt_pref clean\' root'
-    alias ad='su -lc \'$apt_pref update\' root'
-    alias adg='su -lc \'$apt_pref update && aptitude $apt_upgr\' root'
-    alias adu='su -lc \'$apt_pref update && aptitude dist-upgrade\' root'
-    alias afu='su -lc "apt-file update"'
-    alias ag='su -lc \'$apt_pref $apt_upgr\' root'
+    alias ac="su -ls '$apt_pref clean' root"
+    alias ad="su -lc '$apt_pref update' root"
+    alias adg="su -lc '$apt_pref update && aptitude $apt_upgr' root"
+    alias adu="su -lc '$apt_pref update && aptitude dist-upgrade' root"
+    alias afu="su -lc '$apt-file update'"
+    alias au="su -lc '$apt_pref $apt_upgr' root"
     ai() {
         cmd="su -lc 'aptitude -P install $@' root"
         print "$cmd"
@@ -111,8 +105,7 @@ else
     alias di='su -lc "dpkg -i" root'
 
     # Remove ALL kernel images and headers EXCEPT the one in use
-    alias kclean='su -lc '\''aptitude remove -P ?and(~i~nlinux-(ima|hea) \
-        ?not(~n`uname -r`))'\'' root'
+    alias kclean='su -lc "aptitude remove -P ?and(~i~nlinux-(ima|hea) ?not(~n$(uname -r)))" root'
 fi
 
 # Completion ################################################################
@@ -126,11 +119,11 @@ apt_pref_compdef() {
     f="_apt_pref_${2}"
 
     eval "function ${f}() {
-        shift words; 
-	service=\"\$apt_pref\"; 
-	words=(\"\$apt_pref\" '$2' \$words); 
-	((CURRENT++))
-	test \"\${apt_pref}\" = 'aptitude' && _aptitude || _apt
+        shift words;
+        service=\"\$apt_pref\";
+        words=(\"\$apt_pref\" '$2' \$words);
+        ((CURRENT++))
+        test \"\${apt_pref}\" = 'aptitude' && _aptitude || _apt
     }"
 
     compdef "$f" "$1"
@@ -141,7 +134,7 @@ apt_pref_compdef abd "build-dep"
 apt_pref_compdef ac  "clean"
 apt_pref_compdef ad  "update"
 apt_pref_compdef afu "update"
-apt_pref_compdef ag  "$apt_upgr"
+apt_pref_compdef au  "$apt_upgr"
 apt_pref_compdef ai  "install"
 apt_pref_compdef ail "install"
 apt_pref_compdef ap  "purge"
@@ -213,7 +206,7 @@ kerndeb () {
     # temporarily unset MAKEFLAGS ( '-j3' will fail )
     MAKEFLAGS=$( print - $MAKEFLAGS | perl -pe 's/-j\s*[\d]+//g' )
     print '$MAKEFLAGS set to '"'$MAKEFLAGS'"
-	appendage='-custom' # this shows up in $ (uname -r )
+    appendage='-custom' # this shows up in $(uname -r )
     revision=$(date +"%Y%m%d") # this shows up in the .deb file name
 
     make-kpkg clean