Drag sexp comments 3073 by jramosg · Pull Request #3178 · BetterThanTomorrow/calva

jramosg · 2026-04-18T14:50:32Z

What has changed?

formAttachedToCommentAt is used if the cursor is on a comment to find the attached form. Otherwise current fn currentSexpsRange is used.
After that, widen the move range with extendRangeOverAttachedComments, so the actual drag operation moves the form together with its attached comments.

Finds comments at the top, at the right and at the bottom of the form.

#_ comments are not taken into account, should they?

My Calva PR Checklist

I have:

A new `extendRangeBackwardOverPrecedingLineComments` helper walks backward from a range start over any contiguous line comments with no intervening blank line. Not wired up yet; will be used by the drag-sexp commands so comments travel with their associated form. Refs BetterThanTomorrow#3073

Use `extendRangeBackwardOverPrecedingLineComments` when computing the text ranges to swap in `dragSexprBackward`, so a comment attached to the form above travels with it. Cursor position is derived from the new extended ranges. Refs BetterThanTomorrow#3073

Mirror the backward change: use `extendRangeBackwardOverPrecedingLineComments` to compute the swap ranges in `dragSexprForward`. The cursor formula uses the original ranges' ends (extensions only affect starts), so it needs no change. Refs BetterThanTomorrow#3073

Refs BetterThanTomorrow#3073

Skip leading spaces/tabs on the form's own line before checking for a preceding newline, so nested forms inside containers pick up their comment lines the same way top-level forms do. Refs BetterThanTomorrow#3073

Refs BetterThanTomorrow#3073

netlify · 2026-04-18T14:50:37Z

✅ Deploy Preview for calva-docs ready!

Name	Link
🔨 Latest commit	`52cd85a`
🔍 Latest deploy log	https://app.netlify.com/projects/calva-docs/deploys/69f9be5c48b7570008ca998c
😎 Deploy Preview	https://deploy-preview-3178--calva-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

PEZ · 2026-04-18T20:16:21Z

Cool. Cases that bite me at times is when the comment sits directly below or to the right:

(+ 1 2) 
;=> 3

(+ 1 2) ; => 3

Often as a result of Evaluate to Comment.

…ments Replace `extendRangeBackwardOverPrecedingLineComments` and `formAttachedToCommentLineAt` with `extendRangeOverAttachedComments` and `formAttachedToCommentAt`, sharing a small `lineInfoAt` / `prevLine` / `nextLine` utility. The unified range extender also covers same-line trailing `;...` comments and comment lines below the form that are not leading a following form (terminated by a blank line or EOF). The comment-lookup helper now resolves trailing-annotation cursors by falling back to the form above when no form follows without a gap. Drag functions are simplified to pass `baseRange` (the bare form) to navigation and `currentRange` (the extended logical form) to the edit.

…osg/calva into fix/drag-sexp-comments-3073

Copilot

Pull request overview

Adjusts Calva’s Paredit “drag sexp” behavior so that forms move together with their associated line comments (leading, trailing inline, and certain trailing comment blocks), addressing the adjacent-comment reordering problem in #3073.

Changes:

Extend drag ranges to include “attached” comments and allow initiating drag from comment lines by resolving the attached form first.
Add unit tests covering drag behavior with leading/trailing comments and blank-line association rules.
Update keybinding when clauses to allow drag commands while the cursor is in comments; add changelog entry for #3073.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File	Description
src/extension-test/unit/cursor-doc/paredit-test.ts	Adds unit tests for drag/comment attachment scenarios (but currently includes an unused import).
src/cursor-doc/paredit.ts	Implements comment-aware range extension and comment→form attachment resolution for drag operations.
package.json	Enables drag keybindings in comment contexts by removing `!calva:cursorInComment`.
CHANGELOG.md	Adds an Unreleased entry referencing issue #3073.

Copilot · 2026-05-01T09:09:04Z

+  const baseRange =
+    formAttachedToCommentAt(doc, right) ?? currentSexpsRange(doc, cursor, right, usePairs, config);


When the cursor is on a line comment, baseRange falls back to currentSexpsRange if formAttachedToCommentAt returns null. Because the token cursor’s whitespace skipping treats comments as whitespace by default, this can end up dragging a neighboring form even when the comment is intentionally not attached (e.g. separated by a blank line). To preserve the “blank line breaks association” semantics, consider returning early (no-op) when offset is on a comment line but formAttachedToCommentAt returns null.

Suggested change

const baseRange =

formAttachedToCommentAt(doc, right) ?? currentSexpsRange(doc, cursor, right, usePairs, config);

const attachedCommentRange = formAttachedToCommentAt(doc, right);

const text = doc.model.getText(0, Number.MAX_SAFE_INTEGER);

const onCommentLine = isCommentLine(lineInfoAt(text, right));

if (onCommentLine && !attachedCommentRange) {

return;

}

const baseRange =

attachedCommentRange ?? currentSexpsRange(doc, cursor, right, usePairs, config);

Copilot · 2026-05-01T09:09:04Z


 ## [Unreleased]

+- [Dragging sexps has weird behavior with adjacent comments](https://github.com/BetterThanTomorrow/calva/issues/3073)


Changelog entries for bug fixes in this repo appear to use the Fix: prefix (e.g. 2.0.578, 2.0.575). Since this PR fixes #3073, consider updating this Unreleased entry to use Fix: for consistency.

Suggested change

- [Dragging sexps has weird behavior with adjacent comments](https://github.com/BetterThanTomorrow/calva/issues/3073)

- Fix: [Dragging sexps has weird behavior with adjacent comments](https://github.com/BetterThanTomorrow/calva/issues/3073)

Copilot · 2026-05-01T09:09:05Z

 import * as model from '../../../cursor-doc/model';
 import * as textNotation from '../common/text-notation';
 import * as _ from 'lodash';
+import { text } from 'stream/consumers';


Unused import text from stream/consumers is not referenced anywhere in this test file; this will fail lint/TS compilation. Remove the import.

Suggested change

import { text } from 'stream/consumers';

Copilot · 2026-05-01T09:09:05Z

+  }
+  if (trailingEnds.length && (!below || isBlankLine(below))) {
+    hi = trailingEnds[trailingEnds.length - 1];


extendRangeOverAttachedComments only attaches comment lines below the form if they’re followed by a blank line or EOF. Calva’s evaluation result comments are produced as \n;;=> … (see resultAsComment) and can be immediately followed by the next form without an extra blank line, in which case the ;;=> lines would not be moved with the form. Consider treating ;;=> (and/or ;=>) result comment lines as attached-to-previous even when another form follows.

This is something we can consider following up with, @jramosg. Sometimes you want a tight RCF with no blank lines, and the ;=> marker is what tells us where the comment belongs.

you're right, now is handled in trailingResultCommentBlockEnd

PEZ · 2026-05-01T09:11:18Z

Cool. Cases that bite me at times is when the comment sits directly below or to the right:
(+ 1 2) 
;=> 3

(+ 1 2) ; => 3
Often as a result of Evaluate to Comment.

Just checking. Are these cases also covered?

jramosg · 2026-05-01T09:29:19Z

Yes, they are now covered and tested! Do you miss some test case?

PEZ · 2026-05-02T05:57:18Z

Asked before checking test cases 😄 . Since there was no reaction or comment I didn't know if you had maybe missed it.

Things look good to me. This will be a great add!

jramosg · 2026-05-02T06:08:29Z

Oh sorry, I should answered before 🥲

This change introduces functionality to identify and extend ranges over trailing result comments in the paredit module. It adds a new helper function to detect result comment blocks and modifies the existing range extension logic to include these comments, improving the handling of comments in code.

This change introduces two test cases that verify the behavior of dragging sexp backward when a result comment follows immediately. These tests ensure that the functionality works correctly for both `;;=>` and `;=>` result comments.

Enhance the handling of result comments by introducing a function to identify result comment blocks. This ensures that trailing result comments are correctly processed when extending ranges over attached comments, improving the overall functionality of the paredit operations.

This commit introduces two test cases for the dragSexprForward function, ensuring it correctly handles result comments (both `;;=>` and `;=>`) when the next form follows immediately. This enhances the test coverage for the paredit functionality.

PEZ · 2026-05-04T07:43:18Z

Thanks for the updates! 🙏

I'm testing the VSIX of #4c8ae16, the next one wasn't built, and it says it is adding tests anyway.

Found these:

Extra space inserted for the comment

(comment
  ; a
  :a|
  :b
  )

Drag forward

(comment
  :b
    ; a
  :a|
  )

It continues to be insertd more spaces:

Drag backward

(comment
      ; a
  :a|
  :b
  )

However, this one works fine:

(comment
  ; a
  :a|
  ; b
  :b
  )

Drag forward

(comment
  ; b
  :b
  ; a
  :a|
  )

“tight” RCFs

(comment 
  :a
  :b|
  ;=> b
  :c
  )

Drag forward gives a warning message Overlapping ranges are not allowed.

Drag backward:

(comment 
  :b|
  ;=> b
  
  :a  :c
  )

`;=>`

For this one:

(comment 
  :a
  ;=> a
  :b
  :c|
  )

Drag backward

(comment 
  :a
  :c|
    ;=> a
  :b
  )

And:

(comment 
  :a
  ;=> a
  :b|
  :c
  )

Drag forward

(comment 
  :a
  :c
    ;=> a
  :b|
  )

In both cases I expect:

(comment 
  :a
  ;=> a
  :c
  :b|
  )

Since the :=> a belongs to :a.

PEZ · 2026-05-04T07:45:21Z

I hope I got the code blocks right. 😄 In fact, I am pretty sure I may have mixed something up.

jramosg · 2026-05-04T08:17:21Z

thanks! I will have a look

This change introduces functions to extend ranges to include leading comments when dragging sexps. It ensures that the text manipulation correctly accounts for comments, improving the handling of ranges during drag operations.

…dentation This commit introduces tests for dragging commented forms both forward and backward without altering indentation. It ensures that comments remain attached during the drag operations, enhancing the functionality and reliability of the paredit features.

Enhance the form attachment detection by adding support for result comments. This change ensures that when a result comment is encountered, the cursor can correctly navigate to the associated form, improving the user experience during editing operations.

This update introduces several test cases to ensure that dragging forms forward and backward correctly handles tight result comments. The tests verify that comments remain attached or detached as expected during drag operations, enhancing the robustness of the drag functionality in paredit.

jramosg · 2026-05-05T07:30:53Z

Screen.Recording.2026-05-05.at.09.28.51.mov

I think they are now fixed!

PEZ · 2026-05-06T19:40:39Z

This one packs a lot 😄

[:a ; a same line
 ; b line before 
 |:b] ; b same line

Drag backwards

[ ; b line before 
 :b
:a ; a same line] ; b same line

Dragging :a down renders the same result.

The above is a minified version of code like this:

(defn- clean-list-content
  "Clean content but don't double-indent nested lists that are already indented"
  [content indent-spaces]
  (let [indent (apply str (repeat indent-spaces " "))]
    (-> content
        (.replace #"^\n+" "")                       ; remove leading newlines
        (.replace #"\n+$" "\n")                     ; keep single trailing newline
        ;; Only indent lines that don't already start with spaces (nested lists)
        (.replace #"\n(?! )" (str "\n" indent)))))  ; indent nested content with single space

PEZ · 2026-05-06T20:10:54Z

(comment 
  :a
  :b|
  ;=> b
  :c
  )
Drag forward gives a warning message Overlapping ranges are not allowed.

Now the warning message is gone, but we get:

(comment 
  :a
  
  :b
  ;=> b  :c
  )

(The big problem here is that it comments out :c, in case not obvious.)

jramosg · 2026-05-07T14:37:14Z

(comment 
  :a
  :b|
  ;=> b
  :c
  )

What build are you testing? I think I fixed it yesterday, and I can’t reproduce it now. It’s strange because I thought I had already fixed it before your comment.

Video:
https://github.com/user-attachments/assets/f3249a0e-7117-4f74-9be2-53a0f33dd8e5

jramosg · 2026-05-07T14:39:43Z

```clojure
[:a ; a same line
 ; b line before 
 |:b] ; b same line

Drag backwards

[ ; b line before 
 :b
:a ; a same line] ; b same line

this is really tricki, let's see what can I do. Maybe we should ignore comment form pair here? There are not blank lines so we cannot decide which form belongs ; b line before to

[:a ; a same line
 ; b line before 
 |:b] ; b same line

jramosg added 14 commits April 18, 2026 15:00

Test: drag backward carries preceding line comment

a5d8e26

Refs BetterThanTomorrow#3073

Test: drag forward carries preceding line comment

232dad7

Refs BetterThanTomorrow#3073

Test: blank line breaks backward comment association

6e35fd3

Refs BetterThanTomorrow#3073

Test: blank line breaks forward comment association

f82fc4f

Refs BetterThanTomorrow#3073

Test: drag backward carries multiple preceding comment lines

9aad55f

Refs BetterThanTomorrow#3073

Test: drag forward alone when form has no preceding comment

55bae2e

Refs BetterThanTomorrow#3073

Test: drag backward when only the preceding form has a comment

dbbce39

Refs BetterThanTomorrow#3073

Support indented forms when extending over preceding comments

23f5641

Skip leading spaces/tabs on the form's own line before checking for a preceding newline, so nested forms inside containers pick up their comment lines the same way top-level forms do. Refs BetterThanTomorrow#3073

Test: drag indented sexp backward inside a container

5dd1c37

Refs BetterThanTomorrow#3073

Test: drag indented sexp forward inside a container

a4779fc

Refs BetterThanTomorrow#3073

Add changelog entry for dragging sexps with adjacent comments

633f4fe

Refs BetterThanTomorrow#3073

jramosg changed the base branch from published to dev April 18, 2026 14:51

jramosg changed the title ~~[Draft] Fix/drag sexp comments 3073~~ [Draft] Drag sexp comments 3073 Apr 18, 2026

jramosg marked this pull request as draft April 18, 2026 14:51

jramosg added 5 commits April 18, 2026 17:02

Add helper to detect form attached to a comment line

916a01d

Use comment-attached form in dragSexprBackward

e7be838

Use comment-attached form in dragSexprForward

912577b

Test: drag comment-form pair backward when cursor is on the comment

940faa1

Test: drag comment-form pair forward when cursor is on the comment

5207041

jramosg added 6 commits April 23, 2026 10:56

Test: drag sexp with its trailing same-line comment

7aefb1e

Test: drag sexp with a comment on the line below

e7b0193

fmt

aef0cb2

lint

5b714a9

Trigger Build

cda36c4

Merge branch 'fix/drag-sexp-comments-3073' of https://github.com/jram…

d376672

…osg/calva into fix/drag-sexp-comments-3073

jramosg requested review from PEZ and Copilot May 1, 2026 09:01

Copilot started reviewing on behalf of jramosg May 1, 2026 09:02 View session

Copilot AI reviewed May 1, 2026

View reviewed changes

jramosg added 7 commits May 4, 2026 08:02

Merge branch 'dev' into fix/drag-sexp-comments-3073

c5ae562

Update changelog

8f0f142

Remove unused import from paredit-test.ts

0419285

jramosg added 4 commits May 5, 2026 09:19

Normalize ranges for leading comments in drag functions

151b606

This change introduces functions to extend ranges to include leading comments when dragging sexps. It ensures that the text manipulation correctly accounts for comments, improving the handling of ranges during drag operations.

jramosg added 2 commits May 5, 2026 09:35

group tests in describe blocks

8521b61

add drag comments info in docs [skip ci]

52cd85a

		const baseRange =
		formAttachedToCommentAt(doc, right) ?? currentSexpsRange(doc, cursor, right, usePairs, config);

-  const baseRange =
-    formAttachedToCommentAt(doc, right) ?? currentSexpsRange(doc, cursor, right, usePairs, config);
+  const attachedCommentRange = formAttachedToCommentAt(doc, right);
+  const text = doc.model.getText(0, Number.MAX_SAFE_INTEGER);
+  const onCommentLine = isCommentLine(lineInfoAt(text, right));
+  if (onCommentLine && !attachedCommentRange) {
+    return;
+  }
+  const baseRange =
+    attachedCommentRange ?? currentSexpsRange(doc, cursor, right, usePairs, config);


		## [Unreleased]

		- [Dragging sexps has weird behavior with adjacent comments](https://github.com/BetterThanTomorrow/calva/issues/3073)

	- [Dragging sexps has weird behavior with adjacent comments](https://github.com/BetterThanTomorrow/calva/issues/3073)
	- Fix: [Dragging sexps has weird behavior with adjacent comments](https://github.com/BetterThanTomorrow/calva/issues/3073)

Uh oh!

Conversation

jramosg commented Apr 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What has changed?

My Calva PR Checklist

Uh oh!

netlify Bot commented Apr 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for calva-docs ready!

Uh oh!

PEZ commented Apr 18, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI May 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 1, 2026

Choose a reason for hiding this comment

Uh oh!

PEZ May 2, 2026

Choose a reason for hiding this comment

Uh oh!

jramosg May 4, 2026

Choose a reason for hiding this comment

Uh oh!

PEZ commented May 1, 2026

Uh oh!

jramosg commented May 1, 2026

Uh oh!

PEZ commented May 2, 2026

Uh oh!

jramosg commented May 2, 2026

Uh oh!

PEZ commented May 4, 2026

Extra space inserted for the comment

“tight” RCFs

;=>

Uh oh!

PEZ commented May 4, 2026

Uh oh!

jramosg commented May 4, 2026

Uh oh!

jramosg commented May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

PEZ commented May 6, 2026

Uh oh!

PEZ commented May 6, 2026

Uh oh!

jramosg commented May 7, 2026

Uh oh!

jramosg commented May 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jramosg commented Apr 18, 2026 •

edited

Loading

netlify Bot commented Apr 18, 2026 •

edited

Loading

`;=>`

jramosg commented May 5, 2026 •

edited

Loading