feat(LOGGING): options to manage newlines

cicd-tools/boxes/0.1.0/libraries/environment.sh

@@ -19,6 +19,10 @@ environment() {
 }
 
 _environment_args() {
+  local OPTARG
+  local OPTIND
+  local OPTION
+
   while getopts "m:o:d:" OPTION; do
     case "$OPTION" in
       m)

cicd-tools/boxes/0.1.0/libraries/logging.sh

@@ -11,9 +11,13 @@ source "$(dirname -- "${BASH_SOURCE[0]}")/colours.sh"
 LOGGING_LEVEL=${LOGGING_LEVEL-"DEBUG"}
 
 function log() {
+
   # USAGE:
-  # colour bg [CRITICAL|ERROR|WARNING|INFO|DEBUG] [MESSAGE CONTENTS]
+  # log (-b) (-n) [CRITICAL|ERROR|WARNING|INFO|DEBUG] [MESSAGE CONTENTS]
 
+  local LOGGING_MESSAGE_CONTENT
+  local LOGGING_MESSAGE_LEVEL
+  local LOGGING_NEW_LINE="\n"
   local LOGGING_SEVERITY_LEVELS=("DEBUG" "INFO" "WARNING" "ERROR" "CRITICAL")
 
   # shellcheck disable=SC2034
@@ -28,21 +32,50 @@ function log() {
   local DEBUG="CYAN"
   # shellcheck disable=SC2034
 
-  local LOGGING_MESSAGE_LEVEL="${1}"
-  local MESSAGE_CONTENT="${2}"
-
-  if [[ -z "${!LOGGING_LEVEL}" ]] ||
-    [[ -z "${MESSAGE_CONTENT}" ]]; then
-    log "ERROR" "Invalid logging statement!"
-    return 127
-  fi
+  _log_args "$@"
 
   if [[ "$(_log_get_severity_level "${LOGGING_MESSAGE_LEVEL}")" -ge "$(_log_get_severity_level "${LOGGING_LEVEL}")" ]]; then
-    echo "[$(date -u)] [$(colour fg "${!LOGGING_MESSAGE_LEVEL}")${LOGGING_MESSAGE_LEVEL}$(colour clear)] ${MESSAGE_CONTENT}" >> /dev/stderr
+    echo \
+      -e \
+      -n \
+      "[$(date -u)] [$(colour fg "${!LOGGING_MESSAGE_LEVEL}")${LOGGING_MESSAGE_LEVEL}$(colour clear)] ${LOGGING_MESSAGE_CONTENT}${LOGGING_NEW_LINE}" \
+      >> /dev/stderr
   fi
 
 }
 
+function _log_args() {
+  local OPTIND
+  local OPTION
+
+  while getopts "bn" OPTION; do
+    case "$OPTION" in
+      b)
+        LOGGING_NEW_LINE="\n\n"
+        ;;
+      n)
+        LOGGING_NEW_LINE=""
+        ;;
+      \?)
+        _logging_usage
+        ;;
+      *)
+        continue
+        ;;
+    esac
+  done
+  shift $((OPTIND - 1))
+
+  LOGGING_MESSAGE_LEVEL="${1}"
+  LOGGING_MESSAGE_CONTENT="${2}"
+
+  if [[ -z "${!LOGGING_LEVEL}" ]] ||
+    [[ -z "${LOGGING_MESSAGE_CONTENT}" ]]; then
+    echo "ERROR" "Invalid logging statement!"
+    return 127
+  fi
+}
+
 function _log_get_severity_level() {
   #1: The severity type as a string.
   local LOGGIN_SEVERITY_LEVEL
@@ -52,3 +85,10 @@ function _log_get_severity_level() {
     fi
   done
 }
+
+function _logging_usage() {
+  echo "ERROR" "USAGE: log (-b) (-n) [CRITICAL|ERROR|WARNING|INFO|DEBUG] [MESSAGE CONTENTS]"
+  echo "ERROR" "   -b    Optionally add an additional newline after logging message."
+  echo "ERROR" "   -n    Optionally disable adding a newline after logging message."
+  return 127
+}