Skip to content

Instantly share code, notes, and snippets.

@LongJohnCoder

LongJohnCoder/script-template.sh

Forked from m-radzikowski/script-template.sh
Created December 15, 2020 14:30
Show Gist options
  • Save LongJohnCoder/47df3e56cf3f8c97f70b0376539d581c to your computer and use it in GitHub Desktop.
Save LongJohnCoder/47df3e56cf3f8c97f70b0376539d581c to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. @m-radzikowski m-radzikowski revised this gist Dec 14, 2020. No changes.
  2. @m-radzikowski m-radzikowski created this gist Dec 14, 2020.
    99 changes: 99 additions & 0 deletions script-template.sh
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,99 @@
    #!/usr/bin/env bash

    set -Eeuo pipefail

    cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null 2>&1

    trap cleanup SIGINT SIGTERM ERR EXIT

    usage() {
    cat <<EOF
    Usage: $(basename "$0") [-h] [-v] [-f] -p param_value arg1 [arg2...]
    Script description here.
    Available options:
    -h, --help Print this help and exit
    -v, --verbose Print script debug info
    -f, --flag Some flag description
    -p, --param Some param description
    EOF
    exit
    }

    cleanup() {
    trap - SIGINT SIGTERM ERR EXIT
    # script cleanup here
    }

    setup_colors() {
    if [[ -t 2 ]] && [[ -z "${NO_COLOR-}" ]] && [[ "${TERM-}" != "dumb" ]]; then
    NOCOLOR='\033[0m' RED='\033[0;31m' GREEN='\033[0;32m' ORANGE='\033[0;33m' BLUE='\033[0;34m' PURPLE='\033[0;35m' CYAN='\033[0;36m' YELLOW='\033[1;33m'
    else
    NOCOLOR='' RED='' GREEN='' ORANGE='' BLUE='' PURPLE='' CYAN='' YELLOW=''
    fi
    }

    msg() {
    echo >&2 -e "${1-}"
    }

    die() {
    local msg=$1
    local code=${2-1} # default exit status 1
    msg "$msg"
    exit "$code"
    }

    parse_params() {
    # default values of variables set from params
    flag=0
    param=''

    while :; do
    case "${1-}" in
    -h | --help)
    usage
    ;;
    -v | --verbose)
    set -x
    ;;
    --no-color)
    NO_COLOR=1
    ;;
    -f | --flag) # example flag
    flag=1
    ;;
    -p | --param) # example named parameter
    param="${2-}"
    shift
    ;;
    -?*)
    die "Unknown option: $1"
    ;;
    *)
    break
    ;;
    esac
    shift
    done

    args=("$@")

    # check required params and arguments
    [[ -z "${param-}" ]] && die "Missing required parameter: param"
    [[ ${#args[@]} -eq 0 ]] && die "Missing script arguments"

    return 0
    }

    parse_params "$@"
    setup_colors

    # script logic here

    msg "${RED}Read parameters:${NOCOLOR}"
    msg "- flag: ${flag}"
    msg "- param: ${param}"
    msg "- arguments: ${args[*]-}"