Merge pull request #3064 from jramosg/fix-3063-evaluate-selection-comment-context-menu

Fix 3063 evaluate selection comment context menu

Fixes #3063

Author: jramosg

CHANGELOG.md

@@ -4,6 +4,7 @@ Changes to Calva.
 
 ## [Unreleased]
 
+- Fix: [calva.evaluateSelectionAsComment missing from context menu](https://github.com/BetterThanTomorrow/calva/issues/3063)
 - Fix: [Error instrumenting function through command palette](https://github.com/BetterThanTomorrow/calva/issues/2966)
 - Fix: [paredit.insertSemiColon requires two undo operations in structure-preserving case](https://github.com/BetterThanTomorrow/calva/issues/3059)
 - Fix: [paredit.insertSemiColon can break structure before closing delimiter](https://github.com/BetterThanTomorrow/calva/issues/3061)

src/evaluate-utils.ts

@@ -0,0 +1,29 @@
+export type EvaluateAsCommentOptions = {
+  commentStyle: string;
+};
+
+/**
+ * Normalize the Calva Evaluate Selection as Comment arguments.
+ *
+ * The context menu handler passes the document/context object as the first
+ * parameter, while palette/shortcut invocations pass the options bag first.
+ * To handle both, we inspect the first argument for a `commentStyle` key.
+ */
+export function normalizeEvaluateAsCommentArgs(
+  documentOrOptions,
+  options: EvaluateAsCommentOptions = { commentStyle: 'line' }
+): {
+  options: EvaluateAsCommentOptions;
+  document: unknown;
+} {
+  const opt1CommentStyle = documentOrOptions?.commentStyle;
+  return opt1CommentStyle
+    ? {
+        document: options,
+        options: documentOrOptions as EvaluateAsCommentOptions,
+      }
+    : {
+        document: documentOrOptions,
+        options: options.commentStyle ? options : { ...options, commentStyle: 'line' },
+      };
+}

src/evaluate.ts

@@ -21,6 +21,7 @@ import * as inspector from './providers/inspector';
 import { resultAsComment } from './util/string-result';
 import { highlight } from './highlight/src/extension';
 import * as flareHandler from './flare-handler';
+import { normalizeEvaluateAsCommentArgs } from './evaluate-utils';
 
 let inspectorDataProvider: inspector.InspectorDataProvider;
 
@@ -415,11 +416,12 @@ function validateCommentStyle(commentStyle: string) {
 }
 
 function evaluateSelectionAsComment(options = { commentStyle: 'line' }, document = {}) {
-  validateCommentStyle(options.commentStyle);
+  const normalized = normalizeEvaluateAsCommentArgs(document, options);
+  validateCommentStyle(normalized.options.commentStyle);
   if (util.getConnectedState()) {
     evaluateSelection(
-      document,
-      Object.assign({}, options, {
+      normalized.document,
+      Object.assign({}, normalized.options, {
         comment: true,
         pprintOptions: getConfig().prettyPrintingOptions,
         selectionFn: _currentSelectionElseCurrentForm,
@@ -431,11 +433,12 @@ function evaluateSelectionAsComment(options = { commentStyle: 'line' }, document
 }
 
 function evaluateTopLevelFormAsComment(options = { commentStyle: 'line' }, document = {}) {
-  validateCommentStyle(options.commentStyle);
+  const normalized = normalizeEvaluateAsCommentArgs(document, options);
+  validateCommentStyle(normalized.options.commentStyle);
   if (util.getConnectedState()) {
     evaluateSelection(
-      document,
-      Object.assign({}, options, {
+      normalized.document,
+      Object.assign({}, normalized.options, {
         comment: true,
         pprintOptions: getConfig().prettyPrintingOptions,
         selectionFn: _currentTopLevelFormText,

src/extension-test/unit/normalize-evaluate-comment-args-test.ts

@@ -0,0 +1,33 @@
+import * as expect from 'expect';
+import { normalizeEvaluateAsCommentArgs } from '../../evaluate-utils';
+
+describe('normalizeEvaluateAsCommentArgs', () => {
+  it('normalizes command invocation (options first)', () => {
+    const documentArg = { some: 'document-context' };
+    const normalized = normalizeEvaluateAsCommentArgs(
+      { commentStyle: 'ignore' },
+      documentArg as any
+    );
+
+    expect(normalized.options.commentStyle).toBe('ignore');
+    expect(normalized.document).toBe(documentArg);
+  });
+
+  it('normalizes context menu invocation (document first)', () => {
+    const documentArg = { some: 'document-context' };
+    const normalized = normalizeEvaluateAsCommentArgs(documentArg, {
+      commentStyle: 'rcf',
+    });
+
+    expect(normalized.document).toBe(documentArg);
+    expect(normalized.options.commentStyle).toBe('rcf');
+  });
+
+  it('defaults comment style to line when context menu invocation omits options', () => {
+    const documentArg = { some: 'document-context' };
+    const normalized = normalizeEvaluateAsCommentArgs(documentArg);
+
+    expect(normalized.document).toBe(documentArg);
+    expect(normalized.options.commentStyle).toBe('line');
+  });
+});