Move append-summary feature to ai-code--insert-prompt

Kang Tu · Kang Tu · commit aee07a48b6b7 · 2026-04-29T18:41:23.000-07:00
diff --git a/ai-code-change.el b/ai-code-change.el
@@ -284,6 +284,8 @@ Otherwise implement comments for the entire current file.
 Argument ARG is the prefix argument.
 Optional DEFAULT-ACTION skips the action prompt when non-nil."
   ;; DONE: I want to implement the idea inside https://github.com/tninja/ai-code-interface.el/issues/316, it could to either code change or ask question, given user's input with completing-read selection. The difference of this org-mode section TODO, with the existing comment todo is, it won't replace the TODO section with implementation. It just use the section headline and content inside this section as part of prompt, and send to AI.
+  ;; DONE: for this command triggered from org-mode file buffer. We want to let user choose if they want to add the condense result summary as a section (org headline), at the end of current section under cursor. If user choose yes. The prompt should let AI know this and where to add (maybe let it know current file, headline / cursor position maybe), so that it can add result summary.
+  ;; DONE: This result summary looks good. Is it possible to move this feature to the function just before sending prompt to AI, so that it can be applied to other code change or question asking command as well? The key point is to let user choose if they want to have this summary added to the file, and where to add, so that the prompt can include this requirement and context.
   (interactive "P")
   (if (not buffer-file-name)
       (user-error "Error: buffer-file-name must be available")
diff --git a/ai-code-prompt-mode.el b/ai-code-prompt-mode.el
@@ -415,13 +415,21 @@ that root, otherwise return the absolute path."
 (defun ai-code--insert-prompt (prompt-text)
   "Preprocess and insert PROMPT-TEXT into the AI prompt file.
 If PROMPT-TEXT is a command (starts with /), execute it directly instead."
-  (let ((processed-prompt (if ai-code-prompt-preprocess-filepaths
-                              (ai-code--preprocess-prompt-text prompt-text)
-                            prompt-text)))
-    (if (and (string-prefix-p "/" processed-prompt)
-             (not (string-match-p " " processed-prompt)))
-        (ai-code--execute-command processed-prompt)
-      (ai-code--write-prompt-to-file-and-send processed-prompt))))
+  (let* ((processed-prompt (if ai-code-prompt-preprocess-filepaths
+                               (ai-code--preprocess-prompt-text prompt-text)
+                             prompt-text))
+         (append-summary-p (and (derived-mode-p 'org-mode)
+                                (org-at-heading-p)
+                                (y-or-n-p "Append result summary to current section? ")))
+         (final-prompt (if append-summary-p
+                           (concat processed-prompt
+                                   (format "\n\nAfter completing, append a concise result summary as a sub-heading at the end of the current section in file %s near line %d."
+                                           buffer-file-name (line-number-at-pos)))
+                         processed-prompt)))
+    (if (and (string-prefix-p "/" final-prompt)
+             (not (string-match-p " " final-prompt)))
+        (ai-code--execute-command final-prompt)
+      (ai-code--write-prompt-to-file-and-send final-prompt))))
 
 ;; Define the AI Prompt Mode (derived from org-mode)
 ;;;###autoload
diff --git a/test/test_ai-code-change.el b/test/test_ai-code-change.el
@@ -506,7 +506,7 @@ is between the function definition and its body."
         (should (string-match-p "[Qq]uestion" captured-label))
         (should-not (string-match-p "implementation" captured-label))))))
 
-(ert-deftest ai-code-test-ai-code-implement-todo-org-section-includes-heading-and-content ()
+(ert-deftest ai-code-test-implement-todo-org-section-includes-heading-and-content ()
   "Test Org TODO section is used as prompt context without requiring comment syntax."
   (with-temp-buffer
     (require 'org)
@@ -792,6 +792,190 @@ is between the function definition and its body."
 
         (should (equal captured-default-action "Code change"))))))
 
+(ert-deftest ai-code-test-implement-todo-org-no-append-summary-in-build ()
+  "Test that `build-and-send-prompt' no longer asks about appending summary (moved to insert-prompt)."
+  (with-temp-buffer
+    (require 'org)
+    (setq buffer-file-name "todo.org")
+    (insert "* TODO Build feature\n")
+    (insert "Details here.\n")
+    (org-mode)
+    (goto-char (point-min))
+
+    (let (y-or-n-called)
+      (cl-letf (((symbol-function 'completing-read)
+                 (lambda (&rest _) "Code change"))
+                ((symbol-function 'y-or-n-p)
+                 (lambda (_prompt)
+                   (setq y-or-n-called t)
+                   nil))
+                ((symbol-function 'ai-code-read-string)
+                 (lambda (_label input) input))
+                ((symbol-function 'ai-code--get-clipboard-text) (lambda () nil))
+                ((symbol-function 'ai-code--get-context-files-string) (lambda () ""))
+                ((symbol-function 'ai-code--format-repo-context-info) (lambda () ""))
+                ((symbol-function 'which-function) (lambda () nil))
+                ((symbol-function 'region-active-p) (lambda () nil))
+                ((symbol-function 'ai-code--insert-prompt) (lambda (_p) nil)))
+
+        (ai-code--implement-todo--build-and-send-prompt nil)
+
+        (should-not y-or-n-called)))))
+
+(ert-deftest ai-code-test-implement-todo-comment-no-append-summary-asked ()
+  "Test that `y-or-n-p' is NOT asked on regular TODO comment path."
+  (with-temp-buffer
+    (setq buffer-file-name "test.el")
+    (setq-local comment-start ";")
+    (setq-local comment-end "")
+    (insert ";; TODO: implement feature\n")
+    (goto-char (point-min))
+
+    (let (y-or-n-called)
+      (cl-letf (((symbol-function 'completing-read)
+                 (lambda (&rest _) "Code change"))
+                ((symbol-function 'y-or-n-p)
+                 (lambda (_prompt)
+                   (setq y-or-n-called t)
+                   nil))
+                ((symbol-function 'ai-code-read-string)
+                 (lambda (_label input) input))
+                ((symbol-function 'ai-code--get-clipboard-text) (lambda () nil))
+                ((symbol-function 'ai-code--get-context-files-string) (lambda () ""))
+                ((symbol-function 'ai-code--format-repo-context-info) (lambda () ""))
+                ((symbol-function 'ai-code--get-function-name-for-comment) (lambda () nil))
+                ((symbol-function 'which-function) (lambda () nil))
+                ((symbol-function 'region-active-p) (lambda () nil))
+                ((symbol-function 'ai-code--insert-prompt) (lambda (_p) nil)))
+
+        (ai-code--implement-todo--build-and-send-prompt nil)
+
+        (should-not y-or-n-called)))))
+
+(ert-deftest ai-code-test-implement-todo-org-build-prompt-no-summary-text ()
+  "Test that `build-and-send-prompt' prompt does NOT contain summary (moved to insert-prompt)."
+  (with-temp-buffer
+    (require 'org)
+    (setq buffer-file-name "/tmp/project/todo.org")
+    (insert "* TODO Build feature\n")
+    (insert "Details here.\n")
+    (org-mode)
+    (goto-char (point-min))
+
+    (let (captured-prompt)
+      (cl-letf (((symbol-function 'completing-read)
+                 (lambda (&rest _) "Code change"))
+                ((symbol-function 'ai-code-read-string)
+                 (lambda (_label input) input))
+                ((symbol-function 'ai-code--get-clipboard-text) (lambda () nil))
+                ((symbol-function 'ai-code--get-context-files-string) (lambda () ""))
+                ((symbol-function 'ai-code--format-repo-context-info) (lambda () ""))
+                ((symbol-function 'which-function) (lambda () nil))
+                ((symbol-function 'region-active-p) (lambda () nil))
+                ((symbol-function 'ai-code--insert-prompt)
+                 (lambda (p) (setq captured-prompt p))))
+
+        (ai-code--implement-todo--build-and-send-prompt nil)
+
+        (should (stringp captured-prompt))
+        (should-not (string-match-p "summary" captured-prompt))))))
+
+(ert-deftest ai-code-test-implement-todo-org-append-summary-no ()
+  "Test that choosing no does NOT add summary instruction to prompt."
+  (with-temp-buffer
+    (require 'org)
+    (setq buffer-file-name "/tmp/project/todo.org")
+    (insert "* TODO Build feature\n")
+    (insert "Details here.\n")
+    (org-mode)
+    (goto-char (point-min))
+
+    (let (captured-prompt)
+      (cl-letf (((symbol-function 'completing-read)
+                 (lambda (&rest _) "Code change"))
+                ((symbol-function 'ai-code-read-string)
+                 (lambda (_label input) input))
+                ((symbol-function 'ai-code--get-clipboard-text) (lambda () nil))
+                ((symbol-function 'ai-code--get-context-files-string) (lambda () ""))
+                ((symbol-function 'ai-code--format-repo-context-info) (lambda () ""))
+                ((symbol-function 'which-function) (lambda () nil))
+                ((symbol-function 'region-active-p) (lambda () nil))
+                ((symbol-function 'ai-code--insert-prompt)
+                 (lambda (p) (setq captured-prompt p))))
+
+        (ai-code--implement-todo--build-and-send-prompt nil)
+
+        (should (stringp captured-prompt))
+        (should-not (string-match-p "summary" captured-prompt))))))
+
+(ert-deftest ai-code-test-insert-prompt-org-heading-append-summary-yes ()
+  "Test that `ai-code--insert-prompt' appends summary instruction on org heading when user confirms."
+  (with-temp-buffer
+    (require 'org)
+    (setq buffer-file-name "/tmp/project/plan.org")
+    (insert "* TODO Build search feature\n")
+    (insert "Design the API first.\n")
+    (org-mode)
+    (goto-char (point-min))
+
+    (let (captured-prompt
+          (ai-code-prompt-preprocess-filepaths nil))
+      (cl-letf (((symbol-function 'y-or-n-p) (lambda (_) t))
+                ((symbol-function 'ai-code--write-prompt-to-file-and-send)
+                 (lambda (prompt) (setq captured-prompt prompt))))
+
+        (ai-code--insert-prompt "Test prompt text")
+
+        (should (stringp captured-prompt))
+        (should (string-match-p "Test prompt text" captured-prompt))
+        (should (string-match-p "summary" captured-prompt))
+        (should (string-match-p "plan\\.org" captured-prompt))))))
+
+(ert-deftest ai-code-test-insert-prompt-org-heading-append-summary-no ()
+  "Test that `ai-code--insert-prompt' does NOT append summary when user declines."
+  (with-temp-buffer
+    (require 'org)
+    (setq buffer-file-name "/tmp/project/plan.org")
+    (insert "* TODO Build search feature\n")
+    (insert "Design the API first.\n")
+    (org-mode)
+    (goto-char (point-min))
+
+    (let (captured-prompt
+          (ai-code-prompt-preprocess-filepaths nil))
+      (cl-letf (((symbol-function 'y-or-n-p) (lambda (_) nil))
+                ((symbol-function 'ai-code--write-prompt-to-file-and-send)
+                 (lambda (prompt) (setq captured-prompt prompt))))
+
+        (ai-code--insert-prompt "Test prompt text")
+
+        (should (stringp captured-prompt))
+        (should (string-match-p "Test prompt text" captured-prompt))
+        (should-not (string-match-p "summary" captured-prompt))))))
+
+(ert-deftest ai-code-test-insert-prompt-non-org-no-summary-asked ()
+  "Test that `ai-code--insert-prompt' does NOT ask about summary in non-org buffer."
+  (with-temp-buffer
+    (setq buffer-file-name "/tmp/project/test.el")
+    (setq-local comment-start ";")
+    (insert ";; some code\n")
+    (goto-char (point-min))
+
+    (let (y-or-n-called captured-prompt
+          (ai-code-prompt-preprocess-filepaths nil))
+      (cl-letf (((symbol-function 'y-or-n-p)
+                 (lambda (_)
+                   (setq y-or-n-called t)
+                   nil))
+                ((symbol-function 'ai-code--write-prompt-to-file-and-send)
+                 (lambda (prompt) (setq captured-prompt prompt))))
+
+        (ai-code--insert-prompt "Test prompt text")
+
+        (should-not y-or-n-called)
+        (should (string-match-p "Test prompt text" captured-prompt))
+        (should-not (string-match-p "summary" captured-prompt))))))
+
 (provide 'test_ai-code-change)
 
 ;;; test_ai-code-change.el ends here
