Add error-to-raise-arguments-error refactoring rule (#635)

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: jackfirth <[email protected]>
Co-authored-by: Jack Firth <[email protected]>

Author: Copilot

default-recommendations/exception-suggestions-test.rkt

@@ -87,3 +87,69 @@ no-change-test: "with-handlers with identifier handler not refactorable"
 (with-handlers ([exn:fail? handler])
   (void))
 --------------------
+
+
+test: "error with format string and arguments refactorable to raise-arguments-error"
+--------------------
+(define (foo low high)
+  (unless (<= low high)
+    (error 'foo "low should be less than high, ~a ~a" low high))
+  (void))
+====================
+(define (foo low high)
+  (unless (<= low high)
+    (raise-arguments-error 'foo "low should be less than high" "low" low "high" high))
+  (void))
+--------------------
+
+
+test: "error with single argument refactorable to raise-arguments-error"
+--------------------
+(define (bar x)
+  (when (negative? x)
+    (error 'bar "x must be non-negative: ~a" x))
+  (void))
+====================
+(define (bar x)
+  (when (negative? x)
+    (raise-arguments-error 'bar "x must be non-negative" "x" x))
+  (void))
+--------------------
+
+
+no-change-test: "error without format placeholders not refactorable"
+--------------------
+(define (baz)
+  (error 'baz "something went wrong"))
+--------------------
+
+
+no-change-test: "error with non-identifier arguments not refactorable"
+--------------------
+(define (qux x)
+  (error 'qux "value is: ~a" (+ x 1)))
+--------------------
+
+
+no-change-test: "error with mismatched placeholder count not refactorable"
+--------------------
+(define (mismatch x y)
+  (error 'mismatch "values: ~a ~a ~a" x y))
+--------------------
+
+
+no-change-test: "error with more arguments than placeholders not refactorable"
+--------------------
+(define (extra x y)
+  (error 'extra "value: ~a" x y))
+--------------------
+
+
+test: "error with ~a at end of string"
+--------------------
+(define (end-tilde x)
+  (error 'end-tilde "value is ~a" x))
+====================
+(define (end-tilde x)
+  (raise-arguments-error 'end-tilde "value is" "x" x))
+--------------------

default-recommendations/exception-suggestions.rkt

@@ -9,7 +9,8 @@
   [exception-suggestions refactoring-suite?]))
 
 
-(require resyntax/base
+(require racket/string
+         resyntax/base
          resyntax/default-recommendations/private/literal-constant
          syntax/parse)
 
@@ -33,5 +34,29 @@
     body ...))
 
 
+(define-refactoring-rule error-to-raise-arguments-error
+  #:description
+  "Use `raise-arguments-error` instead of `error` for better error messages that follow Racket \
+conventions."
+  #:literals (error)
+  
+  (error sym:expr message:str arg:id ...+)
+
+  #:do [(define message-str (syntax-e (attribute message)))
+        (define args-list (attribute arg))]
+  #:when (= (length (regexp-match* #rx"~a" message-str)) (length args-list))
+  #:do [(define cleaned-message (string-replace message-str "~a" ""))
+        ;; Clean up extra spaces and trailing punctuation from placeholder removal
+        (define cleaned-message-normalized
+          (regexp-replace* #rx"  +" cleaned-message " "))]
+  #:with new-message (regexp-replace #rx"[,;: ]+$" cleaned-message-normalized "")
+  #:with (arg-str ...)
+  (for/list ([arg-id (in-list args-list)])
+    (symbol->string (syntax-e arg-id)))
+  
+  (raise-arguments-error sym new-message (~@ arg-str arg) ...))
+
+
 (define-refactoring-suite exception-suggestions
-  #:rules (literal-exception-handler-to-lambda))
+  #:rules (literal-exception-handler-to-lambda
+           error-to-raise-arguments-error))