]> glassweightruler.freedombox.rocks Git - xdg-ninja.git/commitdiff
Use pygmentize and highlight as fallback markdown renderers (#69)
authorLayerex <layerex@dismail.de>
Sat, 28 May 2022 20:17:20 +0000 (23:17 +0300)
committerGitHub <noreply@github.com>
Sat, 28 May 2022 20:17:20 +0000 (20:17 +0000)
Co-authored-by: b3nj5m1n <47924309+b3nj5m1n@users.noreply.github.com>
README.md
xdg-ninja.sh

index 3834647a03274eb8953d788042158bec5f156b84..54f19adee13d251064586c2c1703d2dda1005d31 100644 (file)
--- a/README.md
+++ b/README.md
@@ -26,7 +26,7 @@ This will run every test in the default configuration.
 
 ### Optional
 
-- [glow](https://repology.org/project/glow/packages) for rendering markdown in the terminal ([bat](https://repology.org/project/bat-cat/packages) can be used as a fallback, but glows output is clearer and therefore recommended)
+- [glow](https://repology.org/project/glow/packages) for rendering markdown in the terminal ([bat](https://repology.org/project/bat-cat/packages), [pygmentize](https://repology.org/project/pygments/versions) or [highlight](https://repology.org/project/highlight/packages) can be used as fallback, but glow's output is clearer and therefore glow is recommended)
 - [cabal](https://repology.org/project/cabal/packages) for compiling the helper program for creating configurations
 
 ## Configuration
index 94a8969674fd020713e75807d5f389c37ff97f3e..20444327504046cecb9a9e517b1b4d4f8f399d02 100755 (executable)
@@ -1,16 +1,30 @@
 #!/usr/bin/env sh
 
+has_command() {
+    command -v "$1" >/dev/null 2>/dev/null
+    return $?
+}
+
 USE_GLOW=false
 USE_BAT=false
-if command -v glow >/dev/null 2>/dev/null; then
+USE_PYGMENTIZE=false
+USE_HIGHLIGHT=false
+if has_command glow; 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"
+    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
 
@@ -135,6 +149,11 @@ log() {
             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