Allow specifying function or variable name instead of MODULE

src/bin/sfdoc

@@ -28,6 +28,8 @@ usage() {
             "                   format FMT: 'markdown', 'manpage' and"  \
             "                   'pod' are supported"                    \
         -o                                                              \
+            "-O, --object       Treat MODULE as function or variable"   \
+            "                   name and find respective module first." \
             "-d, --debug        Turn on debugging"                      \
             "-a, --all          Don't ignore hidden (starting with"     \
             "                   underscore) modules or objects"         \
@@ -71,10 +73,22 @@ find_lesspipe() {
      2>/dev/null
 }
 
+find_by() {
+    #
+    # Find module by object type $1 and name $2
+    #
+    local name=$1
+    sfdoc -a -l \
+      | grep ":$name$" \
+      | cut -d: -f1 \
+      | grep .
+}
+
 main() {
     local action            # what to do
     local format            # export format
     local module            # module name or path/to/module.sh
+    local mspec             # module/function name or path/to/module.sh
     local m                 # module helper var
     local RealModuleName    # name to override eg. if accessing via filename
     local encoding          # encoding
@@ -82,8 +96,10 @@ main() {
     action=man
     format=markdown
     encoding=utf8
+    spectype=mod
     #shellcheck disable=SC2034
     while true; do case "$1" in
+        -O|--object)    spectype=obj;               shift ;;
         -d|--debug)     PRETTY_DEBUG=true;          shift ;;
         -a|--all)       SFDOC_SHOW_HIDDEN=true;     shift ;;
         -I|--include)   SHELLFU_PATH="$2:$SHELLFU_PATH"; shift 2 || usage ;;
@@ -100,15 +116,20 @@ main() {
         -*)                                         usage ;;
         *)                                          break ;;
     esac done
-    module="$1"; shift
+    mspec="$1"; shift
     debug -v SHELLFU_INCLUDE SHELLFU_PATH SFDOC_SHOW_HIDDEN
     debug -v action format module RealModuleName
-    case $action:$module in
+    case $action:$mspec in
         lsx:*|lsm:*|wch:*) true ;;
         *:)             usage ;;
     esac
+    case $spectype in
+        obj) module=$(find_by "$mspec") \
+              || die "no module found with: $mspec" ;;
+        *)   module=$mspec ;;
+    esac
     case $action in
-        lsm|wch) : ;;
+        lsm)    : ;;
         *)      mpath=$(select_mfile "$module") || die ;;
     esac
     case $action in
@@ -159,7 +180,7 @@ main() {
             fi
             ;;
         wch)
-            select_mfile "$module"
+            echo "$mpath"
             ;;
     esac
 }

tests/sfdoc/TF_RUN

@@ -18,6 +18,8 @@ tf_enum_subtests() {
     echo simplest
     echo simple
     echo tricky
+    echo simple_by_fun
+    echo simple_by_var
 }
 
 export SHELLFU_PATH=test/include
@@ -38,6 +40,8 @@ tf_do_subtest() {
         lsf_tricky)    cmd="sfdoc --lsfun test/include/tricky.sh" ;;
         direct_path)   cmd="sfdoc -e markdown test/other/path.sh" ;;
         included_path) cmd="sfdoc -I test/other -e markdown path" ;;
+        simple_by_fun) cmd="sfdoc -O -e markdown simple_foo" ;;
+        simple_by_var) cmd="sfdoc -O -e markdown SIMPLE_LIMIT" ;;
         *)             cmd="sfdoc -e markdown $name" ;;
     esac
     tf_testflt -n "$name" -O "oracle/$name.stdout" -E "oracle/$name.stderr" -S "$o_es" "$cmd"

tests/sfdoc/oracle/simple_by_fun.stderr

@@ -0,0 +1 @@
+simple.stderr

tests/sfdoc/oracle/simple_by_fun.stdout

@@ -0,0 +1 @@
+simple.stdout

tests/sfdoc/oracle/simple_by_var.stderr

@@ -0,0 +1 @@
+simple.stderr

tests/sfdoc/oracle/simple_by_var.stdout

@@ -0,0 +1 @@
+simple.stdout