shell-helpers

shell-helpers - a utilitarian? bash shell library

add shell-helpers to your project

caution active development. start with the v2 branch -- api will stabilize once an official release is made.

shell-helpers is periodically packaged as a monolithic library file and merged into a release branch (along with individual library files).

Releases are published to;

• get.iceburg.net
• github

as an executable

curl -L http://get.iceburg.net/shell-helpers/latest-v2/shell-helpers > \
  /usr/local/bin/shell-helpers
chmod +x /usr/local/bin/shell-helpers

usage (as executable) in your project

You may now start your scripts with a shell-helpers shebang, and all the helper functions will be available.

#!/usr/bin/env shell-helpers

main(){
  set -eo pipefail
  p/success "shell helpers loaded!"
}

main "$@"

as a library

example adds helpers to my-project/lib/helpers

mkdir -p my-project/lib/helpers && cd my-project/lib/helpers

# download v2 release
curl -L http://get.iceburg.net/shell-helpers/latest-v2/shell-helpers > \
  shell-helpers.sh

# [optional] add downstreamer
curl -L http://get.iceburg.net/shell-helpers/latest-v2/downstream-helpers > \
  downstream-helpers && chmod +x downstream-helpers

alternatively, use git subtree if you plan to push changes back to our project

# attach v2 release as subtree under lib.d/helper
#   **change --prefix to your needs**
cd /path/to/my-project/
prefix="lib/helpers"
git subtree add --prefix="$prefix"s [email protected]:briceburg/shell-helpers.git v2

to update once attached, use git subtree pull

usage (as library) in your project

dex is a good example for using shell-helpers. It includes our downstreamer for keeping shell-helpers updated. See the lib.d/helpers directory in dex.

single library file

main(){
  readonly SCRIPT_CWD="$( cd $(dirname ${BASH_SOURCE[0]}) ; pwd -P )"

  . "$SCRIPT_CWD/lib/helpers/shell-helpers.sh" || {
    echo "shell-helpers.sh is required"
    exit 2
  }
}

a-la-carte

If you cloned from git or are using a-la-carte (individual) helper files, source them in your script with something like:

# my-project/script.sh
for helper in $(find lib/helpers/ -type f -name "*.sh"); do
  . $helper
done

a couple of conventions

finds a list, gets a string

find/ usually returns a list, get/ usually returns a string. E.g.

render/templates(){
  local source_dir="$1"
  local cmd
  local dir
  local template

  # NOTE: get/ returns string
  cmd="$(get/cmd j2cli nunjucks)"

  # NOTE: find/ returns list
  for dir in $(find/dirs "$source_dir"); do
    template="$dir/template.j2"
    [ -e "$template" ] && {
      p/notice "rendering $template ..."
      $cmd "$template"
      p/success "rendered $template"
    }
  done
}

lookups on the left

patterns, searches, needles, lookups -- whatever you want to call them -- are typically "on-the-left" or the first argument passed to a function. e.g.

list=(
  apple
  orange
  starfruit
)

is/in_list "starfruit" "${list[@]}" && {
  echo "holy smokes! starfruit on on board captain!"
}

targets on the right

targets, destinations, lookup sources, -- whatever you want to call them -- are typically "on-the-right" or the last argument passed to a function. e.g.

file/interpolate "^127.0.0.1" "127.0.0.1 localhost dev" "/etc/hosts"

updating shell-helpers

As shell-helpers evolves, you may want to fetch changes. A downstreamer is provided to make this process more convenient.

Running the downstreamer searches through shell scripts for an update signature, and attempts to update all matching files. It respect the original release branch -- so won't bump you to a newly released "major" version. See the example in dex .