X-Git-Url: https://glassweightruler.freedombox.rocks/gitweb/xdg-ninja.git/blobdiff_plain/2dc0400d25a3ca003dbb0a6130b48ad41beb1a4d..refs/heads/arch_wiki_scrape:/xdg-ninja.sh diff --git a/xdg-ninja.sh b/xdg-ninja.sh index 2044432..8a0ff98 100755 --- a/xdg-ninja.sh +++ b/xdg-ninja.sh @@ -5,83 +5,106 @@ has_command() { 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 +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" - USE_PYGMENTIZE=true elif has_command highlight; then + DECODER="highlight --out-format ansi --syntax markdown" 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" + printf "Install glow for easier reading & copy-paste.\n" fi - 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="""\ - \033[37;45;1mxdg-ninja\033[0m + ${FG_WHITE}${BG_MAGENTA}${FX_BOLD}xdg-ninja${FX_RESET} - \033[1;3mCheck your \$HOME for unwanted files.\033[1;0m + ${FX_BOLD}${FX_ITALIC}Check your \$HOME for unwanted files.${FX_RESET} ──────────────────────────────────── - \033[3m--help\033[0m \033[1mThis help menu\033[0m - \033[3m-h\033[0m + ${FX_ITALIC}--help${FX_RESET} ${FX_BOLD}This help menu${FX_RESET} + ${FX_ITALIC}-h\033${FX_RESET} - \033[3m--no-skip-ok\033[0m \033[1mDisplay messages for all files checked (verbose)\033[0m - \033[3m-v\033[0m + ${FX_ITALIC}--no-skip-ok${FX_RESET} ${FX_BOLD}Display messages for all files checked (verbose)${FX_RESET} + ${FX_ITALIC}-v${FX_RESET} - \033[3m--skip-ok\033[0m \033[1mDon't display anything for files that do not exist (default)\033[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" "$HELPSTRING" +} SKIP_OK=true +SKIP_UNSUPPORTED=false for i in "$@"; do if [ "$i" = "--help" ] || [ "$i" = "-h" ]; then - printf "%b" "$HELPSTRING" + help exit elif [ "$i" = "--skip-ok" ]; then SKIP_OK=true elif [ "$i" = "--no-skip-ok" ]; then SKIP_OK=false + elif [ "$i" = "--skip-unsupported" ]; then + SKIP_UNSUPPORTED=true 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" + 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 '\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" + 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 '\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" + 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 '\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" + 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 '\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" + 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 @@ -118,6 +141,9 @@ decode_string() { /' # 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" @@ -128,35 +154,26 @@ log() { case "$MODE" in ERR) - printf '[\033[1;31m%s\033[1;0m]: \033[1;3m%s\033[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 '[\033[1;33m%s\033[1;0m]: \033[1;3m%s\033[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 '[\033[1;36m%s\033[1;0m]: \033[1;3m%s\033[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 '[\033[1;32m%s\033[1;0m]: \033[1;3m%s\033[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" = 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 - decode_string "$HELP" - fi + decode_string "$HELP" | PAGER="cat" $DECODER ;; esac @@ -184,7 +201,9 @@ check_file() { log WARN "$NAME" "$FILENAME" "$HELP" fi if [ "$HELP" ]; then - log HELP "$NAME" "$FILENAME" "$HELP" + if [ "$MOVABLE" = true ] || [ "$SKIP_UNSUPPORTED" = false ]; then + log HELP "$NAME" "$FILENAME" "$HELP" + fi else log HELP "$NAME" "$FILENAME" "_No help available._" fi @@ -199,19 +218,24 @@ do_check_programs() { " read -r name; read -r filename; read -r movable; read -r help; do check_file "$name" "$filename" "$movable" "$help" done <