Use variables for ANSI codes

[xdg-ninja.git] / xdg-ninja.sh

diff --git a/xdg-ninja.sh b/xdg-ninja.sh
index b65844d55ae210c5a51de38e67f23ed293b752e6..4783223bea8b119d7b2c2a4d2125538c3898eb63 100755 (executable)
--- a/xdg-ninja.sh
+++ b/xdg-ninja.sh
@@ -1,38 +1,77 @@
-#!/usr/bin/env bash
-
-USE_GLOW=true
-if ! command -v glow >/dev/null 2>/dev/null; then
-    printf "Glow not found, markdown rendering not available."
-    printf "Output will be raw markdown and might look weird."
-    printf "Install glow for easier reading & copy-paste."
-    USE_GLOW=false
+#!/usr/bin/env sh
+
+has_command() {
+    command -v "$1" >/dev/null 2>/dev/null
+    return $?
+}
+
+USE_GLOW=false
+USE_BAT=false
+USE_PYGMENTIZE=false
+USE_HIGHLIGHT=false
+if has_command glow; then
+    USE_GLOW=true
+else
+    if has_command bat; then
+        USE_BAT=true
+        printf "Markdown rendering will be done by bat. (Glow is recommended)\n"
+    elif has_command pygmentize; then
+        printf "Markdown rendering will be done by pygmentize. (Glow is recommended)\n"
+        USE_PYGMENTIZE=true
+    elif has_command highlight; then
+        printf "Markdown rendering will be done by highlight. (Glow is recommended)\n"
+        USE_HIGHLIGHT=true
+    else
+        printf "Markdown rendering not available. (Glow is recommended)\n"
+        printf "Output will be raw markdown and might look weird.\n"
+    fi
+    printf "Install glow for easier reading & copy-paste.\n"

 fi
 
 unalias -a
 
 fi
 
 unalias -a
 

-HELPSTRING="""\
+init_constants() {
+    FX_RESET="\033[0m"
+    FX_BOLD="\033[1m"
+    FX_ITALIC="\033[3m"
+
+    FG_RED="\033[31m"
+    FG_GREEN="\033[32m"
+    FG_YELLOW="\033[33m"
+    FG_CYAN="\033[36m"
+    FG_WHITE="\033[37m"
+
+    BG_MAGENTA="\033[45m"
+}
+init_constants
+
+help() {
+    init_constants
+    HELPSTRING="""\

 
 
 
 

-    \e[37;45;1mxdg-ninja\e[0m
+    ${FG_WHITE}${BG_MAGENTA}${FX_BOLD}xdg-ninja${FX_RESET}

 
 

-    \e[1;3mCheck your \$HOME for unwanted files.\e[1;0m
+    ${FX_BOLD}${FX_ITALIC}Check your \$HOME for unwanted files.${FX_RESET}

 
     ────────────────────────────────────
 
 
     ────────────────────────────────────
 

-    \e[3m--help\e[0m              \e[1mThis help menu\e[0m
-    \e[3m-h\e[0m
+    ${FX_ITALIC}--help${FX_RESET}              ${FX_BOLD}This help menu${FX_RESET}
+    ${FX_ITALIC}-h\033${FX_RESET}

 
 

-    \e[3m--no-skip-ok\e[0m        \e[1mDisplay messages for all files checked (verbose)\e[0m
-    \e[3m-v\e[0m
+    ${FX_ITALIC}--no-skip-ok${FX_RESET}        ${FX_BOLD}Display messages for all files checked (verbose)${FX_RESET}
+    ${FX_ITALIC}-v${FX_RESET}

 
 

-    \e[3m--skip-ok\e[0m           \e[1mDon't display anything for files that do not exist (default)\e[0m
+    ${FX_ITALIC}--skip-ok${FX_RESET}           ${FX_BOLD}Don't display anything for files that do not exist (default)${FX_RESET}

 
 

-"""
+    """
+    printf "%b" "$HELPSTRING"
+}

 
 SKIP_OK=true
 for i in "$@"; do
     if [ "$i" = "--help" ] || [ "$i" = "-h" ]; then
 
 SKIP_OK=true
 for i in "$@"; do
     if [ "$i" = "--help" ] || [ "$i" = "-h" ]; then

-        printf "%b" "$HELPSTRING"
+        help

         exit
     elif [ "$i" = "--skip-ok" ]; then
         SKIP_OK=true
         exit
     elif [ "$i" = "--skip-ok" ]; then
         SKIP_OK=true


@@ -44,28 +83,28 @@ for i in "$@"; do
 done
 
 if [ -z "${XDG_DATA_HOME}" ]; then
 done
 
 if [ -z "${XDG_DATA_HOME}" ]; then

-    printf '\e[1;36m%s\e[1;0m\n' "The \$XDG_DATA_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!"
-    printf '\e[1;36m    ⤷ \e[1mThe recommended value is: \e[1;3m$HOME/.local/share\e[1;0m\n'
+    printf '%b%s%b\n' "${FX_BOLD}${FG_CYAN}" "The \$XDG_DATA_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!" "${FX_RESET}"
+    printf "%b    ⤷ The recommended value is: %b\$HOME/.local/share%b\n" "${FX_BOLD}${FG_CYAN}" "${FX_BOLD}${FX_ITALIC}" "${FX_RESET}"

 fi
 if [ -z "${XDG_CONFIG_HOME}" ]; then
 fi
 if [ -z "${XDG_CONFIG_HOME}" ]; then

-    printf '\e[1;36m%s\e[1;0m\n' "The \$XDG_CONFIG_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!"
-    printf '\e[1;36m    ⤷ \e[1mThe recommended value is: \e[1;3m$HOME/.config\e[1;0m\n'
+    printf '%b%s%b\n' "${FX_BOLD}${FG_CYAN}" "The \$XDG_CONFIG_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!" "${FX_RESET}"
+    printf "%b    ⤷ The recommended value is: %b\$HOME/.config%b\n" "${FX_BOLD}${FG_CYAN}" "${FX_BOLD}${FX_ITALIC}" "${FX_RESET}"

 fi
 if [ -z "${XDG_STATE_HOME}" ]; then
 fi
 if [ -z "${XDG_STATE_HOME}" ]; then

-    printf '\e[1;36m%s\e[1;0m\n' "The \$XDG_STATE_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!"
-    printf '\e[1;36m    ⤷ \e[1mThe recommended value is: \e[1;3m$HOME/.local/state\e[1;0m\n'
+    printf '%b%s%b\n' "${FX_BOLD}${FG_CYAN}" "The \$XDG_STATE_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!" "${FX_RESET}"
+    printf "%b    ⤷ The recommended value is: %b\$HOME/.local/state%b\n" "${FX_BOLD}${FG_CYAN}" "${FX_BOLD}${FX_ITALIC}" "${FX_RESET}"

 fi
 if [ -z "${XDG_CACHE_HOME}" ]; then
 fi
 if [ -z "${XDG_CACHE_HOME}" ]; then

-    printf '\e[1;36m%s\e[1;0m\n' "The \$XDG_CACHE_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!"
-    printf '\e[1;36m    ⤷ \e[1mThe recommended value is: \e[1;3m$HOME/.cache\e[1;0m\n'
+    printf '%b%s%b\n' "${FX_BOLD}${FG_CYAN}" "The \$XDG_CACHE_HOME environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!" "${FX_RESET}"
+    printf "%b    ⤷ The recommended value is: %b\$HOME/.cache%b\n" "${FX_BOLD}${FG_CYAN}" "${FX_BOLD}${FX_ITALIC}" "${FX_RESET}"

 fi
 if [ -z "${XDG_RUNTIME_DIR}" ]; then
 fi
 if [ -z "${XDG_RUNTIME_DIR}" ]; then

-    printf '\e[1;36m%s\e[1;0m\n' "The \$XDG_RUNTIME_DIR environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!"
-    printf '\e[1;36m    ⤷ \e[1mThe recommended value is: \e[1;3m/run/user/$UID\e[1;0m\n'
+    printf '%b%s%b\n' "${FX_BOLD}${FG_CYAN}" "The \$XDG_RUNTIME_DIR environment variable is not set, make sure to add it to your shell's configuration before setting any of the other environment variables!" "${FX_RESET}"
+    printf "%b    ⤷ The recommended value is: %b/run/user/\$UID%b\n" "${FX_BOLD}${FG_CYAN}" "${FX_BOLD}${FX_ITALIC}" "${FX_RESET}"

 fi
 
 if ! command -v jq >/dev/null 2>/dev/null; then
 fi
 
 if ! command -v jq >/dev/null 2>/dev/null; then

-    printf "jq is needed to run this script, but it wasn't found. Please install it to be able to use this script."
+    printf "jq is needed to run this script, but it wasn't found. Please install it to be able to use this script.\n"

     exit
 fi
 
     exit
 fi
 


@@ -74,25 +113,30 @@ printf "\n"
 # Function to expand environment variables in string
 # https://stackoverflow.com/a/20316582/11110290
 apply_shell_expansion() {
 # Function to expand environment variables in string
 # https://stackoverflow.com/a/20316582/11110290
 apply_shell_expansion() {

-    declare data="$1"
-    declare delimiter="__apply_shell_expansion_delimiter__"
-    declare command="cat <<$delimiter"$'\n'"$data"$'\n'"$delimiter"
+    data="$1"
+    delimiter="__apply_shell_expansion_delimiter__"
+    command=$(printf "cat <<%s\n%s\n%s" "$delimiter" "$data" "$delimiter")

     eval "$command"
 }
 
 # Returns 0 if the path doesn't lead anywhere
     eval "$command"
 }
 
 # Returns 0 if the path doesn't lead anywhere

-# Return 1 if the path points to a file, 2 if it points to a directory
-check_not_exists_file() {
+# Returns 1 if the path leads to something
+check_if_file_exists() {

     FILE_PATH=$(apply_shell_expansion "$1")
     FILE_PATH=$(apply_shell_expansion "$1")

-    if [ -f "$FILE_PATH" ]; then
+    if [ -e "$FILE_PATH" ]; then

         return 1
         return 1

-    elif [ -d "$FILE_PATH" ]; then
-        return 2

     else
         return 0
     fi
 }
 
     else
         return 0
     fi
 }
 

+decode_string() {
+    printf "%s" "$1" | sed -e 's/\\n/\
+/g' -e 's/\\\"/\"/g' -e '$ s/\n*$/\
+\
+/' # Replace \n with literal newline and \" with ", normalize number of trailing newlines to 2
+}
+

 # Function to handle the formatting of output
 log() {
     MODE="$1"
 # Function to handle the formatting of output
 log() {
     MODE="$1"


@@ -103,27 +147,34 @@ log() {
     case "$MODE" in
 
     ERR)
     case "$MODE" in
 
     ERR)

-        printf '[\e[1;31m%s\e[1;0m]: \e[1;3m%s\e[1;0m\n' "$NAME" "$FILENAME"
+        printf '[%b%s%b]: %b%s%b\n' "${FX_BOLD}${FG_RED}" "$NAME" "${FX_RESET}" "${FX_BOLD}${FX_ITALIC}" "$FILENAME" "${FX_RESET}"

         ;;
 
     WARN)
         ;;
 
     WARN)

-        printf '[\e[1;33m%s\e[1;0m]: \e[1;3m%s\e[1;0m\n' "$NAME" "$FILENAME"
+        printf '[%b%s%b]: %b%s%b\n' "${FX_BOLD}${FG_YELLOW}" "$NAME" "${FX_RESET}" "${FX_BOLD}${FX_ITALIC}" "$FILENAME" "${FX_RESET}"

         ;;
 
     INFO)
         ;;
 
     INFO)

-        printf '[\e[1;36m%s\e[1;0m]: \e[1;3m%s\e[1;0m\n' "$NAME" "$FILENAME"
+        printf '[%b%s%b]: %b%s%b\n' "${FX_BOLD}${FG_CYAN}" "$NAME" "${FX_RESET}" "${FX_BOLD}${FX_ITALIC}" "$FILENAME" "${FX_RESET}"

         ;;
 
     SUCS)
         [ "$SKIP_OK" = false ] &&
         ;;
 
     SUCS)
         [ "$SKIP_OK" = false ] &&

-            printf '[\e[1;32m%s\e[1;0m]: \e[1;3m%s\e[1;0m\n' "$NAME" "$FILENAME"
+            printf '[%b%s%b]: %b%s%b\n' "${FX_BOLD}${FG_GREEN}" "$NAME" "${FX_RESET}" "${FX_BOLD}${FX_ITALIC}" "$FILENAME" "${FX_RESET}"

         ;;
 
     HELP)
         ;;
 
     HELP)

-        if $USE_GLOW; then
-            printf "%s" "$HELP" | glow -
+        if [ "$USE_GLOW" = true ]; then
+            decode_string "$HELP" | glow -
+        elif [ "$USE_BAT" = true ]; then
+            decode_string "$HELP" | bat -pp --decorations=always --color=always --language markdown
+        elif [ $USE_PYGMENTIZE = true ]; then
+            decode_string "$HELP" | pygmentize -l markdown
+            printf "\n"
+        elif [ $USE_HIGHLIGHT = true ]; then
+            decode_string "$HELP" | highlight --out-format ansi --syntax markdown

         else
         else

-            printf "%s" "$HELP"
+            decode_string "$HELP"

         fi
         ;;
 
         fi
         ;;
 


@@ -132,14 +183,12 @@ log() {
 
 # Checks that the given file does not exist, otherwise outputs help
 check_file() {
 
 # Checks that the given file does not exist, otherwise outputs help
 check_file() {

-    INPUT="$1"
-    NAME="$2"
-
-    FILENAME=$(printf "%s" "$INPUT" | jq -r .path)
-    MOVABLE=$(printf "%s" "$INPUT" | jq -r .movable)
-    HELP=$(printf "%s" "$INPUT" | jq -r .help)
+    NAME="$1"
+    FILENAME="$2"
+    MOVABLE="$3"
+    HELP="$4"

 
 

-    check_not_exists_file "$FILENAME"
+    check_if_file_exists "$FILENAME"

 
     case $? in
 
 
     case $? in
 


@@ -147,8 +196,8 @@ check_file() {
         log SUCS "$NAME" "$FILENAME" "$HELP"
         ;;
 
         log SUCS "$NAME" "$FILENAME" "$HELP"
         ;;
 

-    1 | 2)
-        if "$MOVABLE"; then
+    1)
+        if [ "$MOVABLE" = true ]; then

             log ERR "$NAME" "$FILENAME" "$HELP"
         else
             log WARN "$NAME" "$FILENAME" "$HELP"
             log ERR "$NAME" "$FILENAME" "$HELP"
         else
             log WARN "$NAME" "$FILENAME" "$HELP"


@@ -163,28 +212,26 @@ check_file() {
     esac
 }
 
     esac
 }
 

-# Reads a file from programs/, calls check_file on each file specified for the program
-check_program() {
-    INPUT=$1
-
-    NAME=$(printf "%s" "$INPUT" | jq -r .name)
-
-    while IFS= read -r file; do
-        check_file "$file" "$NAME"
-    done <<<"$(printf "%s" "$INPUT" | jq -rc '.files[]')"
+# Reads files from programs/, calls check_file on each file specified for each program
+do_check_programs() {
+    while IFS="
+" read -r name; read -r filename; read -r movable; read -r help; do
+        check_file "$name" "$filename" "$movable" "$help"
+    done <<EOF
+$(jq 'inputs as $input | $input.files[] as $file | $input.name, $file.path, $file.movable, $file.help' "$(dirname "$0")"/programs/* | sed -e 's/^"//' -e 's/"$//')
+EOF
+# sed is to trim quotes

 }
 
 }
 

-# Loops over all files in the programs/ directory and calls check_program
-enumerate_programs() {
-    printf "\e[1;3mStarting to check your \e[1;36m\$HOME.\e[1;0m\n"
+check_programs() {
+    printf "%bStarting to check your %b\$HOME%b.\n" "${FX_BOLD}${FX_ITALIC}" "${FG_CYAN}" "${FX_RESET}"

     printf "\n"
     printf "\n"

-       for prog_filename in "$(dirname "${BASH_SOURCE[0]}")"/programs/*; do
-        check_program "$(cat "$prog_filename")"
-    done
-    printf "\e[1;3mDone checking your \e[1;36m\$HOME.\e[1;0m\n"
+    do_check_programs
+    printf "%bDone checking your %b\$HOME.%b\n" "${FX_BOLD}${FX_ITALIC}" "${FG_CYAN}" "${FX_RESET}"

     printf "\n"
     printf "\n"

-    printf "\e[3mIf you have files in your \e[1;36m\$HOME\e[1;0m that shouldn't be there, but weren't recognised by xdg-ninja, please consider creating a configuration file for it and opening a pull request on github.\e[1;0m\n"
+    printf "%bIf you have files in your %b\$HOME%b that shouldn't be there, but weren't recognised by xdg-ninja, please consider creating a configuration file for it and opening a pull request on github.%b\n" "${FX_ITALIC}" "${FG_CYAN}" "${FX_RESET}${FX_ITALIC}" "${FX_RESET}"

     printf "\n"
 }
 
     printf "\n"
 }
 

-enumerate_programs
+
+check_programs