Vim: Add bash template
It's really complex, but should facilitate writing better standalone scripts Obviously, for one-offs, there's still .sh files
This commit is contained in:
		
							
								
								
									
										148
									
								
								.vim/templates/=template=.bash
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										148
									
								
								.vim/templates/=template=.bash
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,148 @@
 | 
			
		||||
#! /bin/bash
 | 
			
		||||
#
 | 
			
		||||
# %FILE%
 | 
			
		||||
# Copyright (C) %YEAR% %USER% <%MAIL%>
 | 
			
		||||
#
 | 
			
		||||
# Distributed under terms of the %LICENSE% license.
 | 
			
		||||
#
 | 
			
		||||
set -e
 | 
			
		||||
 | 
			
		||||
# Read-only set-once variables
 | 
			
		||||
declare -r _name="$(basename -- "$0")"
 | 
			
		||||
# Options
 | 
			
		||||
declare -a _config=(
 | 
			
		||||
	[foo]="bar"
 | 
			
		||||
	[baz]="bop"
 | 
			
		||||
)
 | 
			
		||||
declare _optconfigfile="${XDG_CONFIG_HOME:-$HOME/.config}/${_name}.conf"
 | 
			
		||||
declare -i _opthelp
 | 
			
		||||
declare -i _optverbose
 | 
			
		||||
# Working variables
 | 
			
		||||
declare -a _args
 | 
			
		||||
declare _return
 | 
			
		||||
 | 
			
		||||
# Helper functions
 | 
			
		||||
log() {
 | 
			
		||||
	# Print a line to the terminal if _optverbose is greater than $2
 | 
			
		||||
	# $2 defaults to 0
 | 
			
		||||
	# loglevel 0: Daily-use messages
 | 
			
		||||
	# loglevel 1: Detailed but not quite debugging
 | 
			
		||||
	# loglevel 2: Definitely debugging
 | 
			
		||||
	[ -z "$1" ] && return 1
 | 
			
		||||
	if (( _optverbose >= ${2:-0} )); then
 | 
			
		||||
		printf "%s\\n" "$1"
 | 
			
		||||
	fi
 | 
			
		||||
}
 | 
			
		||||
warn() {
 | 
			
		||||
	# Print a yellow line to the terminal, respecting _optverbose
 | 
			
		||||
	[ -z "$1" ] && return 1
 | 
			
		||||
	if (( _optverbose >= ${2:-0} )); then
 | 
			
		||||
		if [ -t 1 ]; then
 | 
			
		||||
			printf "\\e[33m%s\\e[0m\\n" "$1"
 | 
			
		||||
		else
 | 
			
		||||
			printf "WARN: %s\\n" "$1"
 | 
			
		||||
		fi
 | 
			
		||||
	fi
 | 
			
		||||
}
 | 
			
		||||
error() {
 | 
			
		||||
	# Print a red line to the terminal, exit if $2 is specified
 | 
			
		||||
	[ -z "$1" ] && return 1
 | 
			
		||||
	if [ -t 2 ]; then
 | 
			
		||||
		printf "\\e[31m%s\\e[0m\\n" "$1" 1>&2
 | 
			
		||||
	else
 | 
			
		||||
		printf "ERROR: %s\\n" "$1" 1>&2
 | 
			
		||||
	fi
 | 
			
		||||
	[ -z "$2" ] && return
 | 
			
		||||
	exit "${2:-1}"
 | 
			
		||||
}
 | 
			
		||||
has() {
 | 
			
		||||
	# Parse out all arguments and try to find them in path
 | 
			
		||||
	# If an argument cannot be found, set _return and fail
 | 
			
		||||
	for prog in "$@"; do
 | 
			
		||||
		if ! command -v "$prog" > /dev/null 2>&1; then
 | 
			
		||||
			_return="$prog"
 | 
			
		||||
			return 1
 | 
			
		||||
		fi
 | 
			
		||||
	done
 | 
			
		||||
	return 0
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
# Core program functions
 | 
			
		||||
printhelp() {
 | 
			
		||||
	cat << EOF
 | 
			
		||||
Usage: $_name [OPTION]... [FILE]...
 | 
			
		||||
 | 
			
		||||
  -c [FILE]		Load the given file in place of the usual config file
 | 
			
		||||
  -h			Print this help text
 | 
			
		||||
  -v			Print more status messages. Stacks
 | 
			
		||||
 | 
			
		||||
Copyright (c) %YEAR% %MAIL%
 | 
			
		||||
Licensed under the %LICENSE% license
 | 
			
		||||
EOF
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
# Main
 | 
			
		||||
main() {
 | 
			
		||||
	# Parse out arguments
 | 
			
		||||
	while [ -n "$1" ]; do
 | 
			
		||||
		# Parse out flags
 | 
			
		||||
		while getopts ":hv" opt; do
 | 
			
		||||
			case $opt in
 | 
			
		||||
				c)
 | 
			
		||||
					_optconfigfile="$OPTARG"
 | 
			
		||||
					;;
 | 
			
		||||
				h)
 | 
			
		||||
					_opthelp=1
 | 
			
		||||
					;;
 | 
			
		||||
				v)
 | 
			
		||||
					_optverbose+=1
 | 
			
		||||
					;;
 | 
			
		||||
				:)
 | 
			
		||||
					error "Option requires argument: -$OPTARG" 2
 | 
			
		||||
					;;
 | 
			
		||||
				*)
 | 
			
		||||
					error "Invalid option: -$OPTARG" 2
 | 
			
		||||
					;;
 | 
			
		||||
			esac
 | 
			
		||||
		done
 | 
			
		||||
		# Store arguments
 | 
			
		||||
		shift $((OPTIND - 1))
 | 
			
		||||
		if [ -n "$1" ]; then
 | 
			
		||||
			_args+=("$1")
 | 
			
		||||
			shift
 | 
			
		||||
		fi
 | 
			
		||||
		unset OPTIND
 | 
			
		||||
	done
 | 
			
		||||
	# Early hook for help
 | 
			
		||||
	[ -n "$_opthelp" ] && printhelp && exit 0
 | 
			
		||||
	# Parse out a config file if it exists
 | 
			
		||||
	if [ -f "$_optconfigfile" ]; then
 | 
			
		||||
		log "Loading config file" 2
 | 
			
		||||
		while read line; do
 | 
			
		||||
			# If the line has an equals sign and isn't a comment
 | 
			
		||||
			if [ "$line" != "${line#*=}" ] && validateline "$line"; then
 | 
			
		||||
				local key="${line%=*}"
 | 
			
		||||
				local value="${line#*=}"
 | 
			
		||||
				_config[$key]="$value"
 | 
			
		||||
				log "Setting $key to $value" 2
 | 
			
		||||
			fi
 | 
			
		||||
		done < "$_optconfigfile"
 | 
			
		||||
	else
 | 
			
		||||
		warn "Could not find configuration file" 2
 | 
			
		||||
	fi
 | 
			
		||||
	# Validate critical options
 | 
			
		||||
	# TODO: That
 | 
			
		||||
	# Validate core program dependencies
 | 
			
		||||
	log "Validating dependencies" 2
 | 
			
		||||
	if ! has basename; then
 | 
			
		||||
		error "Failed to find program: $_return" 1
 | 
			
		||||
	fi
 | 
			
		||||
 | 
			
		||||
	# Do the do
 | 
			
		||||
	# TODO: The do
 | 
			
		||||
	warn "Nothing to do"
 | 
			
		||||
	exit 0
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
main "$@"
 | 
			
		||||
 | 
			
		||||
		Reference in New Issue
	
	Block a user