Add -s|--src for easy viewing of module source

packaging/debian/control

@@ -12,6 +12,7 @@ Build-Depends:
 Package: __MKIT_PROJ_PKGNAME__
 Architecture: all
 Depends:
+ source-highlight,
  perl,
  procps,
 Description: __MKIT_PROJ_NAME__ - __MKIT_PROJ_TAGLINE__

packaging/template.spec

@@ -16,6 +16,7 @@ BuildRequires:  perl
 BuildRequires:  %{pspkg}
 
 Requires: %{pspkg}
+Requires: source-highlight
 %description
 Shellfu is an attempt to add modularity to your shell scripts.
 

src/bin/sfdoc

@@ -14,6 +14,7 @@ usage() {
         "[options] --ls{var|fun} MODULE"                                \
         "[options] --which"                                             \
         "[options] --lsmod"                                             \
+        "[options] -s|--src MODULE"                                     \
         "[options] --export FMT MODULE"                                 \
         -c                                                              \
             "-l, --ls [MODULE]  list contents of MODULE if specified,"  \
@@ -22,6 +23,7 @@ usage() {
             " --lsfun MODULE    show list of functions in MODULE"       \
             " --lsvar MODULE    show list of variables in MODULE"       \
             " --which MODULE    show path to MODULE file"               \
+            "-s, --src MODULE   show MODULE source code"                \
             "-e, --export FMT MODULE   export MODULE documentation in"  \
             "                   format FMT: 'markdown', 'manpage' and"  \
             "                   'pod' are supported"                    \
@@ -59,6 +61,16 @@ select_mfile() {
     echo "$mfile"
 }
 
+find_lesspipe() {
+    #
+    # Output correct path to src-hilite-lesspipe.sh
+    #
+    find \
+      /usr/bin/src-hilite-lesspipe.sh \
+      /usr/share/source-highlight/src-hilite-lesspipe.sh \
+     2>/dev/null
+}
+
 main() {
     local action            # what to do
     local format            # export format
@@ -75,6 +87,7 @@ main() {
         -d|--debug)     PRETTY_DEBUG=true;          shift ;;
         -a|--all)       SFDOC_SHOW_HIDDEN=true;     shift ;;
         -I|--include)   SHELLFU_PATH="$2:$SHELLFU_PATH"; shift 2 || usage ;;
+        -s|--src)       action=src;                 shift; break ;;
         -l|--ls)        action=lsx;                 shift; break ;;
         -L|--lsmod)     action=lsm;                 shift; break ;;
         --which)        action=wch;                 shift; break ;;
@@ -131,6 +144,18 @@ main() {
             sfdoc__export manpage "${RealModuleName:-$module}" "$mpath" "$encoding" \
               | man -l -
             ;;
+        src)
+            local lesspipe
+            lesspipe=$(find_lesspipe)
+            if test -n "$lesspipe";
+            then
+                LESS="$LESS -R " \
+                LESSOPEN="| $lesspipe %s" \
+                    less "$mpath"
+            else
+                less "$mpath"
+            fi
+            ;;
         wch)
             select_mfile "$module"
             ;;