Improved template handling for document commands

Generalized cmd_document to support custom templates
[feat] Made cmd_document use full path to prompt templates
[refactor] Removed hardcoded document types from cmd_document function signature
[fix] Added validation check for template file existence
[docs] Updated test_commands.bats to use TEMPLATES_DIR for template paths

Author: itlackey

src/giv.sh

@@ -711,20 +711,20 @@ if [ "${_is_sourced}" -eq 0 ]; then
     case "${subcmd}" in
     message) cmd_message "${REVISION}" ;;
     summary) cmd_document \
-      summary \
+      "${TEMPLATE_DIR}/final_summary_prompt.md" \
       "${REVISION}" \
       "${output_file:-}" \
       "${model_mode}" \
       "0.7" "" ;;
     release-notes) cmd_document \
-      release_notes \
+      "${TEMPLATE_DIR}/release_notes_prompt.md" \
       "${REVISION}" \
       "${output_file:-$release_notes_file}" \
       "${model_mode}" \
       "0.6" \
       "65536" ;;
     announcement)  cmd_document \
-      announcement \
+      "${TEMPLATE_DIR}/announcement_prompt.md" \
       "${REVISION}" \
       "${output_file:-$announce_file}" \
       "${model_mode}" \

src/helpers.sh

@@ -855,54 +855,64 @@ summarize_commit() {
 
     printf '%s\n' "${res}"
 }
-
 # -------------------------------------------------------------------
-# cmd_document: generic driver for summary/release_notes/announcement
+# cmd_document: generic driver for any prompt template
 #
 # Arguments:
-#   $1 = document type (e.g. "summary", "release_notes", "announcement")
-#   $2 = revision specifier  (e.g. "--current" or "$REVISION")
+#   $1 = full path to prompt template file
+#   $2 = revision specifier     (e.g. "--current" or "$REVISION")
 #   $3 = output file path
-#   $4 = model mode (e.g. "auto", "your-model")
-#   $5 = temperature   (e.g. "0.7", "0.6")
-#   $6 = context window size (optional; e.g. "65536" or "")
-#   $7 = any extra flags to pass to build_prompt
+#   $4 = model mode             (e.g. "auto", "your-model")
+#   $5 = temperature            (e.g. "0.7", "0.6")
+#   $6 = context window size    (optional; e.g. "65536")
+#   $7… = extra flags for build_prompt (e.g. --example, --rules)
 #
 # Side-effects:
 #   - Summaries are written to a temp file
 #   - A prompt is built and written to another temp file
 #   - generate_from_prompt is invoked to create the final output
 #
 cmd_document() {
-    doc_type="$1"
+    prompt_tpl="$1"
     revision="${2:---current}"
     out="${3:-}"
     mode="${4:-auto}"
     temp="${5:-0.9}"
     ctx="${6:-32768}"
     shift 6
 
+    # validate template exists
+    if [ ! -f "${prompt_tpl}" ]; then
+        printf 'template file not found: %s\n' "${prompt_tpl}" >&2
+        exit 1
+    fi
+
+    # derive base name for temp file prefixes
+    doc_base=$(basename "${prompt_tpl%.*}")
+
     # 1) Summarize
-    summaries=$(portable_mktemp "${doc_type}_summaries_XXXXXX.md")
-    print_debug "Generating ${doc_type} summaries to: ${summaries}"
+    summaries=$(portable_mktemp "${doc_base}_summaries_XXXXXX.md")
+    print_debug "Generating summaries to: ${summaries}"
     summarize_target "${revision}" "${summaries}" "${mode}"
 
-    # Bail if nothing came back
+    # bail if no summaries
     if [ ! -f "${summaries}" ]; then
-        printf 'Error: No summaries generated for %s.\n' "${doc_type}" >&2
+        printf 'Error: No summaries generated for %s.\n' "${revision}" >&2
         exit 1
     fi
 
     # 2) Build prompt
-    prompt_tpl="${TEMPLATE_DIR}/${doc_type}_prompt.md"
-    prompt_tmp=$(portable_mktemp "${doc_type}_prompt_XXXXXX.md")
-
+    prompt_tmp=$(portable_mktemp "${doc_base}_prompt_XXXXXX.md")
     title=$(parse_project_title "${summaries}")
-    current_version=$(get_version_info "${revision}" "$(find_version_file)")
+    current_version="$(get_version_info --current "$(find_version_file)" )"
 
-    print_debug "Project title: ${title}"
-    build_prompt --project-title "${title}" --version "${current_version}" \
-       --template "${prompt_tpl}" --summary "${summaries}" >"${prompt_tmp}"
+    print_debug "Building prompt from ${prompt_tpl} using ${summaries}"
+    build_prompt \
+      --project-title "${title}" \
+      --version "${current_version}" \
+      --template "${prompt_tpl}" \
+      --summary "${summaries}" \
+      "$@" >"${prompt_tmp}"
 
     print_debug "Built prompt file: ${prompt_tmp}"
 
@@ -913,3 +923,4 @@ cmd_document() {
         generate_from_prompt "${prompt_tmp}" "${out}" "${mode}" "${temp}"
     fi
 }
+

tests/test_commands.bats

@@ -11,6 +11,8 @@ BATS_TEST_START_TIME="$(date +%s)"
 SCRIPT="$BATS_TEST_DIRNAME/../src/giv.sh"
 # shellcheck source=../src/giv.sh
 HELPERS="$BATS_TEST_DIRNAME/../src/helpers.sh"
+# shellcheck source=../src/giv.sh
+TEMPLATES_DIR="$BATS_TEST_DIRNAME/../templates"
 
 setup() {
   # create a temp git repo
@@ -185,7 +187,7 @@ EOF
   summarize_target() { echo "SUM"; }
 
 
-  run cmd_document "summary" "--current" "" "auto" "0.7" ""
+  run cmd_document "$TEMPLATES_DIR/final_summary_prompt.md" "--current" "" "auto" "0.7" ""
   printf "Output: %s\n" "$output"
   ollama() {
     # shellcheck disable=SC2317
@@ -199,15 +201,15 @@ EOF
   ollama() {
     echo "SUM"
   }
-  run cmd_document "summary" HEAD~1 "" "auto" "0.7"
+  run cmd_document "$TEMPLATES_DIR/final_summary_prompt.md" HEAD~1 "" "auto" "0.7"
   assert_success
   assert_output --partial "SUM"
 }
 
 @test "cmd_summary writes to file when output_file set" {
   output_file="out.sum"
   summarize_target() { echo "SUM"; }
-  run cmd_document "summary" "--current" "${output_file}" "auto"
+  run cmd_document "$TEMPLATES_DIR/final_summary_prompt.md" "--current" "${output_file}" "auto"
   assert_success
   [ -f out.sum ]
   assert_output --partial "Response written to out.sum"
@@ -219,13 +221,13 @@ EOF
 #----------------------------------------
 
 @test "cmd_release_notes writes to its default file" {
-  run cmd_document "release_notes" "" "RELEASE_NOTES.md"
+  run cmd_document "$TEMPLATES_DIR/release_notes_prompt.md" "" "RELEASE_NOTES.md"
   assert_success
   assert_output --partial "Response written to RELEASE_NOTES.md"
 }
 
 @test "cmd_announcement writes to its default file" {
-  run cmd_document "announcement" "" "ANNOUNCEMENT.md"
+  run cmd_document "$TEMPLATES_DIR/announcement_prompt.md" "" "ANNOUNCEMENT.md"
   assert_success
   assert_output --partial "Response written to ANNOUNCEMENT.md"
 }