Add .github configuration.

resolves gh-10

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: xwmx
+custom: https://paypal.me/WilliamMelody

.github/workflows/tests.yml

@@ -0,0 +1,84 @@
+###############################################################################
+# .github/workflows/tests.yml
+#
+# NOTE: GitHub Actions does not allocate a TTY, preventing detection of
+# piped input using `[[ -t 0 ]]`.
+#
+# More information:
+#
+# https://github.com/actions/runner/issues/241
+#
+# faketty is a GitHub action that uses work-arounds to provide a tty:
+#
+# https://github.com/marketplace/actions/faketty
+#
+# Scripts used by faketty for each platform:
+#
+# linux: `faketty`
+#
+# ```bash
+# #!/bin/bash
+#
+# script -q -e -c "$*"
+# ```
+#
+# win32: `faketty.ps1`
+#
+# ```posh
+# Invoke-Expression "$args"
+# ```
+#
+# darwin: `faketty`
+#
+# requires: `brew install expect`
+#
+# ```bash
+# #!/bin/bash
+#
+# unbuffer $*
+# ```
+###############################################################################
+
+name: "hosts · Test Suite"
+
+on:
+  pull_request:
+    branches: [ master ]
+  push:
+    branches: [ master ]
+  workflow_dispatch:
+
+jobs:
+  test-macos-11:
+    name: "Test: macOS Big Sur 11.0"
+    runs-on: macos-11.0
+    steps:
+      - uses: actions/checkout@v3
+      - name: "Setup"
+        run: |
+          brew update
+          brew install bats-core
+          brew install expect
+      - name: "Set $TERM=xterm"
+        run:  printf "TERM=xterm\\n" >> $GITHUB_ENV
+      - name: "Run bats tests"
+        run:  unbuffer bats test
+  test-ubuntu-latest:
+    name: "Test: Ubuntu Latest"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: "Setup"
+        run: |
+          sudo apt-get update
+          sudo apt-get install bats -y
+      - name: "Install bats-core"
+        run: |
+          git clone https://github.com/bats-core/bats-core.git "${HOME}/bats-core" &&
+            cd "${HOME}/bats-core"
+          git checkout 2e2e5df6adf0b846b411b6b2f7bb654cbc3e2c4e
+          sudo ./install.sh /usr/local
+      - name: "Set $TERM=xterm"
+        run:  printf "TERM=xterm\\n" >> $GITHUB_ENV
+      - name: "Run bats tests"
+        run:  script -q -e -c "bats test"

.shellcheckrc

@@ -5,6 +5,14 @@
 # https://github.com/koalaman/shellcheck/wiki/Ignore
 ###############################################################################
 
+# Disable SC2183
+#
+# Running into this: https://github.com/koalaman/shellcheck/issues/1310
+# TODO: Check if resolved.
+#
+#https://github.com/koalaman/shellcheck/wiki/SC2183
+disable=SC2183
+
 # Disable SC2206 and SC2207
 #
 # `IFS` and `noglob` are set.

.travis.yml

@@ -1,18 +0,0 @@
-jobs:
-  include:
-    - os: linux
-      addons:
-        apt:
-          sources:
-            - sourceline: 'ppa:duggan/bats'
-          packages:
-            - bats
-      dist: bionic
-      language: minimal
-    - os: osx
-      before_install:
-        - brew install bats-core
-      osx_image: xcode11.3
-
-script: bats test
-

Makefile

@@ -3,6 +3,8 @@ PREFIX ?= /usr/local
 
 install:
 	install $(BIN) $(PREFIX)/bin
+	./$(BIN) completions install
 
 uninstall:
 	rm -f $(PREFIX)/bin/$(BIN)
+	./$(BIN) completions uninstall

README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/xwmx/hosts.svg?branch=master)](https://travis-ci.org/xwmx/hosts)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/xwmx/hosts/tests.yml?branch=master)](https://github.com/xwmx/hosts/actions)
 
         __               __
        / /_  ____  _____/ /______
@@ -25,7 +25,8 @@ single, portable script that can be `curl`ed into any environment.
 To install with [Homebrew](http://brew.sh/):
 
 ```bash
-brew install xwmx/taps/hosts
+brew tap xwmx/taps
+brew install hosts
 ```
 
 ### npm
@@ -44,19 +45,65 @@ To install with [bpkg](https://github.com/bpkg/bpkg):
 bpkg install xwmx/hosts
 ```
 
-### Manual
+### Make
 
-To install manually, simply add the `hosts` script to your `$PATH`. If
+To install with [Make](https://en.wikipedia.org/wiki/Make_(software)),
-you already have a `~/bin` directory, you can use the following command:
+clone this repository, navigate to the clone's root directory, and run:
 
 ```bash
-curl -L https://raw.github.com/xwmx/hosts/master/hosts \
+sudo make install
-  -o ~/bin/hosts && chmod +x ~/bin/hosts
 ```
 
+### Manual
+
+To install as an administrator, copy and paste one of the following multi-line
+commands:
+
+```bash
+# install using wget
+sudo wget https://raw.github.com/xwmx/hosts/master/hosts -O /usr/local/bin/hosts &&
+  sudo chmod +x /usr/local/bin/hosts &&
+  sudo hosts completions install
+
+# install using curl
+sudo curl -L https://raw.github.com/xwmx/hosts/master/hosts -o /usr/local/bin/hosts &&
+  sudo chmod +x /usr/local/bin/hosts &&
+  sudo hosts completions install
+```
+
+###### User-only Installation
+
+To install with just user permissions, simply add the `hosts` script to your
+`$PATH`. If you already have a `~/bin` directory, for example, you can use
+one of the following commands:
+
+```bash
+# download with wget
+wget https://raw.github.com/xwmx/hosts/master/hosts -O ~/bin/hosts && chmod +x ~/bin/hosts
+
+# download with curl
+curl -L https://raw.github.com/xwmx/hosts/master/hosts -o ~/bin/hosts && chmod +x ~/bin/hosts
+```
+
+Installing with just user permissions doesn't install the completions, but
+`hosts` works without them. If you have `sudo` access and want to install the
+completion scripts, run the following command:
+
+```bash
+sudo hosts completions install
+```
+
+### Arch Linux
+
 A package for Arch users is also
 [available in the AUR](https://aur.archlinux.org/packages/hosts/).
 
+### Tab Completion
+
+Bash and Zsh tab completion is enabled when `hosts` is installed using
+Homebrew, npm, bpkg, or Make. If you are installing `hosts` manually,
+[completion can be enabled with a few commands](etc/README.md).
+
 ## Usage
 
 ### Listing Entries
@@ -113,7 +160,7 @@ address, domain, or regular expression:
 
 ```bash
 > hosts remove example.com
-Removing the following records:
+Removing the following entries:
 127.0.0.1	example.com
 Are you sure you want to proceed? [y/N] y
 Removed:
@@ -145,7 +192,7 @@ Removed:
 
 ### Enabling / Disabling Entries
 
-Add entries are enabled by default. Disabiling an entry comments it out
+All entries are enabled by default. Disabiling an entry comments it out
 so it has no effect, but remains in the hosts file ready to be enabled
 again.
 
@@ -285,6 +332,7 @@ Usage:
   hosts add <ip> <hostname> [<comment>]
   hosts backups [create | (compare | delete | restore | show) <filename>]
   hosts block <hostname>...
+  hosts completions (check | install [-d | --download] | uninstall)
   hosts disable (<ip> | <hostname> | <search string>)
   hosts disabled
   hosts edit
@@ -294,6 +342,7 @@ Usage:
   hosts list [enabled | disabled | <search string>]
   hosts search <search string>
   hosts show (<ip> | <hostname> | <search string>)
+  hosts subcommands [--raw]
   hosts remove (<ip> | <hostname> | <search string>) [--force]
   hosts unblock <hostname>...
   hosts --auto-sudo
@@ -321,7 +370,29 @@ For help with a particular command, try:
 hosts help <command name>
 ```
 
-## Commands
+## Subcommands
+
+<p align="center">
+  <a href="#hosts-1">(default)</a> •
+  <a href="#hosts-add">add</a> •
+  <a href="#hosts-backups">backups</a> •
+  <a href="#hosts-block">block</a> •
+  <a href="#hosts-completions">completions</a> •
+  <a href="#hosts-disable">disable</a> •
+  <a href="#hosts-disabled">disabled</a> •
+  <a href="#hosts-edit">edit</a> •
+  <a href="#hosts-enable">enable</a> •
+  <a href="#hosts-enabled">enabled</a> •
+  <a href="#hosts-file">file</a> •
+  <a href="#hosts-help">help</a> •
+  <a href="#hosts-list">list</a> •
+  <a href="#hosts-remove">remove</a> •
+  <a href="#hosts-search">search</a> •
+  <a href="#hosts-show">show</a> •
+  <a href="#hosts-subcommands">subcommands</a> •
+  <a href="#hosts-unblock">unblock</a> •
+  <a href="#hosts-version">version</a>
+</p>
 
 ### `hosts`
 
@@ -331,7 +402,7 @@ Usage:
 
 Description:
   List the existing IP / hostname pairs, optionally limited to a specified
-  state. When provided with a seach string, all matching enabled records will
+  state. When provided with a seach string, all matching enabled entries will
   be printed.
 
   Alias for `hosts list`
@@ -345,6 +416,10 @@ Usage:
 
 Description:
   Add a given IP address and hostname pair, along with an optional comment.
+
+Exit status:
+  0   Entry successfully added.
+  1   Invalid parameters or entry exists.
 ```
 
 ### `hosts backups`
@@ -371,6 +446,10 @@ Subcommands:
 
 Description:
   Manage backups.
+
+Exit status:
+  0   Success.
+  1   Invalid parameters or backup not found.
 ```
 
 ### `hosts block`
@@ -382,6 +461,10 @@ Usage:
 Description:
   Block one or more hostnames by adding new entries assigned to `127.0.0.1`
   for IPv4 and both `fe80::1%lo0` and `::1` for IPv6.
+
+Exit status:
+  0   <hostname> successfully blocked.
+  1   Invalid parameters or entry exists.
 ```
 
 #### Blocklists
@@ -389,17 +472,22 @@ Description:
 - [jmdugan/blocklists](https://github.com/jmdugan/blocklists)
 - [notracking/hosts-blocklists](https://github.com/notracking/hosts-blocklists)
 
-### `hosts commands`
+### `hosts completions`
 
 ```text
 Usage:
-  hosts commands [--raw]
+  hosts completions (check | install [-d | --download] | uninstall)
 
 Options:
-  --raw  Display the command list without formatting.
+  -d, --download  Download the completion scripts and install.
 
 Description:
-  Display the list of available commands.
+  Manage completion scripts. For more information, visit:
+  https://github.com/xwmx/hosts/blob/master/etc/README.md
+
+Exit status:
+  0   Completions successfully installed.
+  1   Invalid parameters or other error.
 ```
 
 ### `hosts disable`
@@ -409,8 +497,12 @@ Usage:
   hosts disable (<ip> | <hostname> | <search string>)
 
 Description:
-  Disable one or more records based on a given ip address, hostname, or
+  Disable one or more entries based on a given ip address, hostname, or
   search string.
+
+Exit status:
+  0   Entry successfully disabled.
+  1   Invalid parameters or entry not found.
 ```
 
 ### `hosts disabled`
@@ -420,7 +512,11 @@ Usage:
   hosts disabled
 
 Description:
-  List all disabled records. This is an alias for `hosts list disabled`.
+  List all disabled entries. This is an alias for `hosts list disabled`.
+
+Exit status:
+  0   One or more disabled entries found.
+  1   Invalid parameters or no disabled entries found.
 ```
 
 ### `hosts edit`
@@ -440,8 +536,12 @@ Usage:
   hosts enable (<ip> | <hostname> | <search string>)
 
 Description:
-  Enable one or more disabled records based on a given ip address, hostname,
+  Enable one or more disabled entries based on a given ip address, hostname,
   or search string.
+
+Exit status:
+  0   Entry successfully enabled.
+  1   Invalid parameters or entry not found.
 ```
 
 ### `hosts enabled`
@@ -451,7 +551,11 @@ Usage:
   hosts enabled
 
 Description:
-  List all enabled records. This is an alias for `hosts list enabled`.
+  List all enabled entries. This is an alias for `hosts list enabled`.
+
+Exit status:
+  0   One or more enabled entries found.
+  1   Invalid parameters or no enabled entries found.
 ```
 
 ### `hosts file`
@@ -482,8 +586,12 @@ Usage:
 
 Description:
   List the existing IP / hostname pairs, optionally limited to a specified
-  state. When provided with a seach string, all matching enabled records will
+  state. When provided with a seach string, all matching enabled entries will
   be printed.
+
+Exit status:
+  0   One or more matching entries found.
+  1   Invalid parameters or entry not found.
 ```
 
 ### `hosts remove`
@@ -497,9 +605,13 @@ Options:
   --force  Skip the confirmation prompt.
 
 Description:
-  Remove one or more records based on a given IP address, hostname, or search
+  Remove one or more entries based on a given IP address, hostname, or search
-  string. If an IP and hostname are both provided, only records matching the
+  string. If an IP and hostname are both provided, only entries matching the
   IP and hostname pair will be removed.
+
+Exit status:
+  0   Entry successfully removed.
+  1   Invalid parameters or entry not found.
 ```
 
 ### `hosts search`
@@ -510,6 +622,10 @@ Usage:
 
 Description:
   Search entries for <search string>.
+
+Exit status:
+  0   One or more matching entries found.
+  1   Invalid parameters or entry not found.
 ```
 
 ### `hosts show`
@@ -520,6 +636,23 @@ Usage:
 
 Description:
   Print entries matching a given IP address, hostname, or search string.
+
+Exit status:
+  0   One or more matching entries found.
+  1   Invalid parameters or entry not found.
+```
+
+### `hosts subcommands`
+
+```text
+Usage:
+  hosts subcommands [--raw]
+
+Options:
+  --raw  Display the subcommands list without formatting.
+
+Description:
+  Display the list of available subcommands.
 ```
 
 ### `hosts unblock`
@@ -530,6 +663,10 @@ Usage:
 
 Description:
   Unblock one or more hostnames by removing the entries from the hosts file.
+
+Exit status:
+  0   <hostname> successfully unblocked.
+  1   Invalid parameters or entry not found
 ```
 
 ### `hosts version`
@@ -544,12 +681,14 @@ Description:
 
 ## Tests
 
-To run the test suite, install [Bats](https://github.com/sstephenson/bats) and
+To run the [test suite](test), install [Bats](https://github.com/sstephenson/bats) and
 run `bats test` in the project root directory.
 
-## Acknowledgements
+---
-
+<p align="center">
-- https://gist.github.com/nddrylliog/1368532
+  Copyright (c) 2015-present William Melody • See LICENSE for details.
-- https://gist.github.com/dfeyer/1369760
+</p>
-- https://github.com/macmade/host-manager
 
+<p align="center">
+  <a href="https://github.com/xwmx/hosts">github.com/xwmx/hosts</a>
+</p>

etc/README.md

@@ -0,0 +1,113 @@
+# `hosts` Tab Completion
+
+## Homebrew
+
+Installing via Homebrew with `brew install xwmx/taps/hosts` will also
+install the completion scripts.
+
+A one-time setup might be needed to [enable completion for all Homebrew
+programs](https://docs.brew.sh/Shell-Completion).
+
+## npm, bpkg, Make
+
+When `hosts` is installed with `npm`, `bpkg`, or Make, an install hook will
+check the environment and attempt to install completions. If it's successful,
+you should see a message similar to:
+
+```bash
+Completion installed: /usr/local/etc/bash_completion.d/hosts
+Completion installed: /usr/local/share/zsh/site-functions/_hosts
+```
+
+If completion is working after installing through any of these methods, then
+you don't need to do anything else.
+
+## `hosts completions`
+
+The `hosts completions` subcommand can be used for installing and uninstalling
+completion scripts. Depending on your configuration, you might need to use
+`sudo` to install completion scripts easily:
+
+```bash
+> sudo hosts completions check
+Completion scripts not found.
+
+> sudo hosts completions install
+Completion script installed: /usr/share/bash-completion/completions/hosts
+Completion script installed: /usr/local/share/zsh/site-functions/_hosts
+
+> sudo hosts completions check
+Exists: /usr/share/bash-completion/completions/hosts
+Exists: /usr/local/share/zsh/site-functions/_hosts
+
+> sudo hosts completions uninstall
+Completion script removed: /usr/share/bash-completion/completions/hosts
+Completion script removed: /usr/local/share/zsh/site-functions/_hosts
+```
+
+If you installed `hosts` manually by downloading just the `hosts` script,
+the completion scripts won't be immediately available for
+`hosts completions install`. You can try installing the completions with
+the `--download` flag, which will get the latest version from GitHub:
+
+```bash
+sudo hosts completions install --download
+```
+
+`hosts completions` will try to determine the completion script directories
+from your environment. If `hosts completions` isn't able to install
+the completion scripts, you can try installing them manually.
+
+## Manual Installation
+
+### bash
+
+#### Linux
+
+On a current Linux OS (in a non-minimal installation), bash completion should
+be available.
+
+Place the completion script in `/etc/bash_completion.d/`:
+
+```bash
+sudo curl -L https://raw.githubusercontent.com/xwmx/hosts/master/hosts-completion.bash -o /etc/bash_completion.d/hosts
+```
+
+#### macOS
+
+If you aren't installing with homebrew, source the completion script in
+`.bash_profile`:
+
+```sh
+if [[ -f /path/to/hosts-completion.bash ]]
+then
+  source /path/to/hosts-completion.bash
+fi
+```
+
+### zsh
+
+Place the completion script in your `/path/to/zsh/completion` (typically
+`~/.zsh/completion/`):
+
+```bash
+$ mkdir -p ~/.zsh/completion
+$ curl -L https://raw.githubusercontent.com/xwmx/hosts/master/hosts-completion.zsh > ~/.zsh/completion/_hosts
+```
+Include the directory in your `$fpath` by adding in `~/.zshrc`:
+
+```bash
+fpath=(~/.zsh/completion $fpath)
+```
+
+Make sure `compinit` is loaded or do it by adding in `~/.zshrc`:
+
+```bash
+autoload -Uz compinit && compinit -i
+```
+
+Then reload your shell:
+
+```bash
+exec $SHELL -l
+```

package-lock.json

@@ -1,5 +1,5 @@
 {
   "name": "hosts.sh",
-  "version": "3.3.2",
+  "version": "3.6.4",
   "lockfileVersion": 1
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hosts.sh",
-  "version": "3.3.2",
+  "version": "3.6.4",
   "description": "A command line tool for managing hosts file entries.",
   "global": true,
   "install": "make install",
@@ -11,7 +11,9 @@
     "test": "test"
   },
   "scripts": {
-    "test": "bats test"
+    "test": "bats test",
+    "postinstall": "./hosts completions install",
+    "preuninstall": "./hosts completions uninstall"
   },
   "repository": {
     "type": "git",

test/backups.bats

@@ -85,7 +85,7 @@ No backups found. Create a new backup:
     run "${_HOSTS}" add 0.0.0.0 example.com
   }
 
-  run "${_HOSTS}" backups compare "${_backup_basename}" --diff
+  run "${_HOSTS}" backups compare "${_backup_basename}"
   printf "\${output}: '%s'\\n" "${output}"
   printf "\${lines[1]}: '%s'\\n" "${lines[1]}"
   [[ ${status} -eq 1 ]]
@@ -100,7 +100,7 @@ No backups found. Create a new backup:
     run "${_HOSTS}" add 0.0.0.0 example.com
   }
 
-  run "${_HOSTS}" backups compare --diff
+  run "${_HOSTS}" backups compare
   printf "\${status}: %s\\n" "${status}"
   printf "\${output}: '%s'\\n" "${output}"
   [[ ${status} -eq 1 ]]
@@ -115,7 +115,7 @@ No backups found. Create a new backup:
     run "${_HOSTS}" add 0.0.0.0 example.com
   }
 
-  run "${_HOSTS}" backups compare "invalid-backup-name" --diff
+  run "${_HOSTS}" backups compare "invalid-backup-name"
   printf "\${status}: %s\\n" "${status}"
   printf "\${output}: '%s'\\n" "${output}"
   [[ ${status} -eq 1 ]]
@@ -128,6 +128,7 @@ No backups found. Create a new backup:
   {
     run "${_HOSTS}" backups create
     _backup_path="$(echo "${output}" | sed -e 's/Backed up to \(.*\)/\1/')"
+    [[ -e "${_backup_path}" ]]
     _backup_basename="$(basename "${_backup_path}")"
   }
 
@@ -230,6 +231,7 @@ No backups found. Create a new backup:
   {
     run "${_HOSTS}" backups create
     _backup_path="$(echo "${output}" | sed -e 's/Backed up to \(.*\)/\1/')"
+    [[ -e "${_backup_path:-}" ]]
     _backup_basename="$(basename "${_backup_path}")"
   }
 

test/block.bats

@@ -2,7 +2,7 @@
 
 load test_helper
 
-# `hosts block` #################################################################
+# `hosts block` ###############################################################
 
 @test "\`block\` with no arguments exits with status 1." {
   run "${_HOSTS}" block
@@ -28,7 +28,7 @@ load test_helper
   [[ "${lines[1]}" == "  hosts block <hostname>..." ]]
 }
 
-# `hosts block <hostname>` #################################################
+# `hosts block <hostname>` ####################################################
 
 @test "\`block <hostname>\` exits with status 0." {
   run "${_HOSTS}" block example.com

test/disabled.bats

@@ -2,7 +2,7 @@
 
 load test_helper
 
-# `hosts disabled` #############################################################
+# `hosts disabled` ############################################################
 
 @test "\`disabled\` with no arguments exits with status 0." {
   {
@@ -18,7 +18,7 @@ load test_helper
   [[ ${status} -eq 0 ]]
 }
 
-@test "\`disabled\` with no arguments prints list of disabled records." {
+@test "\`disabled\` with no arguments prints list of disabled entries." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net
@@ -34,6 +34,13 @@ load test_helper
   [[ "${lines[2]}" == "" ]]
 }
 
+@test "\`disabled\` exits with status 1 when no matching entries found." {
+  run "${_HOSTS}" disabled
+  printf "\${status}: %s\\n" "${status}"
+  printf "\${output}: '%s'\\n" "${output}"
+  [[ ${status} -eq 1 ]]
+}
+
 # help ########################################################################
 
 @test "\`help disabled\` exits with status 0." {

test/enabled.bats

@@ -18,7 +18,7 @@ load test_helper
   [[ ${status} -eq 0 ]]
 }
 
-@test "\`enabled\` with no arguments prints list of enabled records." {
+@test "\`enabled\` with no arguments prints list of enabled entries." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net
@@ -36,6 +36,18 @@ load test_helper
   [[ "${lines[4]}" =~ 127.0.0.2[[:space:]]+example.com ]]
 }
 
+@test "\`enabled\` exits with status 1 when no matching entries found." {
+  {
+    run "${_HOSTS}" disable localhost
+    run "${_HOSTS}" disable broadcasthost
+  }
+
+  run "${_HOSTS}" enabled
+  printf "\${status}: %s\\n" "${status}"
+  printf "\${output}: '%s'\\n" "${output}"
+  [[ ${status} -eq 1 ]]
+}
+
 # help ########################################################################
 
 @test "\`help enabled\` exits with status 0." {

test/hosts.bats

@@ -10,9 +10,9 @@ load test_helper
 @test "\`hosts\` with no arguments prints enabled rules." {
   run "${_HOSTS}"
   [[ "${#lines[@]}" -eq 4 ]]
-  [[ "${lines[0]}" =~ 127.0.0.1[[:space:]]+localhost ]]
+  [[ "${lines[0]}" =~ 127.0.0.1[[:space:]]+localhost            ]]
-  [[ "${lines[1]}" =~ 255.255.255.255[[:space:]]+broadcasthost ]]
+  [[ "${lines[1]}" =~ 255.255.255.255[[:space:]]+broadcasthost  ]]
-  [[ "${lines[2]}" =~ \:\:1[[:space:]]+localhost ]]
+  [[ "${lines[2]}" =~ \:\:1[[:space:]]+localhost                ]]
-  [[ "${lines[3]}" =~ fe80\:\:1\%lo0[[:space:]]+localhost ]]
+  [[ "${lines[3]}" =~ fe80\:\:1\%lo0[[:space:]]+localhost       ]]
   [[ "${lines[4]}" == "" ]]
 }

test/list.bats

@@ -2,7 +2,7 @@
 
 load test_helper
 
-# `hosts list` #############################################################
+# `hosts list` ################################################################
 
 @test "\`list\` exits with status 0." {
   {
@@ -18,7 +18,7 @@ load test_helper
   [[ ${status} -eq 0 ]]
 }
 
-@test "\`list\` prints lists of enabled and disabled records." {
+@test "\`list\` prints lists of enabled and disabled entries." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net
@@ -60,7 +60,7 @@ Disabled:
   [[ ${status} -eq 0 ]]
 }
 
-@test "\`list enabled\` prints list of enabled records." {
+@test "\`list enabled\` prints list of enabled entries." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net
@@ -71,11 +71,23 @@ Disabled:
   run "${_HOSTS}" list enabled
   printf "\${status}: %s\\n" "${status}"
   printf "\${output}: '%s'\\n" "${output}"
-  [[ "${lines[0]}" =~ 127\.0\.0\.1[[:space:]]+localhost ]]
+  [[ "${lines[0]}" =~ 127\.0\.0\.1[[:space:]]+localhost           ]]
   [[ "${lines[1]}" =~ 255\.255\.255\.255[[:space:]]+broadcasthost ]]
-  [[ "${lines[2]}" =~ \:\:1[[:space:]]+localhost ]]
+  [[ "${lines[2]}" =~ \:\:1[[:space:]]+localhost                  ]]
-  [[ "${lines[3]}" =~ fe80\:\:1\%lo0[[:space:]]+localhost ]]
+  [[ "${lines[3]}" =~ fe80\:\:1\%lo0[[:space:]]+localhost         ]]
-  [[ "${lines[4]}" =~ 127\.0\.0\.2[[:space:]]+example.com ]]
+  [[ "${lines[4]}" =~ 127\.0\.0\.2[[:space:]]+example.com         ]]
+}
+
+@test "\`list enabled\` exits with status 1 when no matching entries found." {
+  {
+    run "${_HOSTS}" disable localhost
+    run "${_HOSTS}" disable broadcasthost
+  }
+
+  run "${_HOSTS}" list enabled
+  printf "\${status}: %s\\n" "${status}"
+  printf "\${output}: '%s'\\n" "${output}"
+  [[ ${status} -eq 1 ]]
 }
 
 # `hosts list disabled` #######################################################
@@ -94,7 +106,7 @@ Disabled:
   [[ ${status} -eq 0 ]]
 }
 
-@test "\`list disabled\` prints list of disabled records." {
+@test "\`list disabled\` prints list of disabled entries." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net
@@ -110,6 +122,13 @@ Disabled:
   [[ "${lines[2]}" == "" ]]
 }
 
+@test "\`list disabled\` exits with status 1 when no matching entries found." {
+  run "${_HOSTS}" list disabled
+  printf "\${status}: %s\\n" "${status}"
+  printf "\${output}: '%s'\\n" "${output}"
+  [[ ${status} -eq 1 ]]
+}
+
 # `hosts list <search string>` ################################################
 
 @test "\`list <search string>\` exits with status 0." {
@@ -125,7 +144,7 @@ Disabled:
   [[ ${status} -eq 0 ]]
 }
 
-@test "\`list <search string>\` prints list of matching records." {
+@test "\`list <search string>\` prints list of matching entries." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net
@@ -140,7 +159,7 @@ Disabled:
   [[ "${lines[2]}" == "" ]]
 }
 
-@test "\`list <search string>\` prints records with matching comments." {
+@test "\`list <search string>\` prints entries with matching comments." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net "Example Comment"
@@ -155,7 +174,7 @@ Disabled:
 }
 
 
-@test "\`list <search string>\` prints disabled records with matching comments." {
+@test "\`list <search string>\` prints disabled entries with matching comments." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net "Example Comment"
@@ -172,6 +191,13 @@ Disabled:
   [[ "${lines[4]}" == "" ]]
 }
 
+@test "\`list <search string>\` exits with status 1 when no matching entries found." {
+  run "${_HOSTS}" list query-that-matches-no-entries
+  printf "\${status}: %s\\n" "${status}"
+  printf "\${output}: '%s'\\n" "${output}"
+  [[ ${status} -eq 1 ]]
+}
+
 # help ########################################################################
 
 @test "\`help list\` exits with status 0." {

test/remove.bats

@@ -2,7 +2,7 @@
 
 load test_helper
 
-# `hosts remove` #################################################################
+# `hosts remove` ##############################################################
 
 @test "\`remove\` with no arguments exits with status 1." {
   run "${_HOSTS}" remove
@@ -53,7 +53,7 @@ load test_helper
   run "${_HOSTS}" remove 127.0.0.3 --force
   printf "\${status}: %s\\n" "${status}"
   printf "\${output}: '%s'\\n" "${output}"
-  [[ ${output} == "No matching records found." ]]
+  [[ ${output} == "${_ERROR_PREFIX}No matching entries found." ]]
 }
 
 # `hosts remove <ip> --force` #################################################
@@ -83,9 +83,9 @@ load test_helper
   printf "\${status}: %s\\n" "${status}"
   printf "\${output}: '%s'\\n" "${output}"
   _compare "${_original}" "$(cat "${HOSTS_PATH}")"
-  [[ "$(sed -n '11p' "${HOSTS_PATH}")" =~ 0.0.0.0[[:space:]]+example.com ]]
+  [[ "$(sed -n '11p' "${HOSTS_PATH}")" =~ 0.0.0.0[[:space:]]+example.com  ]]
-  [[ "$(sed -n '12p' "${HOSTS_PATH}")" =~ 0.0.0.0[[:space:]]+example.net ]]
+  [[ "$(sed -n '12p' "${HOSTS_PATH}")" =~ 0.0.0.0[[:space:]]+example.net  ]]
-  [[ "$(sed -n '13p' "${HOSTS_PATH}")" == "" ]]
+  [[ "$(sed -n '13p' "${HOSTS_PATH}")" == ""                              ]]
 }
 
 @test "\`remove <ip>\` removes all matches." {

test/search.bats

@@ -2,7 +2,7 @@
 
 load test_helper
 
-# `hosts search` #############################################################
+# `hosts search` ##############################################################
 
 @test "\`search\` with no arguments exits with status 1." {
   {
@@ -29,14 +29,8 @@ load test_helper
   run "${_HOSTS}" search
   printf "\${status}: %s\\n" "${status}"
   printf "\${output}: '%s'\\n" "${output}"
-  _expected="\
+  [[ "${lines[0]}" == "Usage:"                          ]]
-Usage:
+  [[ "${lines[1]}" == "  hosts search <search string>"  ]]
-  hosts search <search string>
-
-Description:
-  Search entries for <search string>."
-  _compare "'${_expected}'" "'${output}'"
-  [[ "${output}" == "${_expected}" ]]
 }
 
 # `hosts search enabled` ######################################################
@@ -55,7 +49,7 @@ Description:
   [[ ${status} -eq 0 ]]
 }
 
-@test "\`search enabled\` prints list of enabled records." {
+@test "\`search enabled\` prints list of enabled entries." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net
@@ -66,14 +60,26 @@ Description:
   run "${_HOSTS}" search enabled
   printf "\${status}: %s\\n" "${status}"
   printf "\${output}: '%s'\\n" "${output}"
-  [[ "${lines[0]}" =~ 127.0.0.1[[:space:]]+localhost ]]
+  [[ "${lines[0]}" =~ 127.0.0.1[[:space:]]+localhost            ]]
-  [[ "${lines[1]}" =~ 255.255.255.255[[:space:]]+broadcasthost ]]
+  [[ "${lines[1]}" =~ 255.255.255.255[[:space:]]+broadcasthost  ]]
-  [[ "${lines[2]}" =~ \:\:1[[:space:]]+localhost ]]
+  [[ "${lines[2]}" =~ \:\:1[[:space:]]+localhost                ]]
-  [[ "${lines[3]}" =~ fe80\:\:1\%lo0[[:space:]]+localhost ]]
+  [[ "${lines[3]}" =~ fe80\:\:1\%lo0[[:space:]]+localhost       ]]
-  [[ "${lines[4]}" =~ 127.0.0.2[[:space:]]+example.com ]]
+  [[ "${lines[4]}" =~ 127.0.0.2[[:space:]]+example.com          ]]
 }
 
-# `hosts search disabled` #######################################################
+@test "\`search enabled\` exits with status 1 when no matching entries found." {
+  {
+    run "${_HOSTS}" disable localhost
+    run "${_HOSTS}" disable broadcasthost
+  }
+
+  run "${_HOSTS}" search enabled
+  printf "\${status}: %s\\n" "${status}"
+  printf "\${output}: '%s'\\n" "${output}"
+  [[ ${status} -eq 1 ]]
+}
+
+# `hosts search disabled` #####################################################
 
 @test "\`search disabled\` exits with status 0." {
   {
@@ -89,7 +95,7 @@ Description:
   [[ ${status} -eq 0 ]]
 }
 
-@test "\`search disabled\` prints list of disabled records." {
+@test "\`search disabled\` prints list of disabled entries." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net
@@ -100,11 +106,18 @@ Description:
   run "${_HOSTS}" search disabled
   printf "\${status}: %s\\n" "${status}"
   printf "\${output}: '%s'\\n" "${output}"
-  [[ "${lines[0]}" =~ 0.0.0.0[[:space:]]+example.com ]]
+  [[ "${lines[0]}" =~ 0.0.0.0[[:space:]]+example.com    ]]
-  [[ "${lines[1]}" =~ 127.0.0.1[[:space:]]+example.com ]]
+  [[ "${lines[1]}" =~ 127.0.0.1[[:space:]]+example.com  ]]
   [[ "${lines[2]}" == "" ]]
 }
 
+@test "\`search disabled\` exits with status 1 when no matching entries found." {
+  run "${_HOSTS}" search disabled
+  printf "\${status}: %s\\n" "${status}"
+  printf "\${output}: '%s'\\n" "${output}"
+  [[ ${status} -eq 1 ]]
+}
+
 # `hosts search <search string>` ################################################
 
 @test "\`search <search string>\` exits with status 0." {
@@ -120,7 +133,7 @@ Description:
   [[ ${status} -eq 0 ]]
 }
 
-@test "\`search <search string>\` prints list of matching records." {
+@test "\`search <search string>\` prints list of matching entries." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net
@@ -130,12 +143,12 @@ Description:
   run "${_HOSTS}" search example.com
   printf "\${status}: %s\\n" "${status}"
   printf "\${output}: '%s'\\n" "${output}"
-  [[ "${lines[0]}" =~ 0.0.0.0[[:space:]]+example.com ]]
+  [[ "${lines[0]}" =~ 0.0.0.0[[:space:]]+example.com    ]]
-  [[ "${lines[1]}" =~ 127.0.0.1[[:space:]]+example.com ]]
+  [[ "${lines[1]}" =~ 127.0.0.1[[:space:]]+example.com  ]]
   [[ "${lines[2]}" == "" ]]
 }
 
-@test "\`search <search string>\` prints records with matching comments." {
+@test "\`search <search string>\` prints entries with matching comments." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net "Example Comment"
@@ -149,7 +162,7 @@ Description:
   [[ "${lines[2]}" == "" ]]
 }
 
-@test "\`search <search string>\` prints disabled records with matching comments." {
+@test "\`search <search string>\` prints disabled entries with matching comments." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net "Example Comment"
@@ -161,11 +174,18 @@ Description:
   run "${_HOSTS}" search "Comment"
   printf "\${status}: %s\\n" "${status}"
   printf "\${output}: '%s'\\n" "${output}"
-  [[ "${lines[0]}" =~ 0.0.0.0[[:space:]]+example.net[[:space:]]+\#\ Example\ Comment ]]
+  [[ "${lines[0]}" =~ 0.0.0.0[[:space:]]+example.net[[:space:]]+\#\ Example\ Comment    ]]
-  [[ "${lines[3]}" =~ 127.0.0.1[[:space:]]+example.biz[[:space:]]+\#\ Example\ Comment ]]
+  [[ "${lines[3]}" =~ 127.0.0.1[[:space:]]+example.biz[[:space:]]+\#\ Example\ Comment  ]]
   [[ "${lines[4]}" == "" ]]
 }
 
+@test "\`search <search string>\` exits with status 1 when no matching entries found." {
+  run "${_HOSTS}" search query-that-matches-no-entries
+  printf "\${status}: %s\\n" "${status}"
+  printf "\${output}: '%s'\\n" "${output}"
+  [[ ${status} -eq 1 ]]
+}
+
 # help ########################################################################
 
 @test "\`help search\` exits with status 0." {
@@ -177,6 +197,6 @@ Description:
   run "${_HOSTS}" help search
   printf "\${status}: %s\\n" "${status}"
   printf "\${output}: '%s'\\n" "${output}"
-  [[ "${lines[0]}" == "Usage:" ]]
+  [[ "${lines[0]}" == "Usage:"                          ]]
-  [[ "${lines[1]}" == "  hosts search <search string>" ]]
+  [[ "${lines[1]}" == "  hosts search <search string>"  ]]
 }

test/show.bats

@@ -2,7 +2,7 @@
 
 load test_helper
 
-# `hosts show` ##############################################################
+# `hosts show` ################################################################
 
 @test "\`show\` with no arguments exits with status 1." {
   run "${_HOSTS}" show
@@ -19,7 +19,25 @@ load test_helper
   [[ "${lines[1]}" == "  hosts show (<ip> | <hostname> | <search string>)" ]]
 }
 
-# `hosts show <ip>` #########################################################
+# `hosts show <no matching>` ##################################################
+
+@test "\`show <query>\` with no matching entries with status 1." {
+  {
+    run "${_HOSTS}" add 0.0.0.0 example.com
+    run "${_HOSTS}" add 0.0.0.0 example.net
+    run "${_HOSTS}" add 127.0.0.2 example.com
+    run "${_HOSTS}" disable example.com
+  }
+
+  run "${_HOSTS}" show bad-query
+  printf "\${status}: %s\\n" "${status}"
+  printf "\${output}: '%s'\\n" "${output}"
+  [[ ${status} -eq 1 ]]
+
+  [[ "${lines[0]}" =~ No\ matching\ entries ]]
+}
+
+# `hosts show <ip>` ###########################################################
 
 @test "\`show <ip>\` exits with status 0 and shows all matches." {
   {
@@ -54,12 +72,12 @@ load test_helper
   [[ ${status} -eq 0 ]]
 
   [[ "${lines[0]}" =~ 127\.0\.0\.2[[:space:]]+example.com ]]
-  [[ "${lines[3]}" =~ 0\.0\.0\.0[[:space:]]+example.com ]]
+  [[ "${lines[3]}" =~ 0\.0\.0\.0[[:space:]]+example.com   ]]
 }
 
 # `hosts show <search string>` ################################################
 
-@test "\`show <search string>\` exits with status 0 and shows matching records." {
+@test "\`show <search string>\` exits with status 0 and shows matching entries." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net
@@ -71,12 +89,12 @@ load test_helper
   printf "\${output}: '%s'\\n" "${output}"
   [[ ${status} -eq 0 ]]
 
-  [[ "${lines[0]}" =~ 0\.0\.0\.0[[:space:]]+example.com ]]
+  [[ "${lines[0]}" =~ 0\.0\.0\.0[[:space:]]+example.com   ]]
   [[ "${lines[1]}" =~ 127\.0\.0\.1[[:space:]]+example.com ]]
   [[ "${lines[2]}" == "" ]]
 }
 
-@test "\`show <search string>\` prints records with matching comments." {
+@test "\`show <search string>\` prints entries with matching comments." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net "Example Comment"
@@ -91,7 +109,7 @@ load test_helper
   [[ "${lines[2]}" == "" ]]
 }
 
-@test "\`show <search string>\` prints disabled records with matching comments." {
+@test "\`show <search string>\` prints disabled entries with matching comments." {
   {
     run "${_HOSTS}" add 0.0.0.0 example.com
     run "${_HOSTS}" add 0.0.0.0 example.net "Example Comment"
@@ -103,8 +121,8 @@ load test_helper
   run "${_HOSTS}" show "Comment"
   printf "\${status}: %s\\n" "${status}"
   printf "\${output}: '%s'\\n" "${output}"
-  [[ "${lines[0]}" =~ 0\.0\.0\.0[[:space:]]+example\.net[[:space:]]+\#\ Example\ Comment ]]
+  [[ "${lines[0]}" =~ 0\.0\.0\.0[[:space:]]+example\.net[[:space:]]+\#\ Example\ Comment    ]]
-  [[ "${lines[3]}" =~ 127\.0\.0\.1[[:space:]]+example\.biz[[:space:]]+\#\ Example\ Comment ]]
+  [[ "${lines[3]}" =~ 127\.0\.0\.1[[:space:]]+example\.biz[[:space:]]+\#\ Example\ Comment  ]]
   [[ "${lines[4]}" == "" ]]
 }
 

test/test_helper.bash

@@ -18,6 +18,9 @@ setup() {
   export _HOSTS_TEMP_PATH
   _HOSTS_TEMP_PATH="${_HOSTS_TEMP_DIR}/hosts"
 
+  export _ERROR_PREFIX
+  _ERROR_PREFIX="$(tput setaf 1)!$(tput sgr0) "
+
   cat "${BATS_TEST_DIRNAME}/fixtures/hosts" > "${_HOSTS_TEMP_PATH}"
 
   export HOSTS_PATH="${_HOSTS_TEMP_PATH}"

test/unblock.bats

@@ -2,7 +2,7 @@
 
 load test_helper
 
-# `hosts unblock` #################################################################
+# `hosts unblock` #############################################################
 
 @test "\`unblock\` with no arguments exits with status 1." {
   run "${_HOSTS}" unblock
@@ -28,7 +28,7 @@ load test_helper
   [[ "${lines[1]}" == "  hosts unblock <hostname>..." ]]
 }
 
-# `hosts unblock <invalid>` ############################################
+# `hosts unblock <invalid>` ###################################################
 
 @test "\`unblock <invalid> \` exits with status 1." {
   {
@@ -49,10 +49,10 @@ load test_helper
   run "${_HOSTS}" unblock example.net
   printf "\${status}: %s\\n" "${status}"
   printf "\${output}: '%s'\\n" "${output}"
-  [[ ${output} == "No matching records found." ]]
+  [[ ${output} == "${_ERROR_PREFIX}No matching entries found." ]]
 }
 
-# `hosts unblock <hostname>` ###########################################
+# `hosts unblock <hostname>` ##################################################
 
 @test "\`unblock <hostname>\` exits with status 0." {
   {