Fix '' strings and add related tests

Author: fidgetingbits

packages/cursorless-engine/src/processTargets/modifiers/surroundingPair/findSurroundingPairParseTreeBased.ts

@@ -66,7 +66,10 @@ export function findSurroundingPairParseTreeBased(
 ) {
   const document: TextDocument = editor.document;
 
-  const individualDelimiters = getIndividualDelimiters(delimiters);
+  const individualDelimiters = getIndividualDelimiters(
+    document.languageId,
+    delimiters,
+  );
 
   const delimiterTextToDelimiterInfoMap = Object.fromEntries(
     individualDelimiters.map((individualDelimiter) => [

packages/cursorless-engine/src/processTargets/modifiers/surroundingPair/findSurroundingPairTextBased.ts

@@ -74,7 +74,10 @@ export function findSurroundingPairTextBased(
   const document: TextDocument = editor.document;
   const fullRange = allowableRange ?? document.range;
 
-  const individualDelimiters = getIndividualDelimiters(delimiters);
+  const individualDelimiters = getIndividualDelimiters(
+    editor.document.languageId,
+    delimiters,
+  );
 
   const delimiterTextToDelimiterInfoMap = Object.fromEntries(
     individualDelimiters.map((individualDelimiter) => [

packages/cursorless-engine/src/processTargets/modifiers/surroundingPair/delimiterMaps.ts renamed to packages/cursorless-engine/src/processTargets/modifiers/surroundingPair/getDelimiterMaps.ts

@@ -5,7 +5,7 @@ import {
 
 type IndividualDelimiterText = string | string[];
 
-export const delimiterToText: Record<
+const delimiterToText: Record<
   SimpleSurroundingPairName,
   [IndividualDelimiterText, IndividualDelimiterText]
 > = {
@@ -25,6 +25,26 @@ export const delimiterToText: Record<
   squareBrackets: ["[", "]"],
 };
 
+const delimiterToTextNix: Record<
+  SimpleSurroundingPairName,
+  [IndividualDelimiterText, IndividualDelimiterText]
+> = {
+  angleBrackets: [
+    ["</", "<"],
+    [">", "/>"],
+  ],
+  backtickQuotes: ["`", "`"],
+  curlyBrackets: [["{", "${"], "}"],
+  doubleQuotes: ['"', '"'],
+  escapedDoubleQuotes: ['\\"', '\\"'],
+  escapedParentheses: ["\\(", "\\)"],
+  escapedSquareBrackets: ["\\[", "\\]"],
+  escapedSingleQuotes: ["\\'", "\\'"],
+  parentheses: [["(", "$("], ")"],
+  singleQuotes: ["''", "''"],
+  squareBrackets: ["[", "]"],
+};
+
 export const leftToRightMap: Record<string, string> = Object.fromEntries(
   Object.values(delimiterToText),
 );
@@ -46,3 +66,22 @@ export const complexDelimiterMap: Record<
     "angleBrackets",
   ],
 };
+
+/**
+ * Given a language id, returns a list of all possible delimiters
+ * for that language.
+ * @param languageId The language id
+ * @returns A list of all possible delimiters for that language
+ */
+export function getSimpleDelimiterMap(
+  languageId: string,
+): Record<
+  SimpleSurroundingPairName,
+  [IndividualDelimiterText, IndividualDelimiterText]
+> {
+  if (languageId == "nix") {
+    return delimiterToTextNix;
+  } else {
+    return delimiterToText;
+  }
+}

packages/cursorless-engine/src/processTargets/modifiers/surroundingPair/getIndividualDelimiters.ts

@@ -1,6 +1,6 @@
 import { SimpleSurroundingPairName } from "@cursorless/common";
 import { IndividualDelimiter } from "./types";
-import { delimiterToText } from "./delimiterMaps";
+import { getSimpleDelimiterMap } from "./getDelimiterMaps";
 import { concat, uniq } from "lodash";
 import { isString } from "../../../util/type";
 
@@ -13,8 +13,10 @@ import { isString } from "../../../util/type";
  * @returns A list of information about all possible left / right delimiter instances
  */
 export function getIndividualDelimiters(
+  languageId: string,
   delimiters: SimpleSurroundingPairName[],
 ): IndividualDelimiter[] {
+  const delimiterToText = getSimpleDelimiterMap(languageId);
   return delimiters.flatMap((delimiter) => {
     const [leftDelimiter, rightDelimiter] = delimiterToText[delimiter];
 

packages/cursorless-engine/src/processTargets/modifiers/surroundingPair/index.ts

@@ -9,7 +9,7 @@ import getTextFragmentExtractor from "../../../languages/getTextFragmentExtracto
 import { Target } from "../../../typings/target.types";
 import { SurroundingPairTarget } from "../../targets";
 import { getContainingScopeTarget } from "../getContainingScopeTarget";
-import { complexDelimiterMap } from "./delimiterMaps";
+import { complexDelimiterMap } from "./getDelimiterMaps";
 import { SurroundingPairInfo } from "./extractSelectionFromSurroundingPairOffsets";
 import { findSurroundingPairParseTreeBased } from "./findSurroundingPairParseTreeBased";
 import { findSurroundingPairTextBased } from "./findSurroundingPairTextBased";

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/nix/changeRound2.yml

@@ -0,0 +1,29 @@
+languageId: nix
+command:
+  version: 6
+  spokenForm: change round
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: surroundingPair, delimiter: parentheses}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |
+    {
+      b = ''two single (quote) string'';
+    }
+  selections:
+    - anchor: {line: 1, character: 22}
+      active: {line: 1, character: 22}
+  marks: {}
+finalState:
+  documentContents: |
+    {
+      b = ''two single  string'';
+    }
+  selections:
+    - anchor: {line: 1, character: 19}
+      active: {line: 1, character: 19}

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/nix/changeString.yml

@@ -0,0 +1,29 @@
+languageId: nix
+command:
+  version: 6
+  spokenForm: change string
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: surroundingPair, delimiter: string}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |
+    {
+      a = "double quoted string";
+    }
+  selections:
+    - anchor: {line: 1, character: 25}
+      active: {line: 1, character: 25}
+  marks: {}
+finalState:
+  documentContents: |
+    {
+      a = ;
+    }
+  selections:
+    - anchor: {line: 1, character: 6}
+      active: {line: 1, character: 6}

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/nix/changeString2.yml

@@ -0,0 +1,29 @@
+languageId: nix
+command:
+  version: 6
+  spokenForm: change string
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: surroundingPair, delimiter: string}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |
+    {
+      b = ''two single (quote) string'';
+    }
+  selections:
+    - anchor: {line: 1, character: 16}
+      active: {line: 1, character: 16}
+  marks: {}
+finalState:
+  documentContents: |
+    {
+      b = ;
+    }
+  selections:
+    - anchor: {line: 1, character: 6}
+      active: {line: 1, character: 6}

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/nix/changeString3.yml

@@ -0,0 +1,31 @@
+languageId: nix
+command:
+  version: 6
+  spokenForm: change string
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: surroundingPair, delimiter: string}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |
+    {
+      c = ''
+        multi-line
+        quote string'';
+    }
+  selections:
+    - anchor: {line: 3, character: 4}
+      active: {line: 3, character: 4}
+  marks: {}
+finalState:
+  documentContents: |
+    {
+      c = ;
+    }
+  selections:
+    - anchor: {line: 1, character: 6}
+      active: {line: 1, character: 6}