[Fix #609] Fix alignment issue involving margin comments.

Alignment wasn't working properly when nested, multi-line sexps were followed by margin comments.

Author: samwagg

CHANGELOG.md

@@ -24,6 +24,7 @@
 
 * [#588](https://github.com/clojure-emacs/clojure-mode/pull/588): Fix font-lock for character literals.
 * Stop `clojure-sort-ns` from calling `redisplay`.
+* #608: Fix alignment issue involving margin comments at the end of nested forms.
 
 ### Changes
 

clojure-mode.el

@@ -1260,7 +1260,7 @@ BOUND is bounds the whitespace search."
   (unwind-protect
       (ignore-errors
         (clojure-forward-logical-sexp 1)
-        (search-forward-regexp "\\([,\s\t]*\\)" bound)
+        (search-forward-regexp "\\([,\s\t]*\\)\\(;+.*\\)?" bound)
         (pcase (syntax-after (point))
           ;; End-of-line, try again on next line.
           (`(12) (clojure--search-whitespace-after-next-sexp bound))

test/clojure-mode-indentation-test.el

@@ -705,6 +705,11 @@ x
     "#?@(:clj  [2]
     :cljs [2])")
 
+  (when-aligning-it "should work correctly when margin comments appear after multi-line, non-terminal sexps"
+    "(let [:x (+ 2 3
+            3 4) ; comment
+      :y (+ 1 2)])")
+
   (it "should handle improperly indented content"
     (let ((content "(let [a-long-name 10\nb 20])")
           (aligned-content "(let [a-long-name 10\n      b           20])"))