Chore: Improve code refactoring auto-suggestion (#271)

* Add default refactoring prompt and goal candidates

* Add refactoring presets and selection UI

* update HISTORY

Author: tninja

HISTORY.org

@@ -2,6 +2,8 @@
 * Release history
 
 ** Main branch change
+- Chore: Improve code refactoring auto-suggestion, user can select from several refactoring goal
+- Doc: Add Awesome Codex CLI badge to README
 - Feat: Add whisper speech-to-text input command with post-transcription actions for insert, editable send-to-session, and clipboard copy
 - Fix: Slowness of ai coding session given clickable session link feature
 

ai-code-agile.el

@@ -333,6 +333,33 @@
            :description "Introduce a new hierarchy to clarify different responsibilities and support future extension."))
   "Catalog of refactoring techniques curated from Martin Fowler's \"Refactoring\".")
 
+(defconst ai-code--refactoring-suggestion-default-instruction
+  "Analyze the code context below. Identify potential refactoring opportunities (e.g., complexity, duplication, clarity) and make the code easy to understand. Do not change code logic. Suggest the most impactful refactoring technique and explain why."
+  "Default instruction for refactoring suggestion prompts.")
+
+(defconst ai-code--refactoring-suggestion-default-label
+  "General refactoring analysis"
+  "Default short description for refactoring suggestion prompts.")
+
+(defconst ai-code--refactoring-suggestion-presets
+  `((,ai-code--refactoring-suggestion-default-label . ,ai-code--refactoring-suggestion-default-instruction)
+    ("Improve readability and testability" . "Analyze the code context below. Focus on making the code easier to understand, improving readability, and increasing testability. Do not change code logic. Suggest the most impactful refactoring technique and explain why.")
+    ("Reduce complexity" . "Analyze the code context below. Focus on reducing complexity and simplifying control flow. Do not change code logic. Suggest the most impactful refactoring technique and explain why.")
+    ("Remove duplication" . "Analyze the code context below. Focus on removing duplication and consolidating repeated logic. Do not change code logic. Suggest the most impactful refactoring technique and explain why.")
+    ("Clarify naming and responsibilities" . "Analyze the code context below. Focus on clarifying naming and separating responsibilities more cleanly. Do not change code logic. Suggest the most impactful refactoring technique and explain why."))
+  "Preset refactoring suggestion prompts keyed by short description.")
+
+(defun ai-code--read-refactoring-suggestion-instruction ()
+  "Read a refactoring suggestion instruction with editable completion."
+  (let* ((selected-description
+          (completing-read "Select refactoring goal: "
+                           (mapcar #'car ai-code--refactoring-suggestion-presets)
+                           nil t nil nil ai-code--refactoring-suggestion-default-label))
+         (default-instruction
+          (or (cdr (assoc selected-description ai-code--refactoring-suggestion-presets))
+              ai-code--refactoring-suggestion-default-instruction)))
+    (ai-code-read-string "Edit suggestion request: " default-instruction)))
+
 (defun ai-code--refactoring--ensure-string (value)
   "Return VALUE coerced to a string when appropriate."
   (cond
@@ -575,8 +602,7 @@ If TDD-MODE is non-nil, adds TDD constraints to the prompt."
                            (format "\n```\n%s\n```" region-text)
                          ""))
                 ;; Get the main instruction from the user
-                 (user-instruction (ai-code-read-string "Edit suggestion request: "
-                                                       "Analyze the code context below. Identify potential refactoring opportunities (e.g., complexity, duplication, clarity). Do not change code logic. Suggest the most impactful refactoring technique and explain why.")) ;; Improved initial-input
+                 (user-instruction (ai-code--read-refactoring-suggestion-instruction))
                  ;; Add TDD constraint if in TDD mode
                  (tdd-constraint (if tdd-mode " Ensure all tests still pass after refactoring." ""))
                  ;; Add file information to context

test/test_ai-code-agile.el

@@ -260,8 +260,11 @@
   "Verify Dired refactoring suggestions include selected files."
   (with-temp-buffer
     (let (captured-prompt)
-      (cl-letf (((symbol-function 'ai-code-read-string)
-                 (lambda (_prompt &optional initial _candidates) initial))
+      (cl-letf (((symbol-function 'completing-read)
+                 (lambda (&rest _) "Improve readability and testability"))
+                ((symbol-function 'ai-code-read-string)
+                 (lambda (_prompt &optional initial-input _candidates)
+                   initial-input))
                 ((symbol-function 'ai-code--git-root)
                  (lambda (&optional _dir) "/repo/"))
                 ((symbol-function 'ai-code--insert-prompt)
@@ -280,5 +283,62 @@
         (should (string-match-p "\nFiles:\n@src/foo\\.el\n@test/bar\\.el"
                                 (subst-char-in-string ?\\ ?/ captured-prompt)))))))
 
+(ert-deftest ai-code-test-handle-ask-llm-suggestion-offers-common-refactoring-goals ()
+  "Verify refactoring suggestion prompt selects a short description first."
+  (with-temp-buffer
+    (let (captured-short-descriptions captured-selected-description
+          captured-read-string-initial-input captured-prompt)
+      (cl-letf (((symbol-function 'ai-code-read-string)
+                 (lambda (_prompt &optional initial-input _candidates)
+                   (setq captured-read-string-initial-input initial-input)
+                   "Custom edited prompt"))
+                ((symbol-function 'completing-read)
+                 (lambda (_prompt collection &rest _)
+                   (setq captured-short-descriptions collection)
+                   (setq captured-selected-description "Reduce complexity")
+                   captured-selected-description))
+                ((symbol-function 'ai-code--insert-prompt)
+                 (lambda (text)
+                   (setq captured-prompt text)
+                   t)))
+        (ai-code--handle-ask-llm-suggestion
+         '(:region-active nil
+           :current-function "my-function"
+           :file-name "/repo/src/foo.el"
+           :dired-targets nil)
+         nil)
+        (should (equal captured-short-descriptions
+                       '("General refactoring analysis"
+                         "Improve readability and testability"
+                         "Reduce complexity"
+                         "Remove duplication"
+                         "Clarify naming and responsibilities")))
+        (should (equal captured-selected-description "Reduce complexity"))
+        (should (equal captured-read-string-initial-input
+                       "Analyze the code context below. Focus on reducing complexity and simplifying control flow. Do not change code logic. Suggest the most impactful refactoring technique and explain why."))
+        (should (string-match-p "Custom edited prompt Context: Function 'my-function'"
+                                captured-prompt))))))
+
+(ert-deftest ai-code-test-handle-ask-llm-suggestion-default-prompt-mentions-easy-to-understand ()
+  "Verify the default refactoring prompt mentions making code easy to understand."
+  (with-temp-buffer
+    (let (captured-read-string-initial-input)
+      (cl-letf (((symbol-function 'completing-read)
+                 (lambda (&rest _) ai-code--refactoring-suggestion-default-label))
+                ((symbol-function 'ai-code-read-string)
+                 (lambda (_prompt &optional initial-input _candidates)
+                   (setq captured-read-string-initial-input initial-input)
+                   initial-input))
+                ((symbol-function 'ai-code--insert-prompt)
+                 (lambda (_text) t)))
+        (ai-code--handle-ask-llm-suggestion
+         '(:region-active nil
+           :current-function "my-function"
+           :file-name "/repo/src/foo.el"
+           :dired-targets nil)
+         nil)
+        (should (string-match-p "easy to understand"
+                                captured-read-string-initial-input))))))
+
 (provide 'test_ai-code-agile)
 ;;; test_ai-code-agile.el ends here