better help, add uninstall using rc file

Signed-off-by: Tin Lai <[email protected]>
soraxas · Jul 13, 2020 · b5eef18 · b5eef18
1 parent 3a5fced
commit b5eef18
Show file tree

Hide file tree

Showing 22 changed files with 168 additions and 54 deletions.
diff --git a/completions/shsh.fish b/completions/shsh.fish
@@ -51,3 +51,12 @@ complete -f -c shsh -n '__fish_shsh_needs_command' -l version -d "Show version n
 complete -f -c shsh -n "__fish_shsh_using_command list" -s d -l details -d "display more details of packages"
 complete -f -c shsh -n "__fish_shsh_using_command upgrade" -s a -l all -d "performs on all packages"
 complete -f -c shsh -n "__fish_shsh_using_command refresh" -s a -l all -d "performs on all packages"
+
+complete -f -c shsh -n "__fish_shsh_using_command install" -s h -l hook -d "add hook to the package"
+complete -f -c shsh -n "__fish_shsh_using_command install" -s v -l variable -d "set a variable during installation"
+complete -f -c shsh -n "__fish_shsh_using_command install" -s f -l force -d "force the installation even if the package exists"
+complete -f -c shsh -n "__fish_shsh_using_command install"      -l nocleanup -d "do not perform cleanup"
+complete -f -c shsh -n "__fish_shsh_using_command install"      -l ssh -d "use ssh protocal instead of https"
+
+complete -f -c shsh -n "__fish_shsh_using_command uninstall" -l use-rc -d "uninstall all packages not present in SHSHRC"
+complete -f -c shsh -n "__fish_shsh_using_command uninstall" -l noconfirm -d "do not prompt to confirm"
diff --git a/libexec/shsh b/libexec/shsh
@@ -52,7 +52,7 @@
 #   DEPS                list of dependent packages to install beforehand
 #
 # Files:
-# SHSHRC: The file `$XDG_CONFIG_HOME/shshrc` shall be an executable file 
+# SHSHRC: The file `$XDG_CONFIG_HOME/shshrc` shall be a plain-text file 
 # that store all installed packages. Whenever shsh install a package, it 
 # will add the package to SHSHRC. If there is an existing entry, it will
 # update that entry with the new flags/argunment instead. It will search
@@ -125,7 +125,7 @@ for arg; do
       ;;
     --version)
       cat << EOF
-shsh (shell script handler) v2.3.1
+shsh (shell script handler) v2.3.2
 
 Copyright (c) 2014 Juan Ibiapina, 2020 Tin Lai (@soraxas)
 This is free software; see the source for copying conditions.  There is NO

diff --git a/libexec/shsh-_utils b/libexec/shsh-_utils
@@ -146,4 +146,38 @@ requote_args() {
     fi
   done
   printf "%s" "$C"
+}
+
+prompt ()  {
+  echo -n "$1 [y/N]? "
+  read answer
+  while true; do
+    case $answer in
+      y|Y|yes|YES) return 0;;
+      ''|n|N|no|NO) return 1;;
+      *)
+        echo 'Invalid response';
+        echo -n "$1 [y/N]? "
+        read answer;;
+    esac
+  done
+}
+
+shshrc_get_existing_install_cmd() {
+  set +e
+  unset existing
+  unset existing_prefix
+  unset existing_suffix
+  # given $1 as the package name, return the existing line in SHSHRC that installs
+  # that package
+  if [ -e "$SHSHRC" ]; then
+    existing="$(grep -E "^\s*shsh install (.*\s+)?$1(\s.*)?$" "$SHSHRC")"
+    # extract suffix if any (e.g. '&& \' or '|| \')
+    _ending_pattern='\s+([&][&]|[|][|])\s*[\]\s*$'
+    existing_suffix="$(echo "$existing" | grep -oE "$_ending_pattern")"
+    # extract prefix if any (i.e. white spaces)
+    existing_prefix="$(echo "$existing" | grep -oE "^\s*")"
+    # remove these from the statement for comparison
+    existing="$(echo "$existing" | sed -E "s/$_ending_pattern//; s/^(\s*)//")"
+  fi
 }
diff --git a/libexec/shsh-help b/libexec/shsh-help
@@ -49,7 +49,7 @@ collect_documentation() {
       next
     }
 
-    /^( *$|       )/ && reading_usage {
+    /^( *$|       | +or: +)/ && reading_usage {
       usage = usage "\n" $0
       next
     }

diff --git a/libexec/shsh-install b/libexec/shsh-install
@@ -234,14 +234,7 @@ shsh-_link-completions "$folder"
 # add successfully installed package to shshrc
 if [ -e "$SHSHRC" ]; then
   set +e  # allow non-zero exit status in pattern matching
-  existing="$(grep -E "^\s*shsh install $1(\s.*)?$" "$SHSHRC")"
-  # extract suffix if any (e.g. '&& \' or '|| \')
-  _ending_pattern='\s+([&][&]|[|][|])\s*[\]\s*$'
-  existing_suffix="$(echo "$existing" | grep -oE "$_ending_pattern")"
-  # extract prefix if any (i.e. white spaces)
-  existing_prefix="$(echo "$existing" | grep -oE "^\s*")"
-  # remove these from the statement for comparison
-  existing="$(echo "$existing" | sed -E "s/$_ending_pattern//; s/^(\s*)//")"
+  shshrc_get_existing_install_cmd "$package"
   new_statement="shsh install $original_args"
 
   if [ -z "$existing" ]; then

diff --git a/libexec/shsh-uninstall b/libexec/shsh-uninstall
@@ -1,16 +1,62 @@
 #!/usr/bin/env sh
 # Summary: Uninstalls a package
 # Usage: shsh uninstall <package>
+#   or:  shsh uninstall --use-rc [--noconfirm]
+#
+# Options:
+#       --use-rc     uninstall all packages that is not present in SHSHRC file
+#       --noconfirm  do not prompt to confirm uninstalling each package
 
 set -e
 
 . "${UTILS_FUNC:?}"
 
-if [ "$#" -ne 1 ]; then
+for arg; do
+  shift
+  case "$arg" in
+  --use-rc|--rc)
+    use_rc_file="true"
+    ;;
+  --noconfirm|--no-confirm)
+    noconfirm="true"
+    ;;
+  -*)
+    shsh-help uninstall
+    exit 1
+    ;;
+  *)
+    set -- "$@" "$arg"
+    ;;
+  esac
+done
+
+if [ "$#" -ne 1 ] && [ -z "$use_rc_file" ]; then
+  shsh-help uninstall
+  exit 1
+fi
+
+if [ -n "$use_rc_file" ] && [ "$#" -ne 0 ]; then
   shsh-help uninstall
   exit 1
 fi
 
+# using SHSHRC file
+if [ -n "$use_rc_file" ]; then
+  for package in $(shsh list); do
+    set +e
+    shshrc_get_existing_install_cmd "$package"
+    set -e
+
+    if [ -z "$existing" ]; then
+      if [ -n "$noconfirm" ] || prompt "Uninstall $package?"; then
+        echo "> Uninstalling $package"
+        shsh uninstall "$package"
+      fi
+    fi
+  done
+  exit
+fi
+
 # TAG completions
 if [ "$1" = "--complete" ]; then
   exec shsh-list

diff --git a/libexec/shsh-upgrade b/libexec/shsh-upgrade
@@ -1,6 +1,12 @@
 #!/usr/bin/env sh
 # Summary: Upgrades a package
-# Usage: shsh upgrade <package|[-a|--all]> 
+#
+# Usage: shsh upgrade <package>
+#   or:  shsh upgrade <-a|--all>
+#
+# Options:
+#       -a, --all    upgrade all packages, instead of invidivual package
+
 
 set -e
 

diff --git a/man/man1/shsh-cleanup.1 b/man/man1/shsh-cleanup.1
@@ -1,7 +1,7 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
-.TH SHSH "1" "July 2020" "shell script handler v2.3.1" "User Commands"
+.TH SHSH "1" "July 2020" "shell script handler v2.3.2" "User Commands"
 .SH NAME
-shsh \- manual page for shsh v2.3.1
+shsh \- manual page for shsh v2.3.2
 .SH SYNOPSIS
 .B shsh
 \fI\,cleanup\/\fR

diff --git a/man/man1/shsh-commands.1 b/man/man1/shsh-commands.1
@@ -1,7 +1,7 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
-.TH SHSH "1" "July 2020" "shell script handler v2.3.1" "User Commands"
+.TH SHSH "1" "July 2020" "shell script handler v2.3.2" "User Commands"
 .SH NAME
-shsh \- manual page for shsh v2.3.1
+shsh \- manual page for shsh v2.3.2
 .SH SYNOPSIS
 .B shsh
 \fI\,commands\/\fR

diff --git a/man/man1/shsh-completions.1 b/man/man1/shsh-completions.1
@@ -1,7 +1,7 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
-.TH SHSH "1" "July 2020" "shell script handler v2.3.1" "User Commands"
+.TH SHSH "1" "July 2020" "shell script handler v2.3.2" "User Commands"
 .SH NAME
-shsh \- manual page for shsh v2.3.1
+shsh \- manual page for shsh v2.3.2
 .SH SYNOPSIS
 .B shsh
 \fI\,completions <command>\/\fR

diff --git a/man/man1/shsh-help.1 b/man/man1/shsh-help.1
@@ -1,7 +1,7 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
-.TH SHSH "1" "July 2020" "shell script handler v2.3.1" "User Commands"
+.TH SHSH "1" "July 2020" "shell script handler v2.3.2" "User Commands"
 .SH NAME
-shsh \- manual page for shsh v2.3.1
+shsh \- manual page for shsh v2.3.2
 .SH SYNOPSIS
 .B shsh
 \fI\,help \/\fR[\fI\,--usage\/\fR] \fI\,COMMAND\/\fR

diff --git a/man/man1/shsh-init.1 b/man/man1/shsh-init.1
@@ -1,7 +1,7 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
-.TH SHSH "1" "July 2020" "shell script handler v2.3.1" "User Commands"
+.TH SHSH "1" "July 2020" "shell script handler v2.3.2" "User Commands"
 .SH NAME
-shsh \- manual page for shsh v2.3.1
+shsh \- manual page for shsh v2.3.2
 .SH SYNOPSIS
 .B eval
 \fI\,"$(shsh init SHELL)"\/\fR

diff --git a/man/man1/shsh-install.1 b/man/man1/shsh-install.1
@@ -1,7 +1,7 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
-.TH SHSH "1" "July 2020" "shell script handler v2.3.1" "User Commands"
+.TH SHSH "1" "July 2020" "shell script handler v2.3.2" "User Commands"
 .SH NAME
-shsh \- manual page for shsh v2.3.1
+shsh \- manual page for shsh v2.3.2
 .SH SYNOPSIS
 .B shsh
 \fI\,install \/\fR[\fI\,site\/\fR]\fI\,/<package>\/\fR[\fI\,@ref\/\fR] [\fI\,<folder>/<folder>\/\fR]

diff --git a/man/man1/shsh-link.1 b/man/man1/shsh-link.1
@@ -1,7 +1,7 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
-.TH SHSH "1" "July 2020" "shell script handler v2.3.1" "User Commands"
+.TH SHSH "1" "July 2020" "shell script handler v2.3.2" "User Commands"
 .SH NAME
-shsh \- manual page for shsh v2.3.1
+shsh \- manual page for shsh v2.3.2
 .SH SYNOPSIS
 .B shsh
 \fI\,link \/\fR[\fI\,--no-deps\/\fR] \fI\,<directory> <package>\/\fR

diff --git a/man/man1/shsh-list.1 b/man/man1/shsh-list.1
@@ -1,7 +1,7 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
-.TH SHSH "1" "July 2020" "shell script handler v2.3.1" "User Commands"
+.TH SHSH "1" "July 2020" "shell script handler v2.3.2" "User Commands"
 .SH NAME
-shsh \- manual page for shsh v2.3.1
+shsh \- manual page for shsh v2.3.2
 .SH SYNOPSIS
 .B shsh
 \fI\,list \/\fR[\fI\,-d|--details\/\fR]

diff --git a/man/man1/shsh-outdated.1 b/man/man1/shsh-outdated.1
@@ -1,7 +1,7 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
-.TH SHSH "1" "July 2020" "shell script handler v2.3.1" "User Commands"
+.TH SHSH "1" "July 2020" "shell script handler v2.3.2" "User Commands"
 .SH NAME
-shsh \- manual page for shsh v2.3.1
+shsh \- manual page for shsh v2.3.2
 .SH SYNOPSIS
 .B shsh
 \fI\,outdated \/\fR[\fI\,-q|--quiet\/\fR]

diff --git a/man/man1/shsh-package-path.1 b/man/man1/shsh-package-path.1
@@ -1,7 +1,7 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
-.TH SHSH "1" "July 2020" "shell script handler v2.3.1" "User Commands"
+.TH SHSH "1" "July 2020" "shell script handler v2.3.2" "User Commands"
 .SH NAME
-shsh \- manual page for shsh v2.3.1
+shsh \- manual page for shsh v2.3.2
 .SH SYNOPSIS
 .B source
 \fI\,"$(shsh package-path <package>)/file.sh"\/\fR

diff --git a/man/man1/shsh-refresh.1 b/man/man1/shsh-refresh.1
@@ -1,7 +1,7 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
-.TH SHSH "1" "July 2020" "shell script handler v2.3.1" "User Commands"
+.TH SHSH "1" "July 2020" "shell script handler v2.3.2" "User Commands"
 .SH NAME
-shsh \- manual page for shsh v2.3.1
+shsh \- manual page for shsh v2.3.2
 .SH SYNOPSIS
 .B shsh
 \fI\,refresh <package> \/\fR[\fI\,--verbose\/\fR] [\fI\,-a|--all\/\fR]

diff --git a/man/man1/shsh-self-upgrade.1 b/man/man1/shsh-self-upgrade.1
@@ -1,7 +1,7 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
-.TH SHSH "1" "July 2020" "shell script handler v2.3.1" "User Commands"
+.TH SHSH "1" "July 2020" "shell script handler v2.3.2" "User Commands"
 .SH NAME
-shsh \- manual page for shsh v2.3.1
+shsh \- manual page for shsh v2.3.2
 .SH SYNOPSIS
 .B shsh
 \fI\,self-upgrade\/\fR

diff --git a/man/man1/shsh-uninstall.1 b/man/man1/shsh-uninstall.1
@@ -1,14 +1,22 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
-.TH SHSH "1" "July 2020" "shell script handler v2.3.1" "User Commands"
+.TH SHSH "1" "July 2020" "shell script handler v2.3.2" "User Commands"
 .SH NAME
-shsh \- manual page for shsh v2.3.1
+shsh \- manual page for shsh v2.3.2
 .SH SYNOPSIS
 .B shsh
 \fI\,uninstall <package>\/\fR
+.br
+.B shsh
+\fI\,uninstall --use-rc \/\fR[\fI\,--noconfirm\/\fR]
 .SH DESCRIPTION
 Uninstalls a package
-.PP
-Uninstalls a package
+.SH OPTIONS
+.TP
+\fB\-\-use\-rc\fR
+uninstall all packages that is not present in SHSHRC file
+.TP
+\fB\-\-noconfirm\fR
+do not prompt to confirm uninstalling each package
 .SH AUTHOR
 Written by Tin Lai (@soraxas)
 .SH COPYRIGHT

diff --git a/man/man1/shsh-upgrade.1 b/man/man1/shsh-upgrade.1
@@ -1,14 +1,19 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
-.TH SHSH "1" "July 2020" "shell script handler v2.3.1" "User Commands"
+.TH SHSH "1" "July 2020" "shell script handler v2.3.2" "User Commands"
 .SH NAME
-shsh \- manual page for shsh v2.3.1
+shsh \- manual page for shsh v2.3.2
 .SH SYNOPSIS
 .B shsh
-\fI\,upgrade <package|\/\fR[\fI\,-a|--all\/\fR]\fI\,>\/\fR
+\fI\,upgrade <package>\/\fR
+.br
+.B shsh
+\fI\,upgrade <-a|--all>\/\fR
 .SH DESCRIPTION
 Upgrades a package
-.PP
-Upgrades a package
+.SH OPTIONS
+.TP
+\fB\-a\fR, \fB\-\-all\fR
+upgrade all packages, instead of invidivual package
 .SH AUTHOR
 Written by Tin Lai (@soraxas)
 .SH COPYRIGHT