Better --version output: cross OS output; move --help/version into se…

…parate functions
zeyus · Mar 27, 2022 · 8f91bd0 · 8f91bd0
1 parent 5d0d6e5
commit 8f91bd0
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 28 deletions.
diff --git a/gh-md-toc b/gh-md-toc
@@ -291,6 +291,45 @@ gh_toc_get_filename() {
     echo "${1##*/}"
 }
 
+show_version() {
+    echo "$gh_toc_version"
+    echo
+    echo "os:     `uname -s`"
+    echo "arch:   `uname -m`"
+    echo "kernel: `uname -r`"
+    echo "shell:  `$SHELL --version`"
+    echo
+    for tool in curl wget grep awk sed; do
+        printf "%-5s: " $tool
+        if `type $tool &>/dev/null`; then
+            echo `$tool --version | head -n 1`
+        else
+            echo "not installed"
+        fi
+    done
+}
+
+show_help() {
+    local app_name=$(basename "$0")
+    echo "GitHub TOC generator ($app_name): $gh_toc_version"
+    echo ""
+    echo "Usage:"
+    echo "  $app_name [options] src [src]   Create TOC for a README file (url or local path)"
+    echo "  $app_name -                     Create TOC for markdown from STDIN"
+    echo "  $app_name --help                Show help"
+    echo "  $app_name --version             Show version"
+    echo ""
+    echo "Options:"
+    echo "  --indent <NUM>      Set indent size. Default: 3."
+    echo "  --insert            Insert new TOC into original file. For local files only. Default: false."
+    echo "                      See https://github.com/ekalinin/github-markdown-toc/issues/41 for details."
+    echo "  --no-backup         Remove backup file. Set --insert as well. Defaul: false."
+    echo "  --hide-footer       Do not write date & author of the last TOC update. Set --insert as well. Default: false."
+    echo "  --skip-header       Hide entry of the topmost headlines. Default: false."
+    echo "                      See https://github.com/ekalinin/github-markdown-toc/issues/125 for details."
+    echo ""
+}
+
 #
 # Options handlers
 #
@@ -299,38 +338,12 @@ gh_toc_app() {
     local indent=3
 
     if [ "$1" = '--help' ] || [ $# -eq 0 ] ; then
-        local app_name=$(basename "$0")
-        echo "GitHub TOC generator ($app_name): $gh_toc_version"
-        echo ""
-        echo "Usage:"
-        echo "  $app_name [options] src [src]   Create TOC for a README file (url or local path)"
-        echo "  $app_name -                     Create TOC for markdown from STDIN"
-        echo "  $app_name --help                Show help"
-        echo "  $app_name --version             Show version"
-        echo ""
-        echo "Options:"
-        echo "  --indent <NUM>      Set indent size. Default: 3."
-        echo "  --insert            Insert new TOC into original file. For local files only. Default: false."
-        echo "                      See https://github.com/ekalinin/github-markdown-toc/issues/41 for details."
-        echo "  --no-backup         Remove backup file. Set --insert as well. Defaul: false."
-        echo "  --hide-footer       Do not write date & author of the last TOC update. Set --insert as well. Default: false."
-        echo "  --skip-header       Hide entry of the topmost headlines. Default: false."
-        echo "                      See https://github.com/ekalinin/github-markdown-toc/issues/125 for details."
-        echo ""
+        show_help
         return
     fi
 
     if [ "$1" = '--version' ]; then
-        echo "$gh_toc_version"
-        echo
-        echo "os:     `lsb_release -d | cut -f 2`"
-        echo "kernel: `cat /proc/version`"
-        echo "shell:  `$SHELL --version`"
-        echo
-        for tool in curl wget grep awk sed; do
-            printf "%-5s: " $tool
-            echo `$tool --version | head -n 1`
-        done
+        show_version
         return
     fi
 

diff --git a/tests/tests.bats b/tests/tests.bats
@@ -149,6 +149,8 @@ test_help() {
     run $BATS_TEST_DIRNAME/../gh-md-toc --version
     assert_success
     assert_equal "${lines[0]}" "0.8.0"
+    assert_equal "${lines[1]}" "os:     `uname -s`"
+    assert_equal "${lines[2]}" "arch:   `uname -m`"
 }
 
 @test "TOC for non-english chars, #6, #10" {