Add sh script template

templates/skeleton.sh

@@ -0,0 +1,163 @@
+#!/bin/sh
+#
+# Purpose {{{
+# This script will …
+#   1. …
+# …
+#
+# !!DATE!!
+# }}}
+# Vars {{{
+readonly PROGNAME=$(basename "${0}")
+readonly PROGDIR=$(readlink -m $(dirname "${0}"))
+readonly ARGS="${*}"
+readonly NBARGS="${#}"
+[ -z "${DEBUG}" ] && DEBUG=1
+## Export DEBUG for sub-script
+export DEBUG
+
+## Default values for some vars
+#readonly MY_VAR_XY_DEFAULT="666"
+
+## Colors
+readonly PURPLE='\033[1;35m'
+readonly RED='\033[0;31m'
+readonly RESET='\033[0m'
+readonly COLOR_DEBUG="${PURPLE}"
+# }}}
+usage() {                                                       # {{{
+
+	cat <<- HELP
+usage: $PROGNAME [-d|-h]
+
+Try to give a description…
+
+EXAMPLES :
+    - Apply my script to…
+        ${PROGNAME}
+
+OPTIONS :
+    -d,--debug
+        Enable debug messages.
+
+    -h,--help
+        Print this help message.
+
+HELP
+
+}
+# }}}
+debug_message() {                                               # {{{
+
+	local_debug_message="${1}"
+
+	## Print message if DEBUG is enable (=0)
+	[ "${DEBUG}" -eq "0" ] && printf '\e[1;35m%-6b\e[m\n' "DEBUG − ${PROGNAME} : ${local_debug_message}"
+
+	unset local_debug_message
+
+	return 0
+}
+# }}}
+error_message() {                                               # {{{
+
+	local_error_message="${1}"
+	local_error_code="${2}"
+
+	## Print message
+	printf '%b\n' "ERROR − ${PROGNAME} : ${RED}${local_error_message}${RESET}"
+
+	exit "${local_error_code:=66}"
+}
+# }}}
+define_vars() {                                                 # {{{
+
+	## If my_var_xy wasn't defined (argument) {{{
+	#if [ -z "${my_var_xy}" ]; then
+		### Use default value
+		#readonly my_var_xy="${MY_VAR_XY_DEFAULT}"
+	#fi
+	## }}}
+
+}
+# }}}
+
+main() {                                                        # {{{
+
+	## If script should not be executed right now {{{
+	### Exit
+	is_script_ok \
+		&& exit 0
+	## }}}
+
+	## Define all vars
+	define_vars
+
+}
+# }}}
+
+# Manage arguments                                                # {{{
+# This code can't be in a function due to argument management
+
+if [ ! "${NBARGS}" -eq "0" ]; then
+
+	manage_arg="0"
+
+	## If the first argument is not an option
+	if ! printf -- '%s' "${1}" | grep -q -E -- "^-+";
+	then
+		## Print help message and exit
+		printf '%b\n' "${RED}Invalid option: ${1}${RESET}"
+		printf '%b\n' "---"
+		usage
+
+		exit 1
+	fi
+
+	# Parse all options (start with a "-") one by one
+	while printf -- '%s' "${1}" | grep -q -E -- "^-+"; do
+
+	case "${1}" in
+		-d|--debug )                          ## debug
+			DEBUG=0
+			;;
+		-h|--help )                           ## help
+			usage
+			## Exit after help informations
+			exit 0
+			;;
+		#-v|--var )                            ## Define var with given arg
+			### Move to the next argument
+			#shift
+			### Define var
+			#readonly my_var_xy="${1}"
+			#;;
+		* )                                   ## unknow option
+			printf '%b\n' "${RED}Invalid option: ${1}${RESET}"
+			printf '%b\n' "---"
+			usage
+			exit 1
+			;;
+	esac
+
+	debug_message "Arguments management − \
+${RED}${1}${COLOR_DEBUG} option managed."
+
+	## Move to the next argument
+	shift
+	manage_arg=$((manage_arg+1))
+
+	done
+
+	debug_message "Arguments management − \
+${RED}${manage_arg}${COLOR_DEBUG} argument(s) successfully managed."
+else
+	debug_message "Arguments management − \
+No arguments/options to manage."
+fi
+
+# }}}
+
+main
+
+exit 255