implement task positional-argument handling

Author: evnp

Makefile

@@ -11,8 +11,12 @@ e end: # stop app
 	@echo "stop app"
 
 .PHONY: t test
-t test: # run all tests or specific test [vars: name='all']
-	@[[ -n "$(name)" ]] && echo "run test $(name)" || echo "run test all"
+t test: # run all tests or specific test [vars: name]
+	@[[ -n "$(1)" ]] && echo "run test $(1)" || echo "run test all"
+
+.PHONY: tests
+tests: # run multiple tests [vars: names]
+	@echo "run tests $(@)"
 
 .PHONY: r repl
 r repl: # start shell in project environment [vars: env='']

Runfile

@@ -5,8 +5,11 @@ s start: end # start app
 e end: # stop app
 	echo "stop app"
 
-t test: # run all tests or specific test [vars: name='all']
-	[[ -n "$(name)" ]] && echo "run test $(name)" || echo "run test all"
+t test: # run all tests or specific test [vars: name]
+	[[ -n "$(1)" ]] && echo "run test $(1)" || echo "run test all"
+
+tests: # run multiple tests [vars: names]
+	echo "run tests $(@)"
 
 r repl: # start shell in project environment [vars: env='']
 	echo "start shell in project environment: $(env)"

runfile.sh

@@ -18,8 +18,10 @@ echo "start app"
 run frontend
 e end: # stop app
 echo "stop app"
-t test: # run all tests or specific test [vars: name='all']
-[[ -n "\$(name)" ]] && echo "run test \$(name)" || echo "run test all"
+t test: # run all tests or specific test [vars: name]
+[[ -n \$(1) ]] && echo "run test \$(1)" || echo "run test all"
+tests: # run multiple tests [vars: names]
+echo "run tests \$(@)"
 r repl: # start shell in project environment [vars: env='']
 echo "start shell in project environment: \$(env)"
 EOF
@@ -32,8 +34,11 @@ s start: end # start app
 e end: # stop app
 	echo "stop app"
 
-t test: # run all tests or specific test [vars: name='all']
-	[[ -n "\$(name)" ]] && echo "run test \$(name)" || echo "run test all"
+t test: # run all tests or specific test [vars: name]
+	[[ -n \$(1) ]] && echo "run test \$(1)" || echo "run test all"
+
+tests: # run multiple tests [vars: names]
+	echo "run tests \$(@)"
 
 r repl: # start shell in project environment [vars: env='']
 	echo "start shell in project environment: \$(env)"
@@ -75,7 +80,7 @@ function print-file-smartcase() {
 }
 
 function print-makefile() {
-	sed -E "s!\t${at}make --makefile ${mf} !\t${at}make !" "$@"
+	sed -E "s!\t${at}make --makefile ${makefile} !\t${at}make !" "$@"
 }
 
 function cd-to-nearest-file() { local lower='' upper='' title=''
@@ -100,7 +105,8 @@ function cd-to-nearest-file() { local lower='' upper='' title=''
 }
 
 function main() ( set -euo pipefail
-	local mf='' at='' ws='' rewrite="" cmd="" arg='' make_args=() cmd_args=()
+	local makefile='' buffer='' at='' ws='' rewrite='' cmd=''
+	local arg='' make_args=() cmd_args=() pos_args=() pos_arg_idx=0
 
 	# Handle various optional actions:
 	[[ " $* " == *' --create-runfile '* || " $* " == *' --overwrite-runfile '* ]] && \
@@ -116,14 +122,14 @@ function main() ( set -euo pipefail
 	cd-to-nearest-file runfile
 
 	# Local values:
-	mf="$( mktemp )"	# Temporary makefile which we will pass to make.
-	at="@"						# @-prefix causes make to execute commands silently.
-	args=()						# Arguments that will be passed on to invoked run command.
+	makefile="$( mktemp )"	# Temporary makefile which we will pass to make.
+	at="@"									# @-prefix causes make to execute commands silently.
+	args=()									# Arguments that will be passed on to invoked run command.
 
 	# Existing Makefile Compatibility:
 	# If 'run cmd' or 'make cmd' appears within another command in a Runfile,
-	# normally we'd rewrite these both to 'make --makefile ${mf}' to avoid invoking
-	# runfile.sh recursively. However, if a separate Makefile exists in the same directory
+	# normally we'd rewrite these to 'make --makefile ${makefile}' to avoid invoking
+	# runfile.sh recursively. However, if a separate Makefile exists in same directory
 	# as the current Runfile we're executing a command for, we WON'T rewrite 'make cmd'
 	# in this way. In that case, leaving 'make cmd' alone allows the user to reference
 	# a command in the existing Makefile from their runfile.sh command.
@@ -157,23 +163,26 @@ function main() ( set -euo pipefail
 			elif [[ " ${arg}" == *' -' ]]
 			then
 				make_args+=( "${arg}" )
-			else
+			elif [[ "${arg}" =~ ^[a-zA-Z0-9_-]+\= ]]
+			then
 				cmd_args+=( "${arg}" )
+			else
+				pos_args+=( "${arg}" )
 			fi
 		fi
 	done
 
 # ::::::::::::::::::::::::::::::::::::::::::
 # Construct temporary Makefile from Runfile:
-cat <<EOF> "${mf}"
+cat <<EOF> "${makefile}"
 .PHONY: _tasks
 _tasks: .tasks
 
 $(
 	sed -E \
 		-e "s!^[[:space:]]*!\t${at}!" \
 		-e "s!^\t${at}([a-zA-Z0-9 _-]+):([a-zA-Z0-9 _-]+)?#(.*)\$!.PHONY: \1\n\1:\2#\3!" \
-		-e "s!^\t${at}${rewrite} !\t${at}make --makefile ${mf} !" \
+		-e "s!^\t${at}${rewrite} !\t${at}make --makefile ${makefile} !" \
 		-e "s!^\t${at}\$!!" \
 		Runfile
 )
@@ -186,6 +195,36 @@ EOF
 # Done with temporary Makefile construction.
 # ::::::::::::::::::::::::::::::::::::::::::
 
+	# Handle positional command arguments if any were provided:
+	if [[ " $* " != *' --print-makefile '* ]] \
+		&& [[ " $* " != *' --create-makefile '* ]] \
+		&& [[ " $* " != *' --overwrite-makefile '* ]]
+	then
+		buffer="$( cat "${makefile}" )"
+		if ! (( ${#pos_args[@]} ))
+		then
+			# Case where no positional args were provided:
+			# Replace $(@) and $(1) $(2) etc. in script with empty backtick expression (``).
+			# This seems odd, but it allows tasks like: [[ -n $(1) ]] && echo "$1"
+			# to work whether or not $1 positional arg was provided. Without it, make will
+			# error out due to the script being interpreted as [[ -n  ]]. With standard
+			# quotes instead of backticks, expressions like echo "$1" will inadvertently
+			# print the quotes.
+			buffer="${buffer//\$([0-9@])/\`\`}"
+		else
+			# Replace $(@) in script with concatenation of all positional args:
+			buffer="${buffer//\$(@)/${pos_args[*]}}"
+			# Replace $(1) $(2) etc. in script with each individual positional arg:
+			for arg in "${pos_args[@]}"
+			do
+				(( pos_arg_idx++ )) || true
+				buffer="${buffer//\$(${pos_arg_idx})/${arg}}"
+			done
+		fi
+		# Write buffer back to temporary makefile:
+		echo "${buffer}" > "${makefile}"
+	fi
+
 	# --create-makefile : Write generated Makefile, open in editor (optional) then exit.
 	# --overwrite-makefile : Can be used to overwrite when Makefile already exists.
 	if [[ " $* " == *' --create-makefile '* || " $* " == *' --overwrite-makefile '* ]]
@@ -195,11 +234,19 @@ EOF
 		then
 			echo 'Makefile already exists. To overwrite, use:'
 			echo 'make --overwrite-makefile'
-			rm "${mf}"
+			rm "${makefile}"
 			exit 1
 		else
-			print-makefile "${mf}" > ./Makefile
-			rm "${mf}"
+			if grep -qE '\$\([@0-9]\)' "${makefile}"
+			then
+				echo 'Warning: Your runfile uses positional args $(@) $(1) $(2) etc.'
+				echo "which aren't compatible with Make. You'll need to update these"
+				echo 'commands to accept standard Make-style named arguments:'
+				echo '$(abc) in your Makefile, passed to task as: $ make task abc=xyz'
+				echo
+			fi
+			print-makefile "${makefile}" > ./Makefile
+			rm "${makefile}"
 			edit-file-smartcase makefile --confirm
 			exit 0
 		fi
@@ -208,8 +255,8 @@ EOF
 	# --print-makefile : Print generated Makefile then exit.
 	if [[ " $* " == *' --print-makefile '* ]]
 	then
-		print-makefile "${mf}"
-		rm "${mf}"
+		print-makefile "${makefile}"
+		rm "${makefile}"
 		exit 0
 	fi
 
@@ -222,10 +269,10 @@ EOF
 		make_args+=( "${cmd}" )
 	fi
 
-	make --makefile "${mf}" "${make_args[@]}" -- "${cmd_args[@]}"
+	make --makefile "${makefile}" "${make_args[@]}" -- "${cmd_args[@]}"
 
 	# Clean up temporary Makefile and exit with success:
-	rm "${mf}"
+	rm "${makefile}"
 	exit 0
 )