Tweaks

Author: pokey

data/fixtures/recorded/languages/lua/changeString2.yml

@@ -0,0 +1,23 @@
+languageId: lua
+command:
+  version: 7
+  spokenForm: change string
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: surroundingPair, delimiter: string}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: "[[aaa]]"
+  selections:
+    - anchor: {line: 0, character: 2}
+      active: {line: 0, character: 2}
+  marks: {}
+finalState:
+  documentContents: ""
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}

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

@@ -6,10 +6,12 @@ import { unsafeKeys } from "../../../util/object";
 
 type IndividualDelimiterText = string | string[];
 
-const delimiterToText: Record<
+type DelimiterMap = Record<
   SimpleSurroundingPairName,
   [IndividualDelimiterText, IndividualDelimiterText]
-> = Object.freeze({
+>;
+
+const delimiterToText: DelimiterMap = Object.freeze({
   angleBrackets: [
     ["</", "<"],
     [">", "/>"],
@@ -26,20 +28,22 @@ const delimiterToText: Record<
   squareBrackets: ["[", "]"],
 });
 
-const delimiterToTextNix: Record<
-  SimpleSurroundingPairName,
-  [IndividualDelimiterText, IndividualDelimiterText]
-> = {
-  ...delimiterToText,
-  singleQuotes: ["''", "''"],
-};
+// FIXME: Probably remove these as part of
+// https://github.com/cursorless-dev/cursorless/issues/1812#issuecomment-1691493746
+const delimiterToTextOverrides: Record<string, Partial<DelimiterMap>> = {
+  nix: {
+    singleQuotes: ["''", "''"],
+  },
 
-const delimiterToTextLua: Record<
-  SimpleSurroundingPairName,
-  [IndividualDelimiterText, IndividualDelimiterText]
-> = {
-  ...delimiterToText,
-  // FIXME: Add [[ ]] somewhere
+  lua: {
+    // FIXME: Add special double square brackets
+    // see https://github.com/cursorless-dev/cursorless/pull/2012#issuecomment-1808214409
+    // see also https://github.com/cursorless-dev/cursorless/issues/1812#issuecomment-1691493746
+    doubleQuotes: [
+      ['"', "[["],
+      ['"', "]]"],
+    ],
+  },
 };
 
 export const leftToRightMap: Record<string, string> = Object.fromEntries(
@@ -65,22 +69,30 @@ export const complexDelimiterMap: Record<
 };
 
 /**
- * Given a language id, returns a list of all possible delimiters
- * for that language.
- * @param languageId The language id
+ * Given a language id, returns a list of all possible delimiters for that
+ * language.
+ *
+ * Allows us to support languages where the parse tree gives type names to nodes
+ * that don't correspond to the actual delimiter.
+ *
+ * Note that we pass in `undefined` if we are in a text fragment, because then
+ * we won't be using a parse tree.
+ *
+ * @param languageId The language id, or `undefined` if in a text fragment
  * @returns A list of all possible delimiters for that language
  */
 export function getSimpleDelimiterMap(
-  languageId: string,
+  languageId: string | undefined,
 ): Record<
   SimpleSurroundingPairName,
   [IndividualDelimiterText, IndividualDelimiterText]
 > {
-  if (languageId == "nix") {
-    return delimiterToTextNix;
-  } else if (languageId == "lua") {
-    return delimiterToTextLua;
-  } else {
-    return delimiterToText;
+  if (languageId != null && languageId in delimiterToTextOverrides) {
+    return {
+      ...delimiterToText,
+      ...delimiterToTextOverrides[languageId],
+    };
   }
+
+  return delimiterToText;
 }

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

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

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

@@ -1,18 +1,20 @@
 import { SimpleSurroundingPairName, isString } from "@cursorless/common";
 import { IndividualDelimiter } from "./types";
-import { getSimpleDelimiterMap } from "./getDelimiterMaps";
+import { getSimpleDelimiterMap } from "./delimiterMaps";
 import { concat, uniq } from "lodash";
 
 /**
  * Given a list of delimiters, returns a list where each element corresponds to
  * a single right or left delimiter.  Each item contains information such as a
  * reference to delimiter name, the text to expect, etc.
  *
+ * @param languageId The language id, or `undefined` if in a text fragment
  * @param delimiters The delimiter names
- * @returns A list of information about all possible left / right delimiter instances
+ * @returns A list of information about all possible left / right delimiter
+ * instances
  */
 export function getIndividualDelimiters(
-  languageId: string,
+  languageId: string | undefined,
   delimiters: SimpleSurroundingPairName[],
 ): IndividualDelimiter[] {
   const delimiterToText = getSimpleDelimiterMap(languageId);

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

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