Merge pull request #29 from diogo464/dirname_fix

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

diff --git a/xdg-ninja.sh b/xdg-ninja.sh
index c7633c07ff94da6e236b0e9f979fde93cd2c85f8..b324a72e0e4d35ed8d36a3167aacf8438dfdf79c 100755 (executable)
--- a/xdg-ninja.sh
+++ b/xdg-ninja.sh
@@ -1,26 +1,89 @@
-#!/bin/bash
-
-USE_GLOW=true
-if ! command -v glow &> /dev/null
-then
-    echo "Glow not found, markdown rendering not available."
-    USE_GLOW=false
+#!/usr/bin/env sh
+# shellcheck disable=SC2016
+
+USE_GLOW=false
+USE_BAT=false
+if command -v glow >/dev/null 2>/dev/null; then
+    USE_GLOW=true
+elif command -v bat >/dev/null 2>/dev/null; then
+    USE_BAT=true
+    printf "Glow not found, markdown rendering will be done by bat.\n"
+    printf "Install glow for easier reading & copy-paste.\n"
+else
+    printf "Glow or bat not found, markdown rendering not available.\n"
+    printf "Output will be raw markdown and might look weird.\n"
+    printf "Install glow for easier reading & copy-paste.\n"

 fi
 
 unalias -a
 
 fi
 
 unalias -a
 

-ERR=0
-WARN=1
-INFO=2
-SUCS=3
-HELP=4
+HELPSTRING="""\
+
+
+    \033[37;45;1mxdg-ninja\033[0m
+
+    \033[1;3mCheck your \$HOME for unwanted files.\033[1;0m
+
+    ────────────────────────────────────
+
+    \033[3m--help\033[0m              \033[1mThis help menu\033[0m
+    \033[3m-h\033[0m
+
+    \033[3m--no-skip-ok\033[0m        \033[1mDisplay messages for all files checked (verbose)\033[0m
+    \033[3m-v\033[0m
+
+    \033[3m--skip-ok\033[0m           \033[1mDon't display anything for files that do not exist (default)\033[0m
+
+"""
+
+SKIP_OK=true
+for i in "$@"; do
+    if [ "$i" = "--help" ] || [ "$i" = "-h" ]; then
+        printf "%b" "$HELPSTRING"
+        exit
+    elif [ "$i" = "--skip-ok" ]; then
+        SKIP_OK=true
+    elif [ "$i" = "--no-skip-ok" ]; then
+        SKIP_OK=false
+    elif [ "$i" = "-v" ]; then
+        SKIP_OK=false
+    fi
+done
+
+if [ -z "${XDG_DATA_HOME}" ]; then
+    printf '\033[1;36m%s\033[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 '\033[1;36m    ⤷ \033[1mThe recommended value is: \033[1;3m$HOME/.local/share\033[1;0m\n'
+fi
+if [ -z "${XDG_CONFIG_HOME}" ]; then
+    printf '\033[1;36m%s\033[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 '\033[1;36m    ⤷ \033[1mThe recommended value is: \033[1;3m$HOME/.config\033[1;0m\n'
+fi
+if [ -z "${XDG_STATE_HOME}" ]; then
+    printf '\033[1;36m%s\033[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 '\033[1;36m    ⤷ \033[1mThe recommended value is: \033[1;3m$HOME/.local/state\033[1;0m\n'
+fi
+if [ -z "${XDG_CACHE_HOME}" ]; then
+    printf '\033[1;36m%s\033[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 '\033[1;36m    ⤷ \033[1mThe recommended value is: \033[1;3m$HOME/.cache\033[1;0m\n'
+fi
+if [ -z "${XDG_RUNTIME_DIR}" ]; then
+    printf '\033[1;36m%s\033[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 '\033[1;36m    ⤷ \033[1mThe recommended value is: \033[1;3m/run/user/$UID\033[1;0m\n'
+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."
+    exit
+fi
+
+printf "\n"

 
 

-# Function to expand enviornment variables in string
+# Function to expand environment variables in string

 # https://stackoverflow.com/a/20316582/11110290
 apply_shell_expansion() {
 # 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"
 }
 
     eval "$command"
 }
 


@@ -37,7 +100,6 @@ check_not_exists_file() {
     fi
 }
 
     fi
 }
 

-

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


@@ -47,29 +109,32 @@ log() {
 
     case "$MODE" in
 
 
     case "$MODE" in
 

-        ERR)
-            printf "[\e[1;31m$NAME\e[1;0m]: \e[1;3m$FILENAME\e[1;0m\n"
-            ;;
-
-        WARN)
-            printf "[\e[1;33m$NAME\e[1;0m]: \e[1;3m$FILENAME\e[1;0m\n"
-            ;;
-
-        INFO)
-            printf "[\e[1;36m$NAME\e[1;0m]: \e[1;3m$FILENAME\e[1;0m\n"
-            ;;
-
-        SUCS)
-            printf "[\e[1;32m$NAME\e[1;0m]: \e[1;3m$FILENAME\e[1;0m\n"
-            ;;
-
-        HELP)
-            if $USE_GLOW; then
-                echo "$HELP" | glow -
-            else
-                echo "$HELP"
-            fi
-            ;;
+    ERR)
+        printf '[\033[1;31m%s\033[1;0m]: \033[1;3m%s\033[1;0m\n' "$NAME" "$FILENAME"
+        ;;
+
+    WARN)
+        printf '[\033[1;33m%s\033[1;0m]: \033[1;3m%s\033[1;0m\n' "$NAME" "$FILENAME"
+        ;;
+
+    INFO)
+        printf '[\033[1;36m%s\033[1;0m]: \033[1;3m%s\033[1;0m\n' "$NAME" "$FILENAME"
+        ;;
+
+    SUCS)
+        [ "$SKIP_OK" = false ] &&
+            printf '[\033[1;32m%s\033[1;0m]: \033[1;3m%s\033[1;0m\n' "$NAME" "$FILENAME"
+        ;;
+
+    HELP)
+        if $USE_GLOW; then
+            printf "%s\n" "$HELP" | glow -
+        elif $USE_BAT; then
+            printf "%s\n" "$HELP" | bat -pp -f --language markdown
+        else
+            printf "%s\n" "$HELP"
+        fi
+        ;;

 
     esac
 }
 
     esac
 }


@@ -79,52 +144,58 @@ check_file() {
     INPUT="$1"
     NAME="$2"
 
     INPUT="$1"
     NAME="$2"
 

-    FILENAME=$(echo -E "$INPUT" | jq -r .path)
-    MOVABLE=$(echo -E "$INPUT" | jq -r .movable)
-    HELP=$(echo -E "$INPUT" | jq -r .help)
+    FILENAME=$(printf "%s" "$INPUT" | jq -r .path)
+    MOVABLE=$(printf "%s" "$INPUT" | jq -r .movable)
+    HELP=$(printf "%s" "$INPUT" | jq -r .help)

 
     check_not_exists_file "$FILENAME"
 
     case $? in
 
 
     check_not_exists_file "$FILENAME"
 
     case $? in
 

-        0)
-            log SUCS "$NAME" "$FILENAME" "$HELP"
-            ;;
-
-        1 | 2)
-            if "$MOVABLE"; then
-                log ERR "$NAME" "$FILENAME" "$HELP"
-            else
-                log WARN "$NAME" "$FILENAME" "$HELP"
-            fi
-            if ! [ -z "$HELP" ]; then
-                log HELP "$NAME" "$FILENAME" "$HELP"
-            else
-                log HELP "$NAME" "$FILENAME" "_No help available._"
-            fi
-            ;;
+    0)
+        log SUCS "$NAME" "$FILENAME" "$HELP"
+        ;;
+
+    1 | 2)
+        if "$MOVABLE"; then
+            log ERR "$NAME" "$FILENAME" "$HELP"
+        else
+            log WARN "$NAME" "$FILENAME" "$HELP"
+        fi
+        if [ "$HELP" ]; then
+            log HELP "$NAME" "$FILENAME" "$HELP"
+        else
+            log HELP "$NAME" "$FILENAME" "_No help available._"
+        fi
+        ;;

 
     esac
 }
 
 # Reads a file from programs/, calls check_file on each file specified for the program
 check_program() {
 
     esac
 }
 
 # Reads a file from programs/, calls check_file on each file specified for the program
 check_program() {

-    INPUT=$1
-
-    NAME=$(echo "$INPUT" | jq -r .name)
+    PROGRAM=$1

 
 

-    
+    NAME=$(jq -r .name "$PROGRAM")

 
     while IFS= read -r file; do
         check_file "$file" "$NAME"
 
     while IFS= read -r file; do
         check_file "$file" "$NAME"

-    done <<< "$(echo "$INPUT" | jq -rc '.files[]')"
+    done <<EOF
+$(jq -rc '.files[]' "$PROGRAM")
+EOF

 }
 
 # Loops over all files in the programs/ directory and calls check_program
 enumerate_programs() {
 }
 
 # Loops over all files in the programs/ directory and calls check_program
 enumerate_programs() {

-    for prog_filename in "./programs/*"; do
-        check_program "$(cat $prog_filename)"
+    printf "\033[1;3mStarting to check your \033[1;36m\$HOME.\033[1;0m\n"
+    printf "\n"
+    for prog_filename in "$(dirname "$0")"/programs/*; do
+        check_program "$prog_filename"

     done
     done

+    printf "\033[1;3mDone checking your \033[1;36m\$HOME.\033[1;0m\n"
+    printf "\n"
+    printf "\033[3mIf you have files in your \033[1;36m\$HOME\033[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.\033[1;0m\n"
+    printf "\n"

 }
 
 enumerate_programs
 }
 
 enumerate_programs