Merge pull request #2659 from BetterThanTomorrow/2655-top-level-eval-…

…of-ignores

Add test for making sure the ignore marker is not included  in top le…

* Fixes #2655

CHANGELOG.md

@@ -6,6 +6,7 @@ Changes to Calva.
 
 - [Add extension when contexts for Calva states such as project root, session type, ns](https://github.com/BetterThanTomorrow/calva/issues/2652)
 - Fix: [Calva internals: The `backwardSexp` function can't handle skipping ignored forms, even though it says it can](https://github.com/BetterThanTomorrow/calva/issues/2657)
+- Fix: [Keep support for evaluating top level form in ignored forms when at top level](https://github.com/BetterThanTomorrow/calva/issues/2655)
 
 ## [2.0.480] - 2024-10-21
 

docs/site/evaluation.md

@@ -35,7 +35,7 @@ Some of the commands also let you choose what should happen with the results:
     * The `line` style is the default.
     * The `ignore` style will put an ignore marker (`#_`) before the result.
     * The `rcf` style will wrap the result in a rich comment form ( `(comment ...)`).
-    
+
     Here are some example keybindings for using the different comment styles with the **Evaluate Top Level Form (defun) to Comment** command:
 
     ```jsonc
@@ -108,6 +108,8 @@ The **current top-level form** means top-level in a structural sense. It is _not
 
 An ”exception” is introduced by the `comment` form. It will create a new top level context, so that any forms immediately inside a `(comment ...)` form will be considered top-level by Calva. This is to support a workflow with what is often referred to the [Rich Comments](rich-comments.md).
 
+A special case is ignored forms (using the `#_` marker) at the top level. They will always be selected as top level forms separately from their ignore marker, enabling evaluating them as top level forms. Similar to Rich Comments.
+
 At the top level the selection of which form is the current top level form follows the same rules as those for [the current form](#current-form).
 
 ### Evaluate Enclosing Form

src/extension-test/unit/cursor-doc/token-cursor-test.ts

@@ -804,6 +804,13 @@ describe('Token Cursor', () => {
       const cursor: LispTokenCursor = a.getTokenCursor(a.selections[0].active);
       expect(cursor.rangeForDefun(a.selections[0].active)).toEqual(textAndSelection(b)[1]);
     });
+    // https://github.com/BetterThanTomorrow/calva/issues/2655
+    it('Does not include ignore marker', () => {
+      const a = docFromTextNotation('a #_ [b (c|)] [d]');
+      const b = docFromTextNotation('a #_ |[b (c)]| [d]');
+      const cursor: LispTokenCursor = a.getTokenCursor(a.selections[0].active);
+      expect(cursor.rangeForDefun(a.selections[0].active)).toEqual(textAndSelection(b)[1]);
+    });
     describe('Rich Comment Form top level context', () => {
       it('Finds range for a top level form inside a comment', () => {
         const a = docFromTextNotation('aaa (comment [bbb cc|c]  ddd)');
@@ -954,6 +961,13 @@ describe('Token Cursor', () => {
         const cursor: LispTokenCursor = a.getTokenCursor(0);
         expect(cursor.rangeForDefun(a.selections[0].anchor)).toEqual(textAndSelection(b)[1]);
       });
+      // https://github.com/BetterThanTomorrow/calva/issues/2655
+      it('Does not include ignore marker', () => {
+        const a = docFromTextNotation('aaa (comment #_ [bbb ccc|]  ddd)');
+        const b = docFromTextNotation('aaa (comment #_ |[bbb ccc]|  ddd)');
+        const cursor: LispTokenCursor = a.getTokenCursor(a.selections[0].active);
+        expect(cursor.rangeForDefun(a.selections[0].active)).toEqual(textAndSelection(b)[1]);
+      });
     });
   });