reduce noise and correct shellcheck issues

Author: TimidRobot

setup-wordpress.sh

@@ -1,13 +1,28 @@
 #!/bin/bash
+#
+# Notes:
+# - docker compose run redirects the stderr of any invoked executables to
+#   stdout. The only messages that will appear on stderr are issued by docker
+#   compose run itself. This appears to be an undocumented "feature":
+#   https://docs.docker.com/engine/reference/commandline/compose_run/
+#
+#   The "2>/dev/null" below silences the messages from docker compose run.
+#   For example, the output like the following will not be visible:
+#       [+] Creating 2/0
+#        ✔ Container cc-wordpress-db  Running                             0.0s
+#        ✔ Container cc-web           Running                             0.0s
+#
 set -o errexit
 set -o errtrace
 set -o nounset
 
+# shellcheck disable=SC2154
 trap '_es=${?};
     printf "${0}: line ${LINENO}: \"${BASH_COMMAND}\"";
     printf " exited with a status of ${_es}\n";
     exit ${_es}' ERR
 
+# shellcheck disable=SC1091
 source .env
 ACTIVATE_PLUGINS='
 acf-menu-chooser
@@ -61,7 +76,7 @@ activate_themes() {
 
 composer_install() {
     header 'Composer install'
-    docker compose run --rm composer install
+    docker compose run --rm composer install 2>/dev/null
     echo
 }
 
@@ -80,7 +95,7 @@ enable_permalinks() {
 
 error_exit() {
     # Echo error message and exit with error
-    echo -e "\033[31mERROR:\033[0m ${@}" 1>&2
+    echo -e "\033[31mERROR:\033[0m ${*}" 1>&2
     exit 1
 }
 
@@ -123,7 +138,7 @@ install_wordpress() {
 
 utils_info() {
     header 'Utilities info'
-    docker compose run --rm composer --version
+    docker compose run --rm composer --version 2>/dev/null
     wpcli --info
     echo
 }
@@ -150,12 +165,14 @@ wordpress_status() {
 
 
 wpcli() {
+    # Call WP-CLI with appropriate site arguments via Docker
     docker compose run --rm \
-        --env WP_ADMIN_USER=${WP_ADMIN_USER} \
-        --env WP_ADMIN_PASS=${WP_ADMIN_PASS} \
-        --env WP_ADMIN_EMAIL=${WP_ADMIN_EMAIL} \
+        --env WP_ADMIN_USER="${WP_ADMIN_USER}" \
+        --env WP_ADMIN_PASS="${WP_ADMIN_PASS}" \
+        --env WP_ADMIN_EMAIL="${WP_ADMIN_EMAIL}" \
         wordpress-cli \
-        /usr/local/bin/wp --path=${WEB_WP_DIR} --url=${WEB_WP_URL} "${@}"
+            /usr/local/bin/wp --path="${WEB_WP_DIR}" --url="${WEB_WP_URL}" \
+            "${@}" 2>/dev/null
 }
 
 

wpcli.sh

@@ -3,11 +3,13 @@ set -o errexit
 set -o errtrace
 set -o nounset
 
+# shellcheck disable=SC2154
 trap '_es=${?};
     printf "${0}: line ${LINENO}: \"${BASH_COMMAND}\"";
     printf " exited with a status of ${_es}\n";
     exit ${_es}' ERR
 
+# shellcheck disable=SC1091
 source .env
 WEB_WP_DIR=/var/www/html
 WEB_WP_URL=http://localhost:8080
@@ -17,12 +19,25 @@ WEB_WP_URL=http://localhost:8080
 
 
 wpcli() {
+    # Call WP-CLI with appropriate site arguments via Docker
+    #
+    # docker compose run redirects the stderr of any invoked executables to
+    # stdout. The only messages that will appear on stderr are issued by
+    # docker compose run itself. This appears to be an undocumented "feature":
+    # https://docs.docker.com/engine/reference/commandline/compose_run/
+    #
+    # The "2>/dev/null" below silences the messages from docker compose run.
+    # For example, the output like the following will not be visible:
+    #     [+] Creating 2/0
+    #      ✔ Container cc-wordpress-db  Running                          0.0s
+    #      ✔ Container cc-web           Running                          0.0s
     docker compose run --rm \
-        --env WP_ADMIN_USER=${WP_ADMIN_USER} \
-        --env WP_ADMIN_PASS=${WP_ADMIN_PASS} \
-        --env WP_ADMIN_EMAIL=${WP_ADMIN_EMAIL} \
+        --env WP_ADMIN_USER="${WP_ADMIN_USER}" \
+        --env WP_ADMIN_PASS="${WP_ADMIN_PASS}" \
+        --env WP_ADMIN_EMAIL="${WP_ADMIN_EMAIL}" \
         wordpress-cli \
-        /usr/local/bin/wp --path=${WEB_WP_DIR} --url=${WEB_WP_URL} "${@}"
+            /usr/local/bin/wp --path="${WEB_WP_DIR}" --url="${WEB_WP_URL}" \
+            "${@}" 2>/dev/null
 }