Merge pull request #2 from adriendupuis/feature/self

Self Installation & Maintenance

Author: adriendupuis

README.md

@@ -3,7 +3,25 @@ Utils
 
 Small Shell Tools
 
+
+Install
+-------
+
+### Installation
+
+Utils must be installed in ~/utils.
+
+To install, run `git clone https://github.com/adriendupuis/utils.git -b master ~/utils && ${0//[^a-z]/} ~/utils/install.sh $0;`
+
+### Maintenance
+
+- `utils-update`: Update utils to last master release
+- `utils-install <version>`: Install a given version of Utils, the version can be a tag, a branch or a commit
+- `utils-version`: Get actual Utils version
+
+
 TODO
 ----
 
-* Portage (originally done with macOs Catalina, ensure that it works on other unixoids)
+* Portage (originally done with macOs Catalina, ensure that it works on other unixoids)
+* Unit tests

aliases.sh

@@ -1,3 +1,9 @@
+source ~/utils/functions.sh;
+
+alias utils-install='utils-update';
+alias utils-update='_utils_update';
+alias utils-version='_utils_version'
+
 alias git-graph='git log --all --graph --date-order --oneline --decorate';
 alias git-current-branch='git rev-parse --abbrev-ref HEAD';
 alias git-current-commit='git rev-parse --verify --short HEAD';

functions.sh

@@ -0,0 +1,45 @@
+function _utils_update {
+  cd ~/utils;
+
+  previous=$(_utils_version);
+
+  git fetch --quiet;
+  if [[ 0 -lt $# ]]; then
+    git checkout --quiet "$1" 2> /dev/null;
+    if [[ 0 -lt $? ]]; then
+      echo "Error: can't checkout $1";
+      return;
+    fi;
+  else
+    git checkout --quiet master 2> /dev/null;
+  fi;
+  git pull --quiet;
+
+  current=$(_utils_version);
+
+  if [ "$current" == "$previous" ]; then
+    echo "Info: Utils is up-to-date and in $previous";
+  else
+    rc=~/.${SHELL##*/}rc;
+    if [[ -f $rc ]]; then
+      source $rc;
+      echo "Info: $rc reloaded.";
+    else
+      source ~/utils/aliases.sh;
+      echo 'Notice: ~/utils/aliases.sh reloaded. Shell RC file might need a manual reload too.';
+    fi;
+    echo "Info: Utils updated from $previous to $current.";
+  fi
+}
+
+function _utils_version {
+  cd ~/utils;
+
+  git fetch --tags --quiet;
+  version=$(git describe --tags 2> /dev/null);
+  if [ -z "$version" ]; then
+    version=$(git rev-parse --verify --short HEAD);
+  fi;
+
+  echo "$version";
+}

install.sh

@@ -0,0 +1,33 @@
+# First installation script (just after having cloned the repository)
+
+if [[ "${1//[^a-z]/}" =~ 'zsh' ]]; then
+  rc='zshrc';
+elif [[ "$1" =~ 'bash' ]]; then
+  rc='bashrc';
+else
+  echo "Error: Unsupported shell.";
+  exit 1;
+fi;
+
+source ~/utils/text.sh;
+ERROR="${TXT_FG_WHITE}${TXT_BG_RED}";
+WARNING="${TXT_FG_BLACK}${TXT_BG_YELLOW}";
+COMMENT="${TXT_FG_BLUE}";
+RESET=$TXT_RESET;
+
+if [[ -f ~/utils/rc/$rc ]]; then
+  if [[ -z `grep "/utils/rc/$rc" ~/.$rc;` ]]; then
+    echo -e "Status: Load ~/utils/rc/$rc into ~/.$rc…";
+
+    echo '' >> ~/.$rc;
+    echo '# https://github.com/adriendupuis/utils' >> ~/.$rc;
+    echo "source \$HOME/utils/rc/$rc" >> ~/.$rc;
+
+    echo "${COMMENT}Notice: Utils will be automatically available in next terminals. If Utils is needed in the current one, the following command can be run:";
+    echo "source ~/.$rc;${RESET}";
+  else
+    echo "Info: ~/utils/rc/$rc already loaded from ~/.$rc.";
+  fi;
+else
+  echo "Info: No “rc” file available for this shell."
+fi;

rc/bashrc

@@ -0,0 +1 @@
+source $HOME/utils/aliases.sh;

rc/zshrc

@@ -0,0 +1,2 @@
+setopt interactivecomments; # Allow to have a comment in a command line; Avoid error like "zsh: command not found: #"
+source $HOME/utils/aliases.sh;