Improve practice exercise generator script #1648

Stub generator patch

Author: dem4ron

.github/workflows/tests.yml

@@ -88,6 +88,8 @@ jobs:
 
       - name: Run shellcheck
         uses: ludeeus/action-shellcheck@00cae500b08a931fb5698e11e79bfbd38e612a38 # v2.0.0
+        env: 
+          SHELLCHECK_OPTS: -x -s bash -e SC2001 --norc
 
   compilation:
     name: Check compilation

bin/.shellcheckrc

@@ -0,0 +1,3 @@
+shell=bash
+external-sources=true 
+disable=SC2001

bin/add_practice_exercise

@@ -1,6 +1,13 @@
 #!/usr/bin/env bash
 
-# shellcheck source=/dev/null
+# see comment in generator-utils/utils.sh
+# shellcheck source=bin/generator-utils/utils.sh
+# shellcheck source=bin/generator-utils/templates.sh
+# shellcheck source=bin/generator-utils/prompts.sh
+# shellcheck source=./generator-utils/utils.sh
+# shellcheck source=./generator-utils/prompts.sh
+# shellcheck source=./generator-utils/templates.sh
+
 source ./bin/generator-utils/utils.sh
 source ./bin/generator-utils/prompts.sh
 source ./bin/generator-utils/templates.sh
@@ -30,51 +37,52 @@ command -v curl >/dev/null 2>&1 || {
     exit 1
 }
 
+# Build configlet
+bin/fetch-configlet
+message "success" "Fetched configlet successfully!"
+
 # Check if exercise exists in configlet info or in config.json
 check_exercise_existence "$1"
 
 # ==================================================
 
-SLUG="$1"
-HAS_CANONICAL_DATA=true
+slug="$1"
 # Fetch canonical data
-canonical_json=$(bin/fetch_canonical_data "$SLUG")
+canonical_json=$(bin/fetch_canonical_data "$slug")
 
+has_canonical_data=true
 if [ "${canonical_json}" == "404: Not Found" ]; then
-    HAS_CANONICAL_DATA=false
+    has_canonical_data=false
     message "warning" "This exercise doesn't have canonical data"
 
 else
     echo "$canonical_json" >canonical_data.json
     message "success" "Fetched canonical data successfully!"
 fi
 
-UNDERSCORED_SLUG=$(dash_to_underscore "$SLUG")
-EXERCISE_DIR="exercises/practice/${SLUG}"
-EXERCISE_NAME=$(format_exercise_name "$SLUG")
-message "info" "Using ${YELLOW}${EXERCISE_NAME}${BLUE} as a default exercise name. You can edit this later in the config.json file"
+underscored_slug=$(dash_to_underscore "$slug")
+exercise_dir="exercises/practice/${slug}"
+exercise_name=$(format_exercise_name "$slug")
+message "info" "Using ${yellow}${exercise_name}${blue} as a default exercise name. You can edit this later in the config.json file"
 # using default value for difficulty
-EXERCISE_DIFFICULTY=$(validate_difficulty_input "${2:-$(get_exercise_difficulty)}")
-message "info" "The exercise difficulty has been set to ${YELLOW}${EXERCISE_DIFFICULTY}${BLUE}. You can edit this later in the config.json file"
+exercise_difficulty=$(validate_difficulty_input "${2:-$(get_exercise_difficulty)}")
+message "info" "The exercise difficulty has been set to ${yellow}${exercise_difficulty}${blue}. You can edit this later in the config.json file"
 # using default value for author
-AUTHOR_HANDLE=${3:-$(get_author_handle)}
-message "info" "Using ${YELLOW}${AUTHOR_HANDLE}${BLUE} as author's handle. You can edit this later in the 'authors' field in the ${EXERCISE_DIR}/.meta/config.json file"
-
-
-create_rust_files "$EXERCISE_DIR" "$SLUG" "$HAS_CANONICAL_DATA"
+author_handle=${3:-$(get_author_handle)}
+message "info" "Using ${yellow}${author_handle}${blue} as author's handle. You can edit this later in the 'authors' field in the ${exercise_dir}/.meta/config.json file"
 
+create_rust_files "$exercise_dir" "$slug" "$has_canonical_data"
 
 # ==================================================
 
-# build configlet
-./bin/fetch-configlet
-message "success" "Fetched configlet successfully!"
 
 # Preparing config.json
 message "info" "Adding instructions and configuration files..."
-UUID=$(bin/configlet uuid)
 
-jq --arg slug "$SLUG" --arg uuid "$UUID" --arg name "$EXERCISE_NAME" --arg difficulty "$EXERCISE_DIFFICULTY" \
+uuid=$(bin/configlet uuid)
+
+# Add exercise-data to global config.json
+jq --arg slug "$slug" --arg uuid "$uuid" --arg name "$exercise_name" --arg difficulty "$exercise_difficulty" \
     '.exercises.practice += [{slug: $slug, name: $name, uuid: $uuid, practices: [], prerequisites: [], difficulty: $difficulty}]' \
     config.json >config.json.tmp
 # jq always rounds whole numbers, but average_run_time needs to be a float
@@ -84,18 +92,21 @@ message "success" "Added instructions and configuration files"
 
 # Create instructions and config files
 echo "Creating instructions and config files"
-./bin/configlet sync --update --yes --docs --metadata --exercise "$SLUG"
-./bin/configlet sync --update --yes --filepaths --exercise "$SLUG"
-./bin/configlet sync --update --tests include --exercise "$SLUG"
+
+./bin/configlet sync --update --yes --docs --metadata --exercise "$slug"
+./bin/configlet sync --update --yes --filepaths --exercise "$slug"
+./bin/configlet sync --update --tests include --exercise "$slug"
 message "success" "Created instructions and config files"
 
-META_CONFIG="$EXERCISE_DIR"/.meta/config.json
-jq --arg author "$AUTHOR_HANDLE" '.authors += [$author]' "$META_CONFIG" >"$META_CONFIG".tmp && mv "$META_CONFIG".tmp "$META_CONFIG"
+# Push author to "authors" array in ./meta/config.json
+meta_config="$exercise_dir"/.meta/config.json
+jq --arg author "$author_handle" '.authors += [$author]' "$meta_config" >"$meta_config".tmp && mv "$meta_config".tmp "$meta_config"
 message "success" "You've been added as the author of this exercise."
 
-sed -i "s/name = \".*\"/name = \"$UNDERSCORED_SLUG\"/" "$EXERCISE_DIR"/Cargo.toml
+sed -i "s/name = \".*\"/name = \"$underscored_slug\"/" "$exercise_dir"/Cargo.toml
 
 message "done" "All stub files were created."
 
 message "info" "After implementing the solution, tests and configuration, please run:"
-echo "./bin/configlet fmt --update --yes --exercise ${SLUG}"
+
+echo "./bin/configlet fmt --update --yes --exercise ${slug}"

bin/build_exercise_crate.sh

@@ -1,6 +1,11 @@
 #!/usr/bin/env bash
 # This script fetches the canonical data of the exercise.
 
+
+# Exit if anything fails.
+set -euo pipefail
+
+
 if [ $# -ne 1 ]; then
   echo "Usage: bin/fetch_canonical_data <exercise-slug>"
   exit 1

bin/fetch_canonical_data

@@ -1,50 +1,61 @@
 #!/usr/bin/env bash
 
+
+# Exit if anything fails.
 set -euo pipefail
-# shellcheck source=/dev/null
+
+
+# see comment in generator-utils/utils.sh
+# shellcheck source=bin/generator-utils/utils.sh
+# shellcheck source=./generator-utils/utils.sh
 source ./bin/generator-utils/utils.sh
 
-function digest_template() {
+digest_template() {
+  local template
   template=$(cat bin/test_template)
-  # shellcheck disable=SC2001
-  # turn every token into a jq command
+  # Turn every token into a jq command
+
   echo "$template" | sed 's/${\([^}]*\)\}\$/$(echo $case | jq -r '\''.\1'\'')/g'
 }
 
 message "info" "Generating tests.."
 canonical_json=$(cat canonical_data.json)
-SLUG=$(echo "$canonical_json" | jq '.exercise')
-# shellcheck disable=SC2001
+
+slug=$(echo "$canonical_json" | jq '.exercise')
 # Remove double quotes
-SLUG=$(echo "$SLUG" | sed 's/"//g')
-EXERCISE_DIR="exercises/practice/$SLUG"
-TEST_FILE="$EXERCISE_DIR/tests/$SLUG.rs"
+slug=$(echo "$slug" | sed 's/"//g')
+exercise_dir="exercises/practice/$slug"
+test_file="$exercise_dir/tests/$slug.rs"
 
-cat <<EOT >"$TEST_FILE"
-use $(dash_to_underscore "$SLUG")::*;
-// Add tests here
+cat <<EOT >"$test_file"
+use $(dash_to_underscore "$slug")::*;
 
 EOT
 
 # Flattens canonical json, extracts only the objects with a uuid
 cases=$(echo "$canonical_json" | jq '[ .. | objects | with_entries(select(.key | IN("uuid", "description", "input", "expected", "property"))) | select(. != {}) | select(has("uuid")) ]')
 
+
+# Shellcheck doesn't recognize that `case` is not unused
+
 # shellcheck disable=SC2034
 jq -c '.[]' <<<"$cases" | while read -r case; do
 
   # Evaluate the bash parts and replace them with their return values
   eval_template="$(digest_template | sed -e "s/\$(\(.*\))/\$\(\1\)/g")"
   eval_template="$(eval "echo \"$eval_template\"")"
 
-  # Turn function name unto snake_case
+
+  # Turn function name into snake_case
   formatted_template=$(echo "$eval_template" | sed -e ':loop' -e 's/\(fn[^(]*\)[ -]/\1_/g' -e 't loop' | sed 's/fn_/fn /')
-  # Push to file
 
-  echo "$formatted_template" >>"$TEST_FILE"
-  printf "\\n" >>"$TEST_FILE"
+  # Push to test file
+  echo "$formatted_template" >>"$test_file"
+  printf "\\n" >>"$test_file"
 
 done
 
-rustfmt "$TEST_FILE"
+rustfmt "$test_file"
+
+message "success" "Generated tests successfully! Check out ${test_file}"
 
-message "success" "Generated tests successfully! Check out ${TEST_FILE}"

bin/generate_tests

@@ -1,38 +1,13 @@
 #!/usr/bin/env bash
 
-# shellcheck disable=SC2034
-# Reset
-RESET=$(echo -e '\033[0m')
+reset_color=$(echo -e '\033[0m')
 
-# Regular Colors
-BLACK=$(echo -e '\033[0;30m')
-RED=$(echo -e '\033[0;31m')
-GREEN=$(echo -e '\033[0;32m')
-YELLOW=$(echo -e '\033[0;33m')
-BLUE=$(echo -e '\033[0;34m')
-PURPLE=$(echo -e '\033[0;35m')
-CYAN=$(echo -e '\033[0;36m')
-WHITE=$(echo -e '\033[0;37m')
+red=$(echo -e '\033[0;31m')
+green=$(echo -e '\033[0;32m')
+yellow=$(echo -e '\033[0;33m')
+blue=$(echo -e '\033[0;34m')
+cyan=$(echo -e '\033[0;36m')
 
-# Bold
-BOLD_BLACK=$(echo -e '\033[1;30m')
-BOLD_RED=$(echo -e '\033[1;31m')
-BOLD_GREEN=$(echo -e '\033[1;32m')
-BOLD_YELLOW=$(echo -e '\033[1;33m')
-BOLD_BLUE=$(echo -e '\033[1;34m')
-BOLD_PURPLE=$(echo -e '\033[1;35m')
-BOLD_CYAN=$(echo -e '\033[1;36m')
-BOLD_WHITE=$(echo -e '\033[1;37m')
+bold_green=$(echo -e '\033[1;32m')
 
-# Underline
-UNDERLINE=$(echo -e ='\033[4m')
-
-# Background
-BG_BLACK=$(echo -e ='\033[40m')
-BG_RED=$(echo -e ='\033[41m')
-BG_GREEN=$(echo -e ='\033[42m')
-BG_YELLOW=$(echo -e ='\033[43m')
-BG_BLUE=$(echo -e ='\033[44m')
-BG_PURPLE=$(echo -e ='\033[45m')
-BG_CYAN=$(echo -e ='\033[46m')
-BG_WHITE=$(echo -e ='\033[47m')
+export red green blue yellow bold_green reset_color cyan

bin/generator-utils/colors.sh

@@ -1,38 +1,40 @@
 #!/usr/bin/env bash
 
-# shellcheck source=/dev/null
+# see comment in utils.sh
+# shellcheck source=bin/generator-utils/colors.sh
+# shellcheck source=./colors.sh
 source ./bin/generator-utils/colors.sh
 
-function get_exercise_difficulty() {
+get_exercise_difficulty() {
     read -rp "Difficulty of exercise (1-10): " exercise_difficulty
     echo "$exercise_difficulty"
 }
 
-function validate_difficulty_input() {
-
-    valid_input=false
+validate_difficulty_input() {
+    local valid_input=false
     while ! $valid_input; do
         if [[ "$1" =~ ^[1-9]$|^10$ ]]; then
-            exercise_difficulty=$1
-            valid_input=true
+            local exercise_difficulty=$1
+            local valid_input=true
         else
-            read -rp "${RED}Invalid input. ${RESET}Please enter an integer between 1 and 10. " exercise_difficulty
+            read -rp "${red}Invalid input. ${reset_color}Please enter an integer between 1 and 10. " exercise_difficulty
+
             [[ "$exercise_difficulty" =~ ^[1-9]$|^10$ ]] && valid_input=true
 
         fi
     done
     echo "$exercise_difficulty"
 }
 
-function get_author_handle {
-    DEFAULT_AUTHOR_HANDLE="$(git config user.name)"
+get_author_handle() {
+    local default_author_handle
+    default_author_handle="$(git config user.name)"
 
-    if [ -z "$DEFAULT_AUTHOR_HANDLE" ]; then
-        read -rp "Hey! Couldn't find your Github handle. Add it now or skip with enter and add it later in the .meta.config.json file: " AUTHOR_HANDLE
+    if [ -z "$default_author_handle" ]; then
+        read -rp "Hey! Couldn't find your Github handle. Add it now or skip with enter and add it later in the .meta.config.json file: " author_handle
     else
-        AUTHOR_HANDLE="$DEFAULT_AUTHOR_HANDLE"
+        local author_handle="$default_author_handle"
 
     fi
-    echo "$AUTHOR_HANDLE"
-
+    echo "$author_handle"
 }