Update CLI and add tests for warning-only rules

Co-authored-by: jackfirth <[email protected]>

Author: Copilot

cli.rkt

@@ -300,18 +300,20 @@ For help on these, use 'analyze --help' or 'fix --help'."
     (match (resyntax-analyze-options-output-format options)
       [(== plain-text)
        (for ([result (in-list results)])
-         (define path
-           (file-source-path
-            (syntax-replacement-source (refactoring-result-syntax-replacement result))))
+         (define source (refactoring-result-source result))
+         (define path (file-source-path source))
          (define line (refactoring-result-original-line result))
          (define column (refactoring-result-original-column result))
          (printf "resyntax: ~a:~a:~a [~a]\n" path line column (refactoring-result-rule-name result))
          (printf "\n\n~a\n" (string-indent (refactoring-result-message result) #:amount 2))
          (define old-code (refactoring-result-original-code result))
          (define new-code (refactoring-result-new-code result))
-         (printf "\n\n~a\n\n\n~a\n\n\n"
-                 (string-indent (~a old-code) #:amount 2)
-                 (string-indent (~a new-code) #:amount 2)))]
+         (if new-code
+             (printf "\n\n~a\n\n\n~a\n\n\n"
+                     (string-indent (~a old-code) #:amount 2)
+                     (string-indent (~a new-code) #:amount 2))
+             (printf "\n\n~a\n\n\n"
+                     (string-indent (~a old-code) #:amount 2))))]
       [(== github-pull-request-review)
        (define req (refactoring-results->github-review results #:file-count (hash-count sources)))
        (write-json (github-review-request-jsexpr req))]))

private/github.rkt

@@ -93,11 +93,14 @@
 
 
 (define (refactoring-result->github-review-comment result)
-  (define path
-    (file-source-path (syntax-replacement-source (refactoring-result-syntax-replacement result))))
-  (define replacement (refactoring-result-line-replacement result))
-  (define body
-    (format #<<EOS
+  (cond
+    [(refactoring-result-has-fix? result)
+     ;; For results with fixes, generate a suggestion comment
+     (define path
+       (file-source-path (syntax-replacement-source (refactoring-result-syntax-replacement result))))
+     (define replacement (refactoring-result-line-replacement result))
+     (define body
+       (format #<<EOS
 **`~a`:** ~a
 
 ```suggestion
@@ -124,19 +127,35 @@
 </details>
 </details>
 EOS
-            (refactoring-result-rule-name result)
-            (refactoring-result-message result)
-            (line-replacement-new-text replacement)
-            (string-indent (pretty-format replacement) #:amount 2)
-            (string-indent (pretty-format (refactoring-result-syntax-replacement result))
-                           #:amount 2)))
-  (github-review-comment
-   #:path (first (git-path path))
-   #:body body
-   #:start-line (line-replacement-start-line replacement)
-   #:end-line (line-replacement-original-end-line replacement)
-   #:start-side "RIGHT"
-   #:end-side "RIGHT"))
+               (refactoring-result-rule-name result)
+               (refactoring-result-message result)
+               (line-replacement-new-text replacement)
+               (string-indent (pretty-format replacement) #:amount 2)
+               (string-indent (pretty-format (refactoring-result-syntax-replacement result))
+                              #:amount 2)))
+     (github-review-comment
+      #:path (first (git-path path))
+      #:body body
+      #:start-line (line-replacement-start-line replacement)
+      #:end-line (line-replacement-original-end-line replacement)
+      #:start-side "RIGHT"
+      #:end-side "RIGHT")]
+    [else
+     ;; For warning-only results, generate a comment without a suggestion
+     (define source (refactoring-result-source result))
+     (define path (file-source-path source))
+     (define line (refactoring-result-original-line result))
+     (define body
+       (format "**`~a`:** ~a"
+               (refactoring-result-rule-name result)
+               (refactoring-result-message result)))
+     (github-review-comment
+      #:path (first (git-path path))
+      #:body body
+      #:start-line line
+      #:end-line line
+      #:start-side "RIGHT"
+      #:end-side "RIGHT")]))
 
 
 (define branch-ref (getenv "GITHUB_REF"))

private/warning-rule-test.rkt

@@ -0,0 +1,46 @@
+#lang racket/base
+
+(require racket/list
+         resyntax/base
+         resyntax
+         resyntax/private/refactoring-result
+         resyntax/private/source
+         rackunit)
+
+;; Define a warning-only rule that matches any (equal? x y)
+(define-refactoring-rule test-warning-rule
+  #:description "This is a test warning rule for equal?"
+  #:suggested-fixes 'none
+  #:literals (equal?)
+  (equal? x y)
+  (void))
+
+;; Test that the rule works
+(define test-suite (refactoring-suite #:rules (list test-warning-rule)))
+
+(define test-source (string-source "#lang racket/base\n(define a 5)\n(equal? a a)\n"))
+
+(define result-set (resyntax-analyze test-source #:suite test-suite))
+
+(define results (refactoring-result-set-results result-set))
+
+(test-case "warning-only rule produces a result"
+  (check-equal? (length results) 1 "Should have one result"))
+
+(test-case "warning-only result has no fix"
+  (define result (first results))
+  (check-false (refactoring-result-has-fix? result) "Should not have a fix")
+  (check-false (refactoring-result-syntax-replacement result) "Should have no syntax replacement")
+  (check-false (refactoring-result-new-code result) "Should have no new code"))
+
+( test-case "warning-only result has message and location"
+  (define result (first results))
+  (check-equal? (refactoring-result-message result) "This is a test warning rule for equal?")
+  (check-equal? (refactoring-result-rule-name result) 'test-warning-rule)
+  (check-true (positive? (refactoring-result-original-line result))))
+
+(test-case "warning-only result doesn't modify source"
+  (define updated (refactoring-result-set-updated-source result-set))
+  (define updated-contents (modified-source-contents updated))
+  (check-equal? updated-contents (source->string test-source)
+               "Source should not be modified"))