Move validation to front and rename variables

Planeshifter · Planeshifter · commit fd1946f1c145 · 2022-11-28T20:56:13.000-05:00
diff --git a/lib/node_modules/@stdlib/_tools/scaffold/scripts/scaffold_ai.sh b/lib/node_modules/@stdlib/_tools/scaffold/scripts/scaffold_ai.sh
@@ -22,7 +22,7 @@
 #
 # Environment Variables:
 #
-#   STDLIB_SCAFFOLDING_API_KEY: API key for the AI service.
+#   SCAFFOLD_API_KEY: API key for the AI service.
 
 ## USER-DEFINED VARIABLES ##
 
@@ -64,7 +64,7 @@ function scaffold_request() {
 	func_name=$(echo "$1" | sed 's/[\/.]/-/g')
 
 	# Authentication query string:
-	auth="clientId=${git_email}&code=${STDLIB_SCAFFOLDING_API_KEY}"
+	auth="clientId=${git_email}&code=${SCAFFOLD_API_KEY}"
 
 	# Endpoint URL:
 	url="${endpoint}/${func_name}?${auth}"
@@ -91,11 +91,11 @@ main() {
 	echo "Scaffolding package: ${pkg}" >&2
 	echo '' >&2
 
-	# `README.md` contents:
-	readme_file=$(cat ${readme} | jq -Rs)
-
-	# JSON payload for the API:
-	README='{"readme": '$readme_file'}'
+	# Check whether authentication key is set:
+	if [ -z "${SCAFFOLD_API_KEY}" ]; then
+		echo "Error: missing environment variable 'SCAFFOLD_API_KEY'." >&2
+		exit 1
+	fi
 
 	# Bail if the destination directory does not exist:
 	if [ ! -d "${dest_dir}" ]; then
@@ -109,11 +109,11 @@ main() {
 		exit 1
 	fi
 
-	# Check whether authentication key is set:
-	if [ -z "${STDLIB_SCAFFOLDING_API_KEY}" ]; then
-		echo "Error: missing environment variable 'STDLIB_SCAFFOLDING_API_KEY'." >&2
-		exit 1
-	fi
+	# `README.md` contents:
+	readme_file=$(cat ${readme} | jq -Rs)
+
+	# JSON payload for the API:
+	README='{"readme": '$readme_file'}'
 
 	if [[ ! -f "${dest_dir}/package.json" ]]; then
 		scaffold_request "package.json" "$README"
@@ -160,9 +160,11 @@ main() {
 		if [[ ! -f "${dest_dir}/test/test.cli.js" ]]; then
 			scaffold_request "test/test.cli.js" "$README"
 		fi
-		if [[ ! -f "${dest_dir}/test/fixtures/stdin_error.js.txt" ]]; then
-			mkdir -p ${dest_dir}/test/fixtures
-			curl -s "${endpoint}/test-fixtures-stdlib-error-js-txt" > ${dest_dir}/test/fixtures/stdin_error.js.txt
+		if grep -q "standard stream" "${readme}"; then
+			if [[ ! -f "${dest_dir}/test/fixtures/stdin_error.js.txt" ]]; then
+				mkdir -p ${dest_dir}/test/fixtures
+				curl -s "${endpoint}/test-fixtures-stdlib-error-js-txt" > ${dest_dir}/test/fixtures/stdin_error.js.txt
+			fi
 		fi
 	fi
 	if grep -q "\`\`\`c" "${readme}"; then
diff --git a/tools/make/common.mk b/tools/make/common.mk
@@ -602,4 +602,4 @@ DEPS_CPPCHECK_BUILD_OUT ?= $(DEPS_BUILD_DIR)/cppcheck_$(deps_cppcheck_version_sl
 DEPS_CPPCHECK_PLATFORM := $(shell command -v $(NODE) >/dev/null 2>&1 && $(NODE_HOST_PLATFORM))
 
 # API key for the stdlib scaffolding service:
-STDLIB_SCAFFOLDING_API_KEY ?= $$STDLIB_SCAFFOLDING_API_KEY
+SCAFFOLD_API_KEY ?= $$SCAFFOLD_API_KEY
diff --git a/tools/make/lib/scaffold/Makefile b/tools/make/lib/scaffold/Makefile
@@ -31,13 +31,13 @@ SCAFFOLD_SCRIPT ?= $(TOOLS_PKGS_DIR)/scaffold/scripts/scaffold_ai.sh
 #
 # -   The package directory has to exist and must contain at least the package's `README.md` file for the command to work.
 #
-# @param {string} PKG - package to scaffold (e.g., `math/base/special/sin`)
-# @param {string} STDLIB_SCAFFOLDING_API_KEY - API key for accessing the stdlib scaffolding service
+# @param {string} SCAFFOLD_PKG - package to scaffold (e.g., `math/base/special/sin`)
+# @param {string} SCAFFOLD_API_KEY - API key for accessing the stdlib scaffolding service
 #
 # @example
-# make scaffold PKG=math/base/special/sin
+# make scaffold SCAFFOLD_PKG=math/base/special/sin
 #/
 scaffold:
-	$(QUIET) $(STDLIB_SCAFFOLDING_API_KEY) $(SCAFFOLD_SCRIPT) $(PKG)
+	$(QUIET) $(SCAFFOLD_API_KEY) $(SCAFFOLD_SCRIPT) $(SCAFFOLD_PKG)
 
 .PHONY: scaffold
diff --git a/tools/make/lib/scaffold/README.md b/tools/make/lib/scaffold/README.md
@@ -51,13 +51,13 @@ Scaffold required files for a new or existing package. The package directory has
 <!-- run-disable -->
 
 ```bash
-$ make scaffold PKG=<pkg>
+$ make scaffold SCAFFOLD_PKG=<pkg>
 ```
 
 The command expects the following environment variables to be set:
 
--   **PKG**: package to scaffold, e.g., `math/base/special/sin`.
--   **STDLIB_SCAFFOLDING_API_KEY**: API key for accessing the stdlib scaffolding service.
+-   **SCAFFOLD_PKG**: package to scaffold, e.g., `math/base/special/sin`.
+-   **SCAFFOLD_API_KEY**: API key for accessing the stdlib scaffolding service.
 
 </section>
 

Original file line number	Diff line number	Diff line change
`@@ -31,13 +31,13 @@ SCAFFOLD_SCRIPT ?= $(TOOLS_PKGS_DIR)/scaffold/scripts/scaffold_ai.sh`
`31`	`31`	`#`
`32`	`32`	# - The package directory has to exist and must contain at least the package's `README.md` file for the command to work.
`33`	`33`	`#`
`34`		-# @param {string} PKG - package to scaffold (e.g., `math/base/special/sin`)
`35`		`-# @param {string} STDLIB_SCAFFOLDING_API_KEY - API key for accessing the stdlib scaffolding service`
	`34`	+# @param {string} SCAFFOLD_PKG - package to scaffold (e.g., `math/base/special/sin`)
	`35`	`+# @param {string} SCAFFOLD_API_KEY - API key for accessing the stdlib scaffolding service`
`36`	`36`	`#`
`37`	`37`	`# @example`
`38`		`-# make scaffold PKG=math/base/special/sin`
	`38`	`+# make scaffold SCAFFOLD_PKG=math/base/special/sin`
`39`	`39`	`#/`
`40`	`40`	`scaffold:`
`41`		`- $(QUIET) $(STDLIB_SCAFFOLDING_API_KEY) $(SCAFFOLD_SCRIPT) $(PKG)`
	`41`	`+ $(QUIET) $(SCAFFOLD_API_KEY) $(SCAFFOLD_SCRIPT) $(SCAFFOLD_PKG)`
`42`	`42`
`43`	`43`	`.PHONY: scaffold`