Don't require README.md file for scaffolding

Planeshifter · Planeshifter · commit 94ef82c6eb2a · 2022-11-29T11:13:26.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
@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Script for scaffolding a package based off a README.md file via AI.
+# Script for scaffolding a package via AI.
 #
 # Usage: scaffold.h
 #
@@ -63,11 +63,11 @@ function scaffold_request() {
 	# Get function name from file path:
 	func_name=$(echo "$1" | sed 's/[\/.]/-/g')
 
-	# Authentication query string:
-	auth="clientId=${git_email}&code=${SCAFFOLD_API_KEY}"
+	# Query string:
+	query="clientId=${git_email}&code=${SCAFFOLD_API_KEY}&pkg=${pkg}"
 
 	# Endpoint URL:
-	url="${endpoint}/${func_name}?${auth}"
+	url="${endpoint}/${func_name}?${query}"
 
 	# Make a request to the Azure stdlib scaffolding API:
 	response=$(curl -s -X POST -H "Content-Type: application/json" -d "$2" "${url}")
@@ -97,23 +97,24 @@ main() {
 		exit 1
 	fi
 
-	# Bail if the destination directory does not exist:
+	# Create the destination directory if it does not exist:
 	if [ ! -d "${dest_dir}" ]; then
-		echo "Destination directory does not exist: ${dest_dir}" >&2
-		exit 1
+		mkdir -p "${dest_dir}"
 	fi
 
-	# Bail if the README.md file does not exist:
+	# Scaffold README.md file if does not exist:
 	if [ ! -f "${readme}" ]; then
-		echo "README.md file does not exist: ${readme}" >&2
-		exit 1
-	fi
+		scaffold_request "README.md" "{}"
+		README='{}'
+	else
+		echo "README.md already exists, using it to scaffold remaining files via AI..." >&2
 
-	# `README.md` contents:
-	readme_file=$(cat ${readme} | jq -Rs)
+		# `README.md` contents:
+		readme_file=$(cat ${readme} | jq -Rs)
 
-	# JSON payload for the API:
-	README='{"readme": '$readme_file'}'
+		# JSON payload for the API:
+		README='{"readme": '$readme_file'}'
+	fi
 
 	if [[ ! -f "${dest_dir}/package.json" ]]; then
 		scaffold_request "package.json" "$README"
@@ -127,6 +128,9 @@ main() {
 	if [[ ! -f "${dest_dir}/lib/main.js" ]]; then
 		scaffold_request "lib/main.js" "$README"
 	fi
+	if [[ ! -f "${dest_dir}/lib/validate.js" ]] && [[ $(cat ${readme} | grep -c 'options') -gt 0 ]]; then
+		scaffold_request "lib/validate.js" "$README"
+	fi
 	if [[ ! -f "${dest_dir}/test/test.js" ]]; then
 		scaffold_request "test/test.js" "$README"
 	fi
diff --git a/tools/make/lib/scaffold/README.md b/tools/make/lib/scaffold/README.md
@@ -46,7 +46,7 @@ Usage: make <command> [<ENV_VAR>=<value> <ENV_VAR>=<value> ...]
 
 #### scaffold
 
-Scaffold required files for a new or existing package. The package directory has to exist and must contain at least the package's `README.md` file for the command to work.
+Scaffold required files for a new or existing package. The command will create highly customized files when the package directory already contains at least the `README.md` file; otherwise, the command will create a default `README.md` and scaffold the remaining files using placeholder values.
 
 <!-- run-disable -->
 
