git-rev-label 2.15.13 → 2.18.15

package/README.md

@@ -71,19 +71,18 @@ More info at https://gitlab.com/kyb/git-rev-label
   or create executable file git-rev-label in PATH with the same contents.
 
 ## Install
-#### Manual
+#### Raw without package manager
 ```
-wget 'https://gitlab.com/kyb/git-rev-label/raw/artifacts/master/git-rev-label' && sudo bash ./git-rev-label --install
+curl -fsSL 'https://gitlab.com/kyb/git-rev-label/raw/artifacts/master/git-rev-label' | sudo bash -s -- --install
 ```
 *Warning: sudo under hood.*  
 
-Without sudo, install to `$HOME/bin`:
+##### Manual to `$HOME/bin` without sudo:
 ```
-wget 'https://gitlab.com/kyb/git-rev-label/raw/artifacts/master/git-rev-label' && 
-  bash ./git-rev-label --install --install-dir=$HOME/bin
+curl -fsSL 'https://gitlab.com/kyb/git-rev-label/raw/artifacts/master/git-rev-label' | bash -s -- --install=$HOME/bin
 ```
 
-Make sure `$HOME/bin` is in `$PATH`:
+Then make sure `$HOME/bin` is in `$PATH`:
 * bash  
   ```
   [[ ":$PATH:" != *":$HOME/bin:"* ]] && PATH="$HOME/bin:$PATH"
@@ -96,7 +95,7 @@ Make sure `$HOME/bin` is in `$PATH`:
 #### with [NPM](https://npm.org)
     npm install --global git-rev-label
 
-#### with [Homebrew](https://brew.sh)
+#### with [Homebrew](https://brew.sh) **OUTDATED**
 ```
 brew tap ivakyb/git-rev-label
 brew install git-rev-label
@@ -104,6 +103,14 @@ brew install git-rev-label
 
 
 -----------------------
+
+## Examples
+Take a look into [build_info-header](build_info-header). 
+It shows how `git-rev-label` is used to generate C header file `build_info.h` 
+with information about version extracted from Git.
+
+
+
 -----------------------
 
 

package/git-rev-label

@@ -11,20 +11,39 @@
 ## or
 ##   git rev-label '$refname-c$count-g$short$_dirty'
 
+# shellcheck disable=SC2016       ## single quotes are intended not to be expanded
+# shellcheck disable=SC2215       ## --function-name is used to coinside with flags
+# shellcheck disable=SC2145       ## no real reason to replace $@ with $*
+# shellcheck disable=SC2317       ## something appears to be unreachable, but it can be used indirectly or optionally
+
 set -eEuo pipefail
 shopt -s inherit_errexit
 shopt -s lastpipe
+shopt -s expand_aliases
+
+VERSION=master-c18-g76653fe-b15
+VERSION_NPM=2.18.15
 
-VERSION=master-c15-g1edddf7-b13
-VERSION_NPM=2.15.13
+## todo maybe use utils.bash from autorsync
+function echomsg      { echo $'\e[1;37m'"$@"$'\e[0m'; }
+function echodbg  { >&2 echo $'\e[0;36m'"$@"$'\e[0m'; }
+function echowarn { >&2 echo $'\e[0;33m'WARNING$'\e[0m' "$@"; }
+function echoerr  { >&2 echo $'\e[0;31m'ERROR$'\e[0m' "$@"; }
+function fatalerr { >&2 echoerr "$@"; exit 1; }
 
-function echomsg               { echo $'\e[1;37m'"$@"$'\e[0m'; }
-function echodbg  { >/dev/stderr echo $'\e[0;36m'"$@"$'\e[0m'; }
-function echowarn { >/dev/stderr echo $'\e[0;33m'"$@"$'\e[0m'; }
-function echoerr  { >/dev/stderr echo $'\e[0;31m'"$@"$'\e[0m'; }
-function fatalerr { >/dev/stderr echo $'\e[0;31m'"$@"$'\e[0m'; exit 1; }
+if test "$(uname)" == 'Darwin' ;then
+   alias sed=gsed
+   alias grep=ggrep
+   alias find=gfind
+   alias date=gdate
+   alias cp=gcp
+   alias mv=gmv
+   alias ls=gls
+   alias mktemp=gmktemp
+   alias readlink=greadlink
+fi
 
-function OnErr { caller | { read lno file; echoerr ">ERR in $file:$lno,  $(sed -n ${lno}p $file)" >&2; };  }
+function OnErr { caller | { read -r lno file; echoerr ">ERR in $file:$lno,  $(sed -n "$lno"p "$file")" >&2; };  }
 trap OnErr ERR
 
 is_sourced(){
@@ -55,9 +74,9 @@ var_is_unset_or_empty(){
 function --help {
    echo -n \
 'Gives information about Git repository revision in format like '"'master-c73-gbbb6bec'"'.
-Can fill template string or file with environment variables and information from Git. 
-Useful to provide information about version of the program: branch, tag, commit hash, 
-commits count, dirty status, date and time. One of the most useful things is count of 
+Can fill template string or file with environment variables and information from Git.
+Useful to provide information about version of the program: branch, tag, commit hash,
+commits count, dirty status, date and time. One of the most useful things is count of
 commits, not taking into account merged branches - only first parent.
 
 USAGE:
@@ -72,8 +91,8 @@ USAGE:
    eval $(git rev-label --variables | sed s,^,export\ ,)  ## Export variables to environment
 
 COMPLEX USE CASE:
- * Fill `build_info.template.h` with branch, tag, commit hash, commits count, dirty status. 
-   Than include result header to access build information from code. 
+ * Fill `build_info.template.h` with branch, tag, commit hash, commits count, dirty status.
+   Than include result header to access build information from code.
    See https://gitlab.com/kyb/git-rev-label/blob/master/build_info.template.h and
    https://gitlab.com/kyb/git-rev-label/blob/master/create-build-info.sh
 
@@ -87,7 +106,7 @@ More info at https://gitlab.com/kyb/git-rev-label
 '
 }
 function --version {
-   echo "git-rev-label v$VERSION_NPM 
+   echo "git-rev-label v$VERSION_NPM
    $VERSION
    https://gitlab.com/kyb/git-rev-label"
 }
@@ -99,6 +118,7 @@ function --rev-label {
 --version-npm(){ echo $VERSION_NPM; }
 --npm-version(){ --version-npm "$@"; }
 
+# shellcheck disable=SC2086  ## varname cannot contain spaces
 set_with_warn(){
    varname=$1
    shift
@@ -106,7 +126,7 @@ set_with_warn(){
    declare -g $varname="$@"
 }
 set_action(){
-   set_with_warn action $1
+   set_with_warn action "$1"
 }
 
 readonly FULL_LIST="commit short SHORT  long LONG  count  COUNT  dirty _dirty DIRTY _DIRTY  tag branch refname"
@@ -114,9 +134,9 @@ readonly FULL_LIST="commit short SHORT  long LONG  count  COUNT  dirty _dirty DI
 ## Unset variables from environment
 unset format install_dir
 
-while [[ $# > 0 ]] ;do
-   case $1 in 
-      --help|-help|help|-h|\?|-\?)  
+while (( $# > 0 )) ;do
+   case $1 in
+      --help|-help|help|-h|\?|-\?)
          --help
          exit
          ;;
@@ -125,7 +145,7 @@ while [[ $# > 0 ]] ;do
          exit
          ;;
       --install-link|--install|--install-script|--update|--update-script)
-         set_action $1
+         set_action "$1"
          ;;
       --install-dir=*)
          set_with_warn install_dir "${1##--install-dir=}"
@@ -142,15 +162,15 @@ while [[ $# > 0 ]] ;do
          force=f
          ;;
       --variables|--vars|-v)
-         set_action $1
+         set_action "$1"
          format=$(echo "$FULL_LIST" | sed -E 's, *([A-Za-z_]+),\1=\$\1\n,g')
          --variables(){ default_action; }
          -v()    { --variables "$@"; }
          --vars(){ --variables "$@"; }
          ;;
       --format=*)       set_with_warn format "${1##--format=}";;
-      --format-file=*)  set_with_warn format "$(cat ${1##--format-file=})";;
-      --format-from=*)  set_with_warn format "$(cat ${1##--format-from=})";;
+      --format-file=*)  set_with_warn format "$(cat "${1##--format-file=}")";;
+      --format-from=*)  set_with_warn format "$(cat "${1##--format-from=}")";;
       --format-from)    fatalerr "option --format-from requires value";;
       -x|--trace|--xtrace)
          # PS4=$'\e[32m+ '
@@ -177,7 +197,7 @@ while [[ $# > 0 ]] ;do
          script_file="${1##--generate-script=}"
          script_file="${script_file:=/dev/stdout}"
          ;;
-      -*|--*) fatalerr "!!! Unknown option $1";;
+      -*) fatalerr "!!! Unknown option $1";;
       *)
          set_with_warn format "$1"
          ;;
@@ -185,43 +205,59 @@ while [[ $# > 0 ]] ;do
    shift
 done
 
-if test ${DEBUG:-empty} != 'empty' ;then
+if test "${DEBUG:-empty}" != 'empty' ;then
    function echodbg { >/dev/stderr echo $'\e[0;36m'"$@"$'\e[0m'; }
-   function DEBUG { "$@" | while read;do echodbg "$REPLY";done ;}
+   function DEBUG { "$@" | while read -r ;do echodbg "$REPLY";done ;}
 else
    function echodbg { :;}
    function DEBUG { :;}
 fi
 
+curl_release(){
+   curl 'https://gitlab.com/kyb/git-rev-label/raw/artifacts/master/git-rev-label' -LsSf "$@"
+}
 ########### MAINTENANCE ACTIONS ###########
 if var_is_set_not_empty action ;then
+   # shellcheck disable=SC2154  ## action is referenced but not assigned.
    case "$action" in
       --update|--update-script)
-         TEMP=`mktemp`
-         curl 'https://gitlab.com/kyb/git-rev-label/raw/artifacts/master/git-rev-label' -LsSf -o $TEMP
-         chmod +x $TEMP
-         if diff -q "${BASH_SOURCE[0]}" $TEMP &>/dev/null ;then
+         TEMP=$(mktemp)
+         curl_release -o "$TEMP"
+         chmod +x "$TEMP"
+         if diff -q "${BASH_SOURCE[0]}" "$TEMP" &>/dev/null ;then
             echomsg "Already up to date."
-            rm -f $TEMP
+            rm -f "$TEMP"
             exit
          else
-            exec mv $TEMP $(readlink -f "${BASH_SOURCE[0]}")
+            exec mv "$TEMP" "$(readlink -f "${BASH_SOURCE[0]}")"
          fi
          ;;
       --install-link)
          install_dir=${install_dir:='/usr/local/bin'}
-         exec ln -s ${force:+-f} $(readlink -f "${BASH_SOURCE[0]}") "$install_dir/git-rev-label"
+         exec ln -s ${force:+-f} "$(readlink -f "${BASH_SOURCE[0]}")" "$install_dir/git-rev-label"
          ;;
       --install|--install-script)
          install_dir=${install_dir:='/usr/local/bin'}
-         install_dir=$(eval echo $install_dir)
-         cp "${BASH_SOURCE[0]}" "$install_dir/git-rev-label"
+         #install_dir=$(eval echo $install_dir)  ## eval is to expand ~, security leak
+         touch "$install_dir/git-rev-label" 2>&- ||
+            fatalerr "Cannot touch '$install_dir/git-rev-label'. "\
+               "Check if directory exists and you have enough access rights!"
+         if test -n "${BASH_SOURCE[0]:-}" ;then
+            cp "${BASH_SOURCE[0]}" "$install_dir/git-rev-label"
+         else
+            curl_release > "$install_dir/git-rev-label"
+         fi
          chmod +x "$install_dir/git-rev-label"
          exit
          ;;
    esac
 fi
 
+## Sanity check
+var_is_set install_dir &&
+   atalerr "--install_dir should only be used with --install action."
+
+
 #####################################################
 ########## SET git rev-label VARIABLES ##############
 ######### Quintessence (quīnta essentia) ############
@@ -231,7 +267,7 @@ if test -z "$format" ;then
    exit 0
 fi
 
-resolve_dependancies(){ 
+resolve_dependancies(){
    sed -E '
       s,\bSHORT\b,short SHORT,g
       s,\bshort\b,commit short,g
@@ -243,6 +279,8 @@ resolve_dependancies(){
    '
 }
 space_newline(){ sed -E 's, +,\n,g' ;}
+
+# shellcheck disable=SC2034  ## shellcheck cannot track variables usage because they are referenced individually
 variables(){
    commit=$(git rev-parse --short HEAD)
    short=$commit
@@ -257,11 +295,14 @@ variables(){
    _DIRTY=${_dirty^^}
    branch="$(git rev-parse --abbrev-ref HEAD | sed s,^HEAD$,DETACHED,)"
    tag="$(git tag --list --points-at HEAD | head -1)"
-   refname=$(if test "$branch" == DETACHED; then echo "${tag:-DETACHED}"; else echo "$branch";fi;)
+   refname=${branch/^DETACHED$/${tag:-DETACHED}}
+}
+# shellcheck disable=SC2034  ## shellcheck cannot track variables usage because they are referenced individually
+variables_always_calculated(){
+   branch="$(git rev-parse --abbrev-ref HEAD | sed s,^HEAD$,DETACHED,)"
+   tag="$(git tag --list --points-at HEAD | head -1)"
+   refname=${branch/^DETACHED$/${tag:-DETACHED}}
 }
-branch="$(git rev-parse --abbrev-ref HEAD | sed s,^HEAD$,DETACHED,)"
-tag="$(git tag --list --points-at HEAD | head -1)"
-refname=$(if test "$branch" == DETACHED; then echo "${tag:-DETACHED}"; else echo "$branch";fi;)
 get_function_body(){
    for f ;do
       declare -f "$f" | sed '1,2d;$d ; s,^    ,,'
@@ -270,14 +311,14 @@ get_function_body(){
 requested_variables_to_be_evaluated(){
    ## Calculate only requested variables: parse $format, detect required vars, then calculate required variables.
    requested_variables=$(echo "$format"| perl -ne '$var="[A-Za-z_][A-Za-z0-9_]+"; print "$1$2 " while m,\$(?:($var)|\{($var)\}),g')
-echodbg requested_variables=$requested_variables
+echodbg requested_variables="$requested_variables"
    if test -z "$requested_variables"
    then return ;fi
-   needed_variables=$(grep -Fx -f <(echo $requested_variables|resolve_dependancies|space_newline)  <(echo $FULL_LIST|space_newline))
-echodbg needed_variables=$needed_variables
+   needed_variables=$(grep -Fx -f <(echo "$requested_variables"|resolve_dependancies|space_newline)  <(echo $FULL_LIST|space_newline))
+echodbg needed_variables="$needed_variables"
    func_variables_body="$(get_function_body variables)"
    for varname in $needed_variables ;do
-      echo "$func_variables_body" |egrep "^\s*$varname="
+      echo "$func_variables_body" | grep "^\s*$varname="
    done
    echo "export $requested_variables"
 }
@@ -293,6 +334,8 @@ expand_env_vars(){
    perl -pe'$var="[A-Za-z_][A-Za-z0-9_]+"; s,\$(?:($var)|\{($var)\}),$ENV{$1//$2}//$&,eg'  ## see https://stackoverflow.com/questions/57635730/match-substitute-and-expand-shell-variable-using-perl
 }
 
+variables_always_calculated
+
 ########################################################
 ########## Handle non-maintenance actions ##############
 default_action(){

package/package.json

@@ -1,7 +1,7 @@
 {
    "name": "git-rev-label",
    "description": "Obtain information about Git repository revision in format like 'master-c73-gbbb6bec'",
-   "version":"2.15.13",
+   "version":"2.18.15",
    "homepage": "https://gitlab.com/kyb/git-rev-label",
    "keywords": [
      "git",