-#!/usr/bin/env bash
-
-USE_GLOW=true
-if ! command -v glow &>/dev/null; then
- echo "Glow not found, markdown rendering not available."
- echo "Output will be raw markdown and might look weird."
- echo "Install glow for easier reading & copy-paste."
- USE_GLOW=false
-fi
+#!/usr/bin/env sh
+
+has_command() {
+ command -v "$1" >/dev/null 2>/dev/null
+ return $?
+}
+
+auto_set_decoder() {
+ DECODER="cat"
+ if has_command glow; then
+ DECODER="glow -"
+ elif has_command batcat; then
+ DECODER="batcat -pp --decorations=always --color=always --language markdown"
+ printf "Markdown rendering will be done by bat. (Glow is recommended)\n"
+ elif has_command bat; then
+ DECODER="bat -pp --decorations=always --color=always --language markdown"
+ printf "Markdown rendering will be done by bat. (Glow is recommended)\n"
+ elif has_command pygmentize; then
+ DECODER="pygmentize -l markdown"
+ printf "Markdown rendering will be done by pygmentize. (Glow is recommended)\n"
+ elif has_command highlight; then
+ DECODER="highlight --out-format ansi --syntax markdown"
+ printf "Markdown rendering will be done by highlight. (Glow is recommended)\n"
+ else
+ printf "Install glow for easier reading & copy-paste.\n"
+ fi
+}
+auto_set_decoder
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}
-"""
+ ${FX_ITALIC}--skip-unsupported${FX_RESET} ${FX_BOLD}Don't display anything for files that do not have fixes available${FX_RESET}
+
+ """
+ printf "%b\n" "$HELPSTRING"
+}
SKIP_OK=true
+SKIP_UNSUPPORTED=false
for i in "$@"; do
- if [ $i == "--help" ] || [ $i == "-h" ]; then
- echo -e "$HELPSTRING"
+ if [ "$i" = "--help" ] || [ "$i" = "-h" ]; then
+ help
exit
- elif [ $i == "--skip-ok" ]; then
+ elif [ "$i" = "--skip-ok" ]; then
SKIP_OK=true
- elif [ $i == "--no-skip-ok" ]; then
+ elif [ "$i" = "--no-skip-ok" ]; then
SKIP_OK=false
- elif [ $i == "-v" ]; then
+ elif [ "$i" = "--skip-unsupported" ]; then
+ SKIP_UNSUPPORTED=true
+ elif [ "$i" = "-v" ]; then
SKIP_OK=false
fi
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
- 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
- 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
- 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
- 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; then
- echo "jq is needed to run this script, but it wasn't found. Please install it to be able to use this script."
+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.\n"
exit
fi
+printf "\n"
+
# 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
-# Return 1 if the path points to a file, 2 if it points to a directory
-check_not_exists_file() {
- FILE_PATH=$(apply_shell_expansion "$1")
- if [ -f "$FILE_PATH" ]; then
+# Function to check if a string contains shell pattern matching
+has_pattern() {
+ case $1 in
+ *\** | *\?* | *\[*\]*)
+ return 0
+ ;;
+ *)
return 1
- elif [ -d "$FILE_PATH" ]; then
- return 2
+ ;;
+ esac
+}
+
+# Returns the actual name of the given file that is on the user's disk
+# This command applies shell pattern matching and return the actual filename
+retrieve_existing_filename() {
+ FILE_PATH=$(apply_shell_expansion "$1")
+
+ # return filename if found, nothing else
+ if has_pattern "$FILE_PATH"; then
+ dir="$(dirname "$FILE_PATH")"
+ part="$(basename "$FILE_PATH")"
+ find "$dir" -maxdepth 1 -name "$part" -print -quit 2>/dev/null
else
- return 0
+ if [ -e "$FILE_PATH" ]; then
+ printf "%s" "$FILE_PATH"
+ fi
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
+}
+
+# Counter to keep track of how many files can be moved
+FIXABLE=0
+
# Function to handle the formatting of output
log() {
MODE="$1"
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}"
+ FIXABLE=$((FIXABLE+1))
;;
WARN)
- printf '[\e[1;33m%s\e[1;0m]: \e[1;3m%s\e[1;0m\n' "$NAME" "$FILENAME"
+ [ "$SKIP_UNSUPPORTED" = false ] &&
+ printf '[%b%s%b]: %b%s%b\n' "${FX_BOLD}${FG_YELLOW}" "$NAME" "${FX_RESET}" "${FX_BOLD}${FX_ITALIC}" "$FILENAME" "${FX_RESET}"
;;
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 ] &&
- 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)
- if $USE_GLOW; then
- echo "$HELP" | glow -
- else
- echo "$HELP"
- fi
+ decode_string "$HELP" | PAGER="cat" $DECODER
;;
esac
# Checks that the given file does not exist, otherwise outputs help
check_file() {
- 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)
-
- check_not_exists_file "$FILENAME"
-
- case $? in
+ NAME="$1"
+ FILENAME="$2"
+ MOVABLE="$3"
+ HELP="$4"
- 0)
- log SUCS "$NAME" "$FILENAME" "$HELP"
- ;;
+ file=$(retrieve_existing_filename "$FILENAME")
- 1 | 2)
- if "$MOVABLE"; then
- log ERR "$NAME" "$FILENAME" "$HELP"
+ if [ "$file" ]; then
+ if [ "$MOVABLE" = true ]; then
+ log ERR "$NAME" "$file" "$HELP"
else
- log WARN "$NAME" "$FILENAME" "$HELP"
+ log WARN "$NAME" "$file" "$HELP"
fi
if [ "$HELP" ]; then
- log HELP "$NAME" "$FILENAME" "$HELP"
+ if [ "$MOVABLE" = true ] || [ "$SKIP_UNSUPPORTED" = false ]; then
+ log HELP "$NAME" "$file" "$HELP"
+ fi
else
- log HELP "$NAME" "$FILENAME" "_No help available._"
+ log HELP "$NAME" "$file" "_No help available._"
fi
- ;;
-
- esac
+ else
+ log SUCS "$NAME" "$file" "$HELP"
+ fi
}
-# 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)
-
- while IFS= read -r file; do
- check_file "$file" "$NAME"
- done <<<"$(echo "$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 '.files[] as $file | .name, $file.path, $file.movable, $file.help' "$XN_PROGRAMS_DIR"/* | 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() {
- echo -e "\e[1;3mStarting to check your \e[1;36m\$HOME.\e[1;0m"
- echo -e ""
- for prog_filename in "$(dirname "${BASH_SOURCE[0]}")"/programs/*; do
- check_program "$(cat "$prog_filename")"
- done
- echo -e "\e[1;3mDone checking your \e[1;36m\$HOME.\e[1;0m"
- echo -e ""
- echo -e "\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"
- echo -e ""
+check_programs() {
+ printf "%bStarting to check your %b\$HOME%b.\n" "${FX_BOLD}${FX_ITALIC}" "${FG_CYAN}" "${FX_RESET}"
+ printf "\n"
+ do_check_programs
+ printf "%bDone checking your %b\$HOME.%b\n" "${FX_BOLD}${FX_ITALIC}" "${FG_CYAN}" "${FX_RESET}"
+ printf "\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"
}
-enumerate_programs
+[ "$XN_PROGRAMS_DIR" ] ||
+ XN_PROGRAMS_DIR="$(realpath "$0" | xargs dirname | sed 's:/bin$:/share/xdg-ninja:g')/programs"
+
+check_programs
+if [ $FIXABLE -gt 100 ]; then
+ exit 101
+else
+ exit $FIXABLE
+fi
projects / xdg-ninja.git / blobdiff