Refactor bare template args, add interpreter var

Author: remino

man/mkx.1

@@ -16,7 +16,7 @@ Only write a bare script with only the shebang line, without template.
 Show help screen.
 .TP
 .B \-i \fIINTERPRETER\fR
-Specify the interpreter to use in the shebang line.
+Specify the interpreter to use in the shebang line. Defaults to $fI/usr/bin/env bash\fR.
 .TP
 .B \-s
 Use /bin/sh as interpreter in the shebang line. Implies \-b.
@@ -37,17 +37,23 @@ The directory \fI$XDG_CONFIG_HOME/mkx/templates\fR if the environment variable \
 .TP
 The following variables are available:
 .TP
-.B \fIscript_name\fR
-The name of the script.
-.TP
-.B \fIscript_name_sc\fR
-The name of the script in lowercase.
-.TP
 .B \fIdate\fR
 The date when the script was created in format \fI%Y-%m-%d %H:%M:%S %Z\fR.
 .TP
+.B \fIinterpreter\fR
+The interpreter specified with the \fI-i\fR option or the default interpreter.
+.TP
+.B \fImkx_version\fR
+The version of mkx.
+.TP
 .B \fImkx_version\fR
 The version of mkx.
+.TP
+.B \fIscript_name\fR
+The name of the script.
+.TP
+.B \fIscript_name_sc\fR
+The name of the script in lowercase.
 .SH AUTHOR
 Written by Rémino Rem: <https://remino.net/>
 .SH "ISSUES"

mkx

@@ -24,14 +24,14 @@ mkx_main() {
 
 	while getopts bhi:lst:v opt; do
 		case $opt in
-		b) BARE=1 ;;
+		b) TEMPLATE_NAME='bare' ;;
 		h) _help && return ;;
 		i)
-			BARE=1
+			TEMPLATE_NAME='bare'
 			INTERPRETER="$OPTARG"
 			;;
 		s)
-			BARE=1
+			TEMPLATE_NAME='bare'
 			INTERPRETER="/bin/sh"
 			;;
 		t) TEMPLATE_NAME="$OPTARG" ;;
@@ -48,32 +48,20 @@ mkx_main() {
 
 	shift
 
-	if [ $BARE -eq 0 ]; then
-		_template
-	else
-		_bare
-	fi
+	_template
 
 	chmod a+x "$NEW_SCRIPT"
 	_echo "$NEW_SCRIPT"
 	_exit
 }
 
-_bare() {
-	if [ ! -f "$NEW_SCRIPT" ]; then
-		echo "#!$INTERPRETER" >"$NEW_SCRIPT"
-		echo "" >>"$NEW_SCRIPT"
-	fi
-
-	[ -f "$NEW_SCRIPT" ] && chmod a+x "$NEW_SCRIPT"
-}
-
 _find_template() {
 	template_name="$1"
 
 	for filepath in \
 		"$MKX_TEMPLATES_DIR/$template_name.mustache" \
-		"${XDG_CONFIG_HOME:-$HOME/.config}/mkx/templates/$template_name.mustache"; do
+		"${XDG_CONFIG_HOME:-$HOME/.config}/mkx/templates/$template_name.mustache" \
+		"$1"; do
 		if [ -f "$filepath" ]; then
 			echo "$filepath"
 			return
@@ -94,6 +82,13 @@ _exit() {
 	exit $exit_code
 }
 
+_fatal() {
+	exit_code="$1"
+	shift
+	_error "$@"
+	_exit "$exit_code"
+}
+
 _help() {
 	cat <<USAGE
 $SCRIPT_NAME $VERSION
@@ -102,16 +97,17 @@ USAGE: $SCRIPT_NAME [-bhsvx] [-i <interpreter>] [-t <template>] <scriptfile>
 
 Make new shell script executable file from template.
 
+If the file exists, make it executable.
+
 OPTIONS:
 
 	-b        Only write a bare script with only the shebang line, without template.
-	          If output file already exists, make it executable.
 
 	-h        Show this help screen.
 
-	-i        Specify interpreter in shebang line. Implies -b.
+	-i        Specify interpreter in shebang line. Implies -b if -t is not specified.
 
-	-s        Use /bin/sh as interpreter. Implies -b.
+	-s        Use /bin/sh as interpreter, like '-i /bin/sh'.
 
 	-t        Specify template file. If not specified, uses 'default'.
 
@@ -128,18 +124,17 @@ _invalid_opt() {
 }
 
 _template() {
+	interpreter="$INTERPRETER"
 	new_script_name="$(basename "$NEW_SCRIPT")"
 	new_script_name_sc="$(echo "$new_script_name" | sed 's/-/_/g')"
 	template_file="$(_find_template "$TEMPLATE_NAME")"
 
 	if [ -z "$template_file" ]; then
-		_error "Template file not found: $template_file"
-		return $E_NO_TEMPLATE
+		_fatal $E_NO_TEMPLATE "Template file not found: $TEMPLATE_NAME"
 	fi
 
 	if [ -f "$NEW_SCRIPT" ]; then
-		_error "File already exists: $NEW_SCRIPT"
-		return $E_EXISTS
+		_echo "Making file exectuable: $NEW_SCRIPT"
 	fi
 
 	date="$(date +'%Y-%m-%d %H:%M:%S %Z')"

templates/bare.mustache

@@ -0,0 +1,2 @@
+#!{{interpreter}}
+

templates/default.mustache

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!{{interpreter}}
 # {{script_name}}
 
 # Generated using mkx {{mkx_version}}: https://github.com/remino/mkx

templates/main.mustache

@@ -0,0 +1,7 @@
+#!{{interpreter}}
+
+{{script_name_sc}}_main() {
+	true
+}
+
+{{script_name_sc}}_main "$@"

tests/mkx.bats

@@ -7,7 +7,7 @@ teardown() {
 }
 
 @test "shows version" {
-	local version="$( grep VERSION ./mkx | grep -o '[0-9]\+\.[0-9]\+\.[0-9]\+' )"
+	local version="$(grep VERSION ./mkx | grep -o '[0-9]\+\.[0-9]\+\.[0-9]\+')"
 
 	run ./mkx -v
 
@@ -28,8 +28,8 @@ teardown() {
 	run ./mkx "$OUTPUT_FILE"
 
 	[ "$status" -eq 0 ]
-	[ "$( head -n 1 "$OUTPUT_FILE" )" = "#!/usr/bin/env bash" ]
-	[ "$( wc -l < "$OUTPUT_FILE" )" -gt 2 ]
+	[ "$(head -n 1 "$OUTPUT_FILE")" = "#!/usr/bin/env bash" ]
+	[ "$(wc -l <"$OUTPUT_FILE")" -gt 2 ]
 	[ -x "$OUTPUT_FILE" ]
 	[ -f "$OUTPUT_FILE" ]
 }
@@ -40,8 +40,8 @@ teardown() {
 	run ./mkx -t default "$OUTPUT_FILE"
 
 	[ "$status" -eq 0 ]
-	[ "$( head -n 1 "$OUTPUT_FILE" )" = "#!/usr/bin/env bash" ]
-	[ "$( wc -l < "$OUTPUT_FILE" )" -gt 2 ]
+	[ "$(head -n 1 "$OUTPUT_FILE")" = "#!/usr/bin/env bash" ]
+	[ "$(wc -l <"$OUTPUT_FILE")" -gt 2 ]
 	[ -x "$OUTPUT_FILE" ]
 	[ -f "$OUTPUT_FILE" ]
 }
@@ -52,8 +52,8 @@ teardown() {
 	run ./mkx -b "$OUTPUT_FILE"
 
 	[ "$status" -eq 0 ]
-	[ "$( head -n 1 "$OUTPUT_FILE" )" = "#!/usr/bin/env bash" ]
-	[ "$( wc -l < "$OUTPUT_FILE" )" -eq 2 ]
+	[ "$(head -n 1 "$OUTPUT_FILE")" = "#!/usr/bin/env bash" ]
+	[ "$(wc -l <"$OUTPUT_FILE")" -eq 2 ]
 	[ -x "$OUTPUT_FILE" ]
 	[ -f "$OUTPUT_FILE" ]
 }
@@ -64,8 +64,19 @@ teardown() {
 	run ./mkx -s "$OUTPUT_FILE"
 
 	[ "$status" -eq 0 ]
-	[ "$( head -n 1 "$OUTPUT_FILE" )" = "#!/bin/sh" ]
-	[ "$( wc -l < "$OUTPUT_FILE" )" -eq 2 ]
+	[ "$(head -n 1 "$OUTPUT_FILE")" = "#!/bin/sh" ]
+	[ "$(wc -l <"$OUTPUT_FILE")" -eq 2 ]
 	[ -x "$OUTPUT_FILE" ]
 	[ -f "$OUTPUT_FILE" ]
 }
+
+@test "make file exectuable if it already exists" {
+	OUTPUT_FILE="$(mktemp)"
+	rm -f "$OUTPUT_FILE"
+	touch "$OUTPUT_FILE"
+	chmod -w "$OUTPUT_FILE"
+	run ./mkx "$OUTPUT_FILE"
+
+	[ "$status" -eq 0 ]
+	[ -x "$OUTPUT_FILE" ]
+}