Update example code

Author: Hunter T

Examples/example-1.md

@@ -110,7 +110,7 @@ nadekobot/output/data/xp_template.json"
 
 # Revision number of this script.
 # Refer to the 'README' note at the beginning of this file for more information.
-export _LINUXAIO_REVISION="34"
+export _LINUXAIO_REVISION=36
 # The URL to the raw code of a script that is specified by the other scripts.
 export _RAW_URL="https://raw.githubusercontent.com/$installer_repo/$installer_branch"
 
@@ -125,9 +125,8 @@ export _RAW_URL="https://raw.githubusercontent.com/$installer_repo/$installer_br
 
 echo "Downloading the latest installer..."
 curl -O "$_RAW_URL"/installer_prep.sh
-sudo chmod +x installer_prep.sh \
-    && ./installer_prep.sh \
-    || exit "$?"  # Uses the exit code passed by 'installer_prep.sh'.
+sudo chmod +x installer_prep.sh && ./installer_prep.sh
+exit "$?"  # Uses the exit code passed by 'installer_prep.sh'.
 
 
 #### End of [ Main ]

Examples/example-2.md

@@ -4,6 +4,7 @@ The code below is from an installer project that can be refered to at this link:
 
 ```bash
 #!/bin/bash
+# shellcheck disable=SC2155
 #
 # This script looks at the operating system, architecture, bit type, etc., to determine
 # whether or not the system is supported by NadekoBot. Once the system is deemed as
@@ -19,26 +20,28 @@ The code below is from an installer project that can be refered to at this link:
 
 # Revision number of 'linuxAIO.sh'.
 # Refer to the 'README' note at the beginning of 'linuxAIO.sh' for more information.
-current_linuxAIO_revision="34"
+current_linuxAIO_revision=36
 # Name of the master installer script.
 master_installer="nadeko_main_installer.sh"
 
 ## Modify output text color.
-export _YELLOW=$'\033[1;33m'
-export _GREEN=$'\033[0;32m'
-export _CYAN=$'\033[0;36m'
-export _RED=$'\033[1;31m'
-export _NC=$'\033[0m'
-export _GREY=$'\033[0;90m'
-export _CLRLN=$'\r\033[K'
+export _YELLOW="$(printf '\033[1;33m')"
+export _GREEN="$(printf '\033[0;32m')"
+export _CYAN="$(printf '\033[0;36m')"
+export _RED="$(printf '\033[1;31m')"
+export _NC="$(printf '\033[0m')"
+export _GREY="$(printf '\033[0;90m')"
+export _CLRLN="$(printf '\r\033[K')"
 
 ## PURPOSE: The '--no-hostname' flag for 'journalctl' only works with systemd 230 and
 ##          later. So if systemd is older than 230, $_NO_HOSTNAME will not be created.
 {
-    journalctl_version=$(journalctl --version)
-    journalctl_version=${journalctl_version:1:1}
+    _SYSTEMD_VERSION_TMP=$(systemd --version)
+    # shellcheck disable=SC2206
+    _SYSTEMD_VERSION_TMP=($_SYSTEMD_VERSION_TMP)
+    export _SYSTEMD_VERSION=${_SYSTEMD_VERSION_TMP[1]}
 
-    if ((journalctl_version >= 230)); then export _NO_HOSTNAME="--no-hostname"
+    if ((_SYSTEMD_VERSION >= 230)); then export _NO_HOSTNAME="--no-hostname"
     fi
 } 2>/dev/null
 
@@ -75,15 +78,15 @@ detect_sys_info() {
     esac
 }
 
-# TODO: Add error checking to sed... If they fail, print the tracked variables into
-#       a new file.
+# TODO: Add error checking to sed... If they fail, print the tracked variables into a
+#       new file.
 linuxAIO_update() {
     ####
     # Function Info: Download the latest version of 'linuxAIO.sh' if $_LINUXAIO_REVISION
     #                and $current_linuxAIO_revision aren't of equal value.
     ####
 
-    echo "${_YELLOW}You are using an older version of 'linuxAIO.sh'$_NC"
+    echo "${_YELLOW}You are using an older version of 'linuxAIO.sh'${_NC}"
     echo "Downloading latest 'linuxAIO.sh'..."
 
     ## Only download the newest version of 'linuxAIO.sh'.
@@ -95,7 +98,7 @@ linuxAIO_update() {
         curl -O "$_RAW_URL"/linuxAIO.sh \
             && sudo chmod +x linuxAIO.sh
         echo "${_CYAN}NOT applying existing configurations to the new 'linuxAIO.sh'..."
-        echo "${_GREEN}Successfully downloaded the newest version of 'linuxAIO.sh'.$_NC"
+        echo "${_GREEN}Successfully downloaded the newest version of 'linuxAIO.sh'.${_NC}"
     ## Download the newest version of 'linuxAIO.sh' and apply existing changes to it.
     else
         ## Save the values of the current Configuration Variables specified in
@@ -127,10 +130,10 @@ linuxAIO_update() {
         fi
 
         echo "${_GREEN}Successfully downloaded the newest version of 'linuxAIO.sh'" \
-            "and applied changes to the newest version of 'linuxAIO.sh'$_NC"
+            "and applied changes to the newest version of 'linuxAIO.sh'${_NC}"
     fi
 
-    clean_up "0" "Exiting" "true"
+    clean_up "0" "Exiting"
 }
 
 unsupported() {
@@ -143,7 +146,7 @@ unsupported() {
         "for the installation, setup, and/or use of NadekoBot" >&2
     echo "${_YELLOW}WARNING: By continuing, you accept that unexpected behaviors" \
         "may occur. If you run into any errors or problems with the installation and" \
-        "use of the NadekoBot, you are on your own.$_NC"
+        "use of the NadekoBot, you are on your own.${_NC}"
     read -rp "Would you like to continue anyways? [y/N] " choice
 
     choice=$(echo "$choice" | tr '[:upper:]' '[:lower:]')
@@ -159,28 +162,28 @@ clean_up() {
     #                unless the installer is currently running.
     #
     # Parameters:
-    #   $1 - Exit status code.
-    #   $2 - Output text.
-    #   $3 - Determines if 'Cleaning up...' needs to be printed with a new-line symbol.
+    #   $1 - required
+    #       Exit status code.
+    #   $2 - required
+    #       Output text.
+    #   $3 - optional
+    #       True if 'Cleaning up...' should be printed with two new-line symbols.
     ####
 
     # Files to be removed.
-    local installer_files=("installer_prep.sh"  "file_backup.sh" "prereqs_installer.sh"
+    local installer_files=("installer_prep.sh" "file_backup.sh" "prereqs_installer.sh"
         "nadeko_latest_installer.sh" "nadeko_runner.sh" "nadeko_main_installer.sh")
 
-    if [[ $3 = true ]]; then echo "Cleaning up..."
+    if [[ $3 = true ]]; then echo -e "\n\nCleaning up..."
     else                     echo -e "\nCleaning up..."
     fi
 
     cd "$_WORKING_DIR" || {
-        echo "${_RED}Failed to move to project root directory$_NC" >&2
+        echo "${_RED}Failed to move to project root directory${_NC}" >&2
         exit 1
     }
 
     ## Remove 'nadekobot_tmp' if it exists.
-    ## EXPLANATION: 'nadekobot_tmp' contains a newly downloaded version of NadekoBot. If
-    ##              the installer is stopped while downloading NadekoBot, this directory
-    ##              will remain on the system, if this if statement doesn't exist.
     if [[ -d nadekobot_tmp ]]; then rm -rf nadekobot_tmp
     fi
 
@@ -214,11 +217,13 @@ _DOWNLOAD_SCRIPT() {
     #                permissions.
     #
     # Parameters:
-    #   $1 - Name of script to download.
-    #   $2 - True if the script shouldn't output text indicating $1 is being downloaded.
+    #   $1 - required
+    #       Name of script to download.
+    #   $2 - optional
+    #       True if the script shouldn't output text indicating $1 is being downloaded.
     ####
 
-    if [[ ! $2 ]]; then echo "Downloading '$1'..."
+    if [[ $2 = true ]]; then printf "Downloading '%s'..." "$1"
     fi
     curl -O -s "$_RAW_URL"/"$1"
     sudo chmod +x "$1"
@@ -235,8 +240,8 @@ _DOWNLOAD_SCRIPT() {
 
 # Execute when the user uses 'Ctrl + Z', 'Ctrl + C', or otherwise forcefully exits the
 # installer.
-trap 'clean_up "2" "Exiting" "true"' \
-    SIGINT SIGTSTP SIGTERM
+trap 'clean_up "130" "Exiting" "true"' SIGINT
+trap 'clean_up "143" "Exiting" "true"' SIGTERM
 
 
 #### End of [ Error Traps ]
@@ -248,14 +253,14 @@ trap 'clean_up "2" "Exiting" "true"' \
 # revision number.
 if [[ $_LINUXAIO_REVISION && $_LINUXAIO_REVISION != "$current_linuxAIO_revision" ]]; then
     linuxAIO_update
-    clean_up "0" "Exiting" "true"
+    clean_up "0" "Exiting"
 fi
 
 # Change the working directory to the location of the executed scrpt.
-cd "$(dirname "$0")" || {
+cd "${0%/*}" || {
     echo "${_RED}Failed to change working directory" >&2
-    echo "${_CYAN}Change your working directory to that of the executed script$_NC"
-    clean_up "1" "Exiting" "true"
+    echo "${_CYAN}Change your working directory to that of the executed script${_NC}"
+    clean_up "1" "Exiting"
 }
 
 export _WORKING_DIR="$PWD"