Publish and document API globals properly

src/libexec/dottum-install

@@ -16,12 +16,12 @@ usage() {
 }
 
 dottum__route() {
-    local Vault=$1; shift
-    local SubVaults=()
-    test -n "$Vault" || usage -w "no VAULT?"
-    test -e "$Vault" || die "vault does not exist: $Vault"
-    test -d "$Vault" || die "vault is not a directory: $Vault"
-    SubVaults=("$@")
+    DOTTUM__VAULT=$1; shift
+    local DOTTUM__SUBVAULTS=()
+    test -n "$DOTTUM__VAULT" || usage -w "no VAULT?"
+    test -e "$DOTTUM__VAULT" || die "vault does not exist: $DOTTUM__VAULT"
+    test -d "$DOTTUM__VAULT" || die "vault is not a directory: $DOTTUM__VAULT"
+    DOTTUM__SUBVAULTS=("$@")
     case $Action in
         init)       dottum__make_links  ;;
         explore)    dottum__explore     ;;
@@ -32,12 +32,10 @@ export LC_ALL=C
 
 main() {
     local Action=init
-    local ClobberLinks=false
-    local ClobberBroken=true
     while true; do case $1 in
         -n) Action=explore;     shift ;;
-        -B) ClobberBroken=false; shift ;;
-        -f) ClobberLinks=true;  shift ;;
+        -B) DOTTUM__CLOBBER_BROKEN=false; shift ;;
+        -f) DOTTUM__CLOBBER_LINKS=true;  shift ;;
         -*) usage -w "unknown argument: $1" ;;
         *)                      break ;;
     esac done

src/shellfu/dottum.sh

@@ -2,6 +2,28 @@
 
 shellfu import pretty
 
+#
+# Should broken links be silently overwritten?
+#
+DOTTUM__CLOBBER_BROKEN=false
+
+#
+# Should all links be silently overwritten?
+#
+DOTTUM__CLOBBER_LINKS=false
+
+#
+# List of subvalults passed on command line
+#
+# This is added to the front of list in *subvalults* file.
+#
+DOTTUM__SUBVAULTS=()
+
+#
+# Vault to process
+#
+DOTTUM__VAULT=""
+
 _dottum__slstatus() {
     #
     # Print status of slpath $1
@@ -72,17 +94,17 @@ dottum__lssv() {
     #     $HOME/.local/share/klavaro -> dotfiles/local/share/klavaro
     #
     local sv
-    test -n "${SubVaults[0]}" && {
+    test -n "${DOTTUM__SUBVAULTS[0]}" && {
         think "using sub-vaults from command line"
-        for sv in "${SubVaults[@]}";
+        for sv in "${DOTTUM__SUBVAULTS[@]}";
         do
             echo "$sv"
         done
         return
     }
-    test -f "$Vault/dotvault/subvaults" && {
-        think "reading subvaults from file: $Vault/dotvault/subvaults"
-        grep . "$Vault/dotvault/subvaults" \
+    test -f "$DOTTUM__VAULT/dotvault/subvaults" && {
+        think "reading subvaults from file: $DOTTUM__VAULT/dotvault/subvaults"
+        grep . "$DOTTUM__VAULT/dotvault/subvaults" \
           | grep -v "^#.*"
         return
     }
@@ -95,19 +117,19 @@ dottum__lsvault() {
     # List all vaults and subvaults, depth-first
     #
     {
-        echo "$Vault"
+        echo "$DOTTUM__VAULT"
         dottum__lssv \
           | while IFS= read -r sv;
             do
-                test -e "$Vault/$sv" || {
+                test -e "$DOTTUM__VAULT/$sv" || {
                     think "ignoring non-existent sub-vault: $sv"
                     continue
                 }
-                test -d "$Vault/$sv" || {
+                test -d "$DOTTUM__VAULT/$sv" || {
                     warn "ignoring non-directory sub-vault: $sv"
                     continue
                 }
-                echo "$Vault/$sv"
+                echo "$DOTTUM__VAULT/$sv"
             done
     } \
       | LC_ALL=C sort \
@@ -172,7 +194,7 @@ dottum__lstarget() {
     local item
     find "$vlt" -mindepth 1 -maxdepth 1 -printf "%P\n" \
       | dottum__pfxpath "$vlt/" \
-      | grep -v "$Vault/dotvault" \
+      | grep -v "$DOTTUM__VAULT/dotvault" \
       | while IFS= read -r item;
         do
             dottum__istarget "$item" && echo "$item"
@@ -203,7 +225,7 @@ dottum__make_links() {
                             continue
                             ;;
                         broken)
-                            if $ClobberLinks || $ClobberBroken; then
+                            if $DOTTUM__CLOBBER_LINKS || $DOTTUM__CLOBBER_BROKEN; then
                                 think "removing existing broken link: $slpath"
                                 dottum__maybe rm "$slpath"
                             else
@@ -212,7 +234,7 @@ dottum__make_links() {
                             fi
                             ;;
                         symlink)
-                            if $ClobberLinks; then
+                            if $DOTTUM__CLOBBER_LINKS; then
                                 think "removing existing link: $slpath"
                                 dottum__maybe rm "$slpath"
                             else
@@ -239,7 +261,7 @@ dottum__explore() {
         do
             tgts=$(dottum__lstarget "$vlt")
             test -n "$tgts" || continue
-            if test "$vlt" == "$Vault";
+            if test "$vlt" == "$DOTTUM__VAULT";
             then
                 echo "VAULT:$vlt:"
             else
@@ -270,5 +292,5 @@ dottum__slpath() {
     # Print path where to create link for target $1
     #
     local item=$1
-    echo "$HOME/.${item#$Vault/}"
+    echo "$HOME/.${item#$DOTTUM__VAULT/}"
 }