refactor: rename RESPONSE_REQUIREMENTS string to RESPONSE_FORMAT_REQUIREMENTS

Author: codevogel

defaults/prompts/conventional-commits/default.md

@@ -2,7 +2,10 @@ You are an expert at creating git commit messages according to the Conventional
 
 ---
 
-<__RESPONSE_REQUIREMENTS__>
+<__RESPONSE_FORMAT_REQUIREMENTS__>
+
+**Content Requirements:**
+
 - ONLY and EXCLUSIVELY use the commit types listed in the following YAML file:
 
   ```yaml

spec/render_prompt_spec.sh

@@ -19,7 +19,7 @@ Describe 'render_prompt'
     It 'renders the prompt correctly with all variables replaced'
         local prompt_template="$(cat spec/samples/sample-prompt-complete.md)"
         declare -A vars_map
-        vars_map["<__RESPONSE_REQUIREMENTS__>"]="$(cat spec/samples/sample-response-requirements.md)"
+        vars_map["<__RESPONSE_FORMAT_REQUIREMENTS__>"]="$(cat spec/samples/sample-response-requirements.md)"
         vars_map["<__GIT_DIFF__>"]="SAMPLE_DIFF"
         vars_map["<__VAR1__>"]="VAL1"
         vars_map["<__VAR2__>"]="VAL2"
@@ -32,7 +32,7 @@ Describe 'render_prompt'
     It 'renders the prompt correctly with empty instructions'
         local prompt_template="$(cat spec/samples/sample-prompt-complete.md)"
         declare -A vars_map
-        vars_map["<__RESPONSE_REQUIREMENTS__>"]="$(cat spec/samples/sample-response-requirements.md)"
+        vars_map["<__RESPONSE_FORMAT_REQUIREMENTS__>"]="$(cat spec/samples/sample-response-requirements.md)"
         vars_map["<__GIT_DIFF__>"]="SAMPLE_DIFF"
         vars_map["<__VAR1__>"]="VAL1"
         vars_map["<__VAR2__>"]="VAL2"

spec/samples/sample-prompt-complete.md

@@ -1,9 +1,9 @@
-<__RESPONSE_REQUIREMENTS__>
-<__GIT_DIFF__>
+<**RESPONSE_FORMAT_REQUIREMENTS**>
+<**GIT_DIFF**>
 LINE_1
-<__VAR1__>
+<**VAR1**>
 LINE2
-<__VAR2__>
+<**VAR2**>
 LINE3
-<__VAR3__>
-<__INSTRUCTIONS__>
+<**VAR3**>
+<**INSTRUCTIONS**>

spec/samples/sample-prompt-missing-1.md

@@ -1,4 +1,4 @@
-<__RESPONSE_REQUIREMENTS__>
+<__RESPONSE_FORMAT_REQUIREMENTS__>
 <__GIT_DIFF__>
 LINE_1
 LINE2

spec/samples/sample-prompt-missing-diff.md

@@ -1,4 +1,4 @@
-<__RESPONSE_REQUIREMENTS__>
+<__RESPONSE_FORMAT_REQUIREMENTS__>
 LINE_1
 <__VAR1__>
 LINE2

spec/validate_vars_map_spec.sh

@@ -17,7 +17,7 @@ Describe 'validate_vars_map'
 
     It 'validates variables successfully when everything matches'
         local -A map
-        map["<__RESPONSE_REQUIREMENTS__>"]="SAMPLE_REQUIREMENTS"
+        map["<__RESPONSE_FORMAT_REQUIREMENTS__>"]="SAMPLE_FORMAT_REQUIREMENTS"
         map["<__GIT_DIFF__>"]="SAMPLE_DIFF"
         map["<__VAR1__>"]="VAL1"
         map["<__VAR2__>"]="VAL2"
@@ -31,7 +31,7 @@ Describe 'validate_vars_map'
 
     It 'fails when a prompt is missing a custom variable present in the map'
         local -A map
-        map["<__RESPONSE_REQUIREMENTS__>"]="SAMPLE_REQUIREMENTS"
+        map["<__RESPONSE_FORMAT_REQUIREMENTS__>"]="SAMPLE_FORMAT_REQUIREMENTS"
         map["<__GIT_DIFF__>"]="SAMPLE_DIFF"
         map["<__VAR1__>"]="VAL1"
         map["<__VAR2__>"]="VAL2"
@@ -44,9 +44,9 @@ Describe 'validate_vars_map'
         The status should be failure
     End
 
-    It 'fails when a prompt is missing mandatory template string RESPONSE_REQUIREMENTS in the prompt'
+    It 'fails when a prompt is missing mandatory template string RESPONSE_FORMAT_REQUIREMENTS in the prompt'
         local -A map
-        map["<__RESPONSE_REQUIREMENTS__>"]="SAMPLE_REQUIREMENTS"
+        map["<__RESPONSE_FORMAT_REQUIREMENTS__>"]="SAMPLE_FORMAT_REQUIREMENTS"
         map["<__GIT_DIFF__>"]="SAMPLE_DIFF"
         map["<__VAR1__>"]="VAL1"
         map["<__VAR2__>"]="VAL2"
@@ -55,13 +55,13 @@ Describe 'validate_vars_map'
         local variables_file_path="/path/to/variables.yaml"
         local prompt="$(cat spec/samples/sample-prompt-missing-requirements.md)"
         When call validate_vars_map map "$prompt"
-        The stderr should eq "Error: key '<__RESPONSE_REQUIREMENTS__>' is essential for cfme to function, but not present in the prompt."
+        The stderr should eq "Error: key '<__RESPONSE_FORMAT_REQUIREMENTS__>' is essential for cfme to function, but not present in the prompt."
         The status should be failure
     End
 
     It 'fails when a prompt is missing mandatory template string GIT_DIFF in the prompt'
         local -A map
-        map["<__RESPONSE_REQUIREMENTS__>"]="SAMPLE_REQUIREMENTS"
+        map["<__RESPONSE_FORMAT_REQUIREMENTS__>"]="SAMPLE_FORMAT_REQUIREMENTS"
         map["<__GIT_DIFF__>"]="SAMPLE_DIFF"
         map["<__VAR1__>"]="VAL1"
         map["<__VAR2__>"]="VAL2"
@@ -76,7 +76,7 @@ Describe 'validate_vars_map'
 
     It 'fails when a map is missing a variable present in the prompt'
         local -A map
-        map["<__RESPONSE_REQUIREMENTS__>"]="SAMPLE_REQUIREMENTS"
+        map["<__RESPONSE_FORMAT_REQUIREMENTS__>"]="SAMPLE_FORMAT_REQUIREMENTS"
         map["<__GIT_DIFF__>"]="SAMPLE_DIFF"
 
         map["<__VAR2__>"]="VAL2"

src/lib/load_vars_map.sh

@@ -36,9 +36,9 @@ load_vars_map() {
   # Add defaults to the map
   referenced_map["<__GIT_DIFF__>"]="$(git diff --cached)"
 
-  referenced_map["<__RESPONSE_REQUIREMENTS__>"]="$(
+  referenced_map["<__RESPONSE_FORMAT_REQUIREMENTS__>"]="$(
     cat <<'EOF'
-**Requirements:**
+**Response Format Requirements:**
 
 - Each commit message MUST include a 'header'.
 - Optionally include 'body' and 'footer', ONLY if a 'header'

src/lib/validate_vars_map.sh

@@ -17,7 +17,7 @@ function validate_vars_map() {
       continue
     fi
     if ! grep -q "$key" <<<"$prompt"; then
-      if [[ "$key" == "<__RESPONSE_REQUIREMENTS__>" || "$key" == "<__GIT_DIFF__>" ]]; then
+      if [[ "$key" == "<__RESPONSE_FORMAT_REQUIREMENTS__>" || "$key" == "<__GIT_DIFF__>" ]]; then
         # This key is mandatory
         echo "Error: key '$key' is essential for cfme to function, but not present in the prompt." >&2
         return 1