Implemented strict here selection type (#352)

AndreasArvidsson · pokey · web-flow · commit 57aeb8fcfdcf · 2021-12-16T17:23:28.000+01:00
* Implemented strict here selection type

* Initial backwards compatibility

* Start to refactor

* More changes

* Attempt to make new raw selections work

* Fix bug and add a bunch of tests

* Remove unused function

Co-authored-by: Pokey Rule &lt;pokey.rule@gmail.com&gt;
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -12,9 +12,10 @@
     // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
     "typescript.tsc.autoDetect": "off",
     "cSpell.words": [
-        "subword",
+        "Autoformatting",
         "eqeqeq",
         "nonlocal",
-        "pojo"
+        "pojo",
+        "subword"
     ]
 }
diff --git a/src/actions/BringMoveSwap.ts b/src/actions/BringMoveSwap.ts
@@ -115,8 +115,12 @@ class BringMoveSwap implements Action {
               let text = source.selection.editor.document.getText(
                 source.selection.selection
               );
-              return i > 0 && destination.selectionContext.containingListDelimiter
-                ? destination.selectionContext.containingListDelimiter + text
+              const selectionContext = destination.selectionContext
+                .isRawSelection
+                ? source.selectionContext
+                : destination.selectionContext;
+              return i > 0 && selectionContext.containingListDelimiter
+                ? selectionContext.containingListDelimiter + text
                 : text;
             })
             .join("");
diff --git a/src/core/inferFullTargets.ts b/src/core/inferFullTargets.ts
@@ -94,9 +94,11 @@ function inferPrimitiveTarget(
   previousTargets: PartialTarget[],
   actionPreferences: ActionPreferences
 ): PrimitiveTarget {
-  const previousTargetsForAttributes = hasContent(target)
-    ? []
-    : previousTargets;
+  const doAttributeInference = !hasContent(target) && !target.isImplicit;
+
+  const previousTargetsForAttributes = doAttributeInference
+    ? previousTargets
+    : [];
 
   const maybeSelectionType =
     target.selectionType ??
@@ -117,7 +119,7 @@ function inferPrimitiveTarget(
 
   const selectionType =
     maybeSelectionType ??
-    (target.modifier == null ? actionPreferences.selectionType : null) ??
+    (doAttributeInference ? actionPreferences.selectionType : null) ??
     "token";
 
   const insideOutsideType =
@@ -127,7 +129,7 @@ function inferPrimitiveTarget(
 
   const modifier = target.modifier ??
     getPreviousAttribute(previousTargetsForAttributes, "modifier") ??
-    (target.selectionType == null ? actionPreferences.modifier : null) ?? {
+    (doAttributeInference ? actionPreferences.modifier : null) ?? {
       type: "identity",
     };
 
@@ -138,6 +140,7 @@ function inferPrimitiveTarget(
     position,
     insideOutsideType,
     modifier,
+    isImplicit: target.isImplicit ?? false,
   };
 }
 
diff --git a/src/processTargets/index.ts b/src/processTargets/index.ts
@@ -12,7 +12,6 @@ import processMark from "./processMark";
 import processModifier from "./modifiers/processModifier";
 import processPosition from "./processPosition";
 import processSelectionType from "./processSelectionType";
-import { isForward as getIsForward } from "../util/selectionUtils";
 
 export default function (
   context: ProcessedTargetsContext,
@@ -275,6 +274,13 @@ function processPrimitiveTarget(
     ({ selection, context: selectionContext }) =>
       processSelectionType(context, target, selection, selectionContext)
   );
+
+  if (target.isImplicit) {
+    typedSelections.forEach((typedSelection) => {
+      typedSelection.selectionContext.isRawSelection = true;
+    });
+  }
+
   return typedSelections.map((selection) =>
     processPosition(context, target, selection)
   );
diff --git a/src/processTargets/modifiers/processModifier.ts b/src/processTargets/modifiers/processModifier.ts
@@ -10,6 +10,7 @@ import {
   NodeMatcher,
   PrimitiveTarget,
   ProcessedTargetsContext,
+  RawSelectionModifier,
   SelectionContext,
   SelectionWithEditor,
   SubTokenModifier,
@@ -52,6 +53,14 @@ export default function (
     case "surroundingPair":
       result = processSurroundingPair(context, selection, modifier);
       break;
+
+    case "toRawSelection":
+      result = processRawSelectionModifier(context, selection, modifier);
+      break;
+
+    default:
+      // Make sure we haven't missed any cases
+      const neverCheck: never = modifier;
   }
 
   if (result == null) {
@@ -233,3 +242,16 @@ export function findNearestContainingAncestorNode(
 
   return null;
 }
+
+function processRawSelectionModifier(
+  context: ProcessedTargetsContext,
+  selection: SelectionWithEditor,
+  modifier: RawSelectionModifier
+): SelectionWithEditorWithContext[] | null {
+  return [
+    {
+      selection,
+      context: { isRawSelection: true },
+    },
+  ];
+}
diff --git a/src/processTargets/processSelectionType.ts b/src/processTargets/processSelectionType.ts
@@ -62,13 +62,22 @@ function processToken(
     selectionType,
     position,
     insideOutsideType,
-    selectionContext: getTokenSelectionContext(
-      selection,
-      modifier,
-      position,
-      insideOutsideType,
-      selectionContext
-    ),
+    // NB: This is a hack to work around the fact that it's not currently
+    // possible to apply a modifier after processing the selection type. We
+    // would really prefer that the user be able to say "just" and have that be
+    // processed after we've processed the selection type, which would strip
+    // away the type information and turn it into a raw target. Until that's
+    // possible using the new pipelines, we instead just check for it here when
+    // we're doing the selection type and bail out if it is a raw target.
+    selectionContext: selectionContext.isRawSelection
+      ? selectionContext
+      : getTokenSelectionContext(
+          selection,
+          modifier,
+          position,
+          insideOutsideType,
+          selectionContext
+        ),
   };
 }
 
diff --git a/src/test/suite/fixtures/recorded/actions/bringAirAndBatAndCap.yml b/src/test/suite/fixtures/recorded/actions/bringAirAndBatAndCap.yml
@@ -12,12 +12,7 @@ command:
           mark: {type: decoratedSymbol, symbolColor: default, character: b}
         - type: primitive
           mark: {type: decoratedSymbol, symbolColor: default, character: c}
-    - type: primitive
-      mark: {type: cursor}
-      selectionType: token
-      position: contents
-      modifier: {type: identity}
-      insideOutsideType: inside
+    - {type: primitive, isImplicit: true}
 initialState:
   documentContents: |+
     a
diff --git a/src/test/suite/fixtures/recorded/actions/bringArgueFineAndZip.yml b/src/test/suite/fixtures/recorded/actions/bringArgueFineAndZip.yml
@@ -0,0 +1,54 @@
+languageId: typescript
+command:
+  version: 1
+  spokenForm: bring argue fine and zip
+  action: replaceWithTarget
+  targets:
+    - type: list
+      elements:
+        - type: primitive
+          modifier: {type: containingScope, scopeType: argumentOrParameter, includeSiblings: false}
+          mark: {type: decoratedSymbol, symbolColor: default, character: f}
+        - type: primitive
+          mark: {type: decoratedSymbol, symbolColor: default, character: z}
+    - {type: primitive, isImplicit: true}
+initialState:
+  documentContents: |-
+    function helloWorld(foo: string, bar: number, baz: string) {
+
+    }
+
+    function bongo() {
+        
+    }
+  selections:
+    - anchor: {line: 4, character: 15}
+      active: {line: 4, character: 15}
+  marks:
+    default.f:
+      start: {line: 0, character: 20}
+      end: {line: 0, character: 23}
+    default.z:
+      start: {line: 0, character: 46}
+      end: {line: 0, character: 49}
+finalState:
+  documentContents: |-
+    function helloWorld(foo: string, bar: number, baz: string) {
+
+    }
+
+    function bongo(foo: string, baz: string) {
+        
+    }
+  selections:
+    - anchor: {line: 4, character: 39}
+      active: {line: 4, character: 39}
+  thatMark:
+    - anchor: {line: 4, character: 15}
+      active: {line: 4, character: 39}
+  sourceMark:
+    - anchor: {line: 0, character: 20}
+      active: {line: 0, character: 31}
+    - anchor: {line: 0, character: 46}
+      active: {line: 0, character: 57}
+fullTargets: [{type: list, elements: [{type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: f}, selectionType: token, position: contents, insideOutsideType: null, modifier: {type: containingScope, scopeType: argumentOrParameter, includeSiblings: false}, isImplicit: false}, {type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: z}, selectionType: token, position: contents, insideOutsideType: null, modifier: {type: containingScope, scopeType: argumentOrParameter, includeSiblings: false}, isImplicit: false}]}, {type: primitive, mark: {type: cursor}, selectionType: token, position: contents, insideOutsideType: null, modifier: {type: identity}, isImplicit: true}]
diff --git a/src/test/suite/fixtures/recorded/actions/bringArgueOxAndZipToAfterJustLeper.yml b/src/test/suite/fixtures/recorded/actions/bringArgueOxAndZipToAfterJustLeper.yml
@@ -0,0 +1,60 @@
+languageId: typescript
+command:
+  version: 1
+  spokenForm: bring argue ox and zip to after just leper
+  action: replaceWithTarget
+  targets:
+    - type: list
+      elements:
+        - type: primitive
+          modifier: {type: containingScope, scopeType: argumentOrParameter, includeSiblings: false}
+          mark: {type: decoratedSymbol, symbolColor: default, character: o}
+        - type: primitive
+          mark: {type: decoratedSymbol, symbolColor: default, character: z}
+    - type: primitive
+      position: after
+      modifier: {type: toRawSelection}
+      mark: {type: decoratedSymbol, symbolColor: default, character: (}
+initialState:
+  documentContents: |-
+    function helloWorld(foo: string, bar: number, baz: string) {
+
+    }
+
+    function bongo() {
+        
+    }
+  selections:
+    - anchor: {line: 3, character: 0}
+      active: {line: 3, character: 0}
+  marks:
+    default.o:
+      start: {line: 0, character: 20}
+      end: {line: 0, character: 23}
+    default.z:
+      start: {line: 0, character: 46}
+      end: {line: 0, character: 49}
+    default.(:
+      start: {line: 4, character: 14}
+      end: {line: 4, character: 15}
+finalState:
+  documentContents: |-
+    function helloWorld(foo: string, bar: number, baz: string) {
+
+    }
+
+    function bongo(foo: string, baz: string) {
+        
+    }
+  selections:
+    - anchor: {line: 3, character: 0}
+      active: {line: 3, character: 0}
+  thatMark:
+    - anchor: {line: 4, character: 15}
+      active: {line: 4, character: 39}
+  sourceMark:
+    - anchor: {line: 0, character: 20}
+      active: {line: 0, character: 31}
+    - anchor: {line: 0, character: 46}
+      active: {line: 0, character: 57}
+fullTargets: [{type: list, elements: [{type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: o}, selectionType: token, position: contents, insideOutsideType: null, modifier: {type: containingScope, scopeType: argumentOrParameter, includeSiblings: false}, isImplicit: false}, {type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: z}, selectionType: token, position: contents, insideOutsideType: null, modifier: {type: containingScope, scopeType: argumentOrParameter, includeSiblings: false}, isImplicit: false}]}, {type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: (}, selectionType: token, position: after, insideOutsideType: null, modifier: {type: toRawSelection}, isImplicit: false}]
diff --git a/src/test/suite/fixtures/recorded/actions/bringLineHarpAndWhale.yml b/src/test/suite/fixtures/recorded/actions/bringLineHarpAndWhale.yml
@@ -0,0 +1,50 @@
+languageId: plaintext
+command:
+  version: 1
+  spokenForm: bring line harp and whale
+  action: replaceWithTarget
+  targets:
+    - type: list
+      elements:
+        - type: primitive
+          selectionType: line
+          mark: {type: decoratedSymbol, symbolColor: default, character: h}
+        - type: primitive
+          mark: {type: decoratedSymbol, symbolColor: default, character: w}
+    - {type: primitive, isImplicit: true}
+initialState:
+  documentContents: |+
+    hello
+    there
+    whatever
+
+  selections:
+    - anchor: {line: 4, character: 0}
+      active: {line: 4, character: 0}
+  marks:
+    default.h:
+      start: {line: 0, character: 0}
+      end: {line: 0, character: 5}
+    default.w:
+      start: {line: 2, character: 0}
+      end: {line: 2, character: 8}
+finalState:
+  documentContents: |-
+    hello
+    there
+    whatever
+
+    hello
+    whatever
+  selections:
+    - anchor: {line: 5, character: 8}
+      active: {line: 5, character: 8}
+  thatMark:
+    - anchor: {line: 4, character: 0}
+      active: {line: 5, character: 8}
+  sourceMark:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 5}
+    - anchor: {line: 2, character: 0}
+      active: {line: 2, character: 8}
+fullTargets: [{type: list, elements: [{type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: h}, selectionType: line, position: contents, insideOutsideType: null, modifier: {type: identity}, isImplicit: false}, {type: primitive, mark: {type: decoratedSymbol, symbolColor: default, character: w}, selectionType: line, position: contents, insideOutsideType: null, modifier: {type: identity}, isImplicit: false}]}, {type: primitive, mark: {type: cursor}, selectionType: token, position: contents, insideOutsideType: null, modifier: {type: identity}, isImplicit: true}]
diff --git a/src/test/suite/fixtures/recorded/actions/bringVest.yml b/src/test/suite/fixtures/recorded/actions/bringVest.yml
@@ -6,12 +6,7 @@ command:
   targets:
     - type: primitive
       mark: {type: decoratedSymbol, symbolColor: default, character: v}
-    - type: primitive
-      mark: {type: cursor}
-      selectionType: token
-      position: contents
-      modifier: {type: identity}
-      insideOutsideType: inside
+    - {type: primitive, isImplicit: true}
 initialState:
   documentContents: |
 
diff --git a/src/test/suite/fixtures/recorded/actions/callFine.yml b/src/test/suite/fixtures/recorded/actions/callFine.yml
@@ -6,12 +6,7 @@ command:
   targets:
     - type: primitive
       mark: {type: decoratedSymbol, symbolColor: default, character: f}
-    - type: primitive
-      mark: {type: cursor}
-      selectionType: token
-      position: contents
-      modifier: {type: identity}
-      insideOutsideType: inside
+    - {type: primitive, isImplicit: true}
 initialState:
   documentContents: |-
     foo;
diff --git a/src/test/suite/fixtures/recorded/actions/callVest.yml b/src/test/suite/fixtures/recorded/actions/callVest.yml
@@ -6,12 +6,7 @@ command:
   targets:
     - type: primitive
       mark: {type: decoratedSymbol, symbolColor: default, character: v}
-    - type: primitive
-      mark: {type: cursor}
-      selectionType: token
-      position: contents
-      modifier: {type: identity}
-      insideOutsideType: inside
+    - {type: primitive, isImplicit: true}
 initialState:
   documentContents: |
 
diff --git a/src/test/suite/fixtures/recorded/actions/moveVest.yml b/src/test/suite/fixtures/recorded/actions/moveVest.yml
@@ -6,12 +6,7 @@ command:
   targets:
     - type: primitive
       mark: {type: decoratedSymbol, symbolColor: default, character: v}
-    - type: primitive
-      mark: {type: cursor}
-      selectionType: token
-      position: contents
-      modifier: {type: identity}
-      insideOutsideType: inside
+    - {type: primitive, isImplicit: true}
 initialState:
   documentContents: |
 
diff --git a/src/test/suite/fixtures/recorded/hatTokenMap/bringHarpTakeWhale.yml b/src/test/suite/fixtures/recorded/hatTokenMap/bringHarpTakeWhale.yml
diff --git a/src/test/suite/fixtures/recorded/inference/bringLineLookToJustAir.yml b/src/test/suite/fixtures/recorded/inference/bringLineLookToJustAir.yml
diff --git a/src/test/suite/fixtures/recorded/languages/typescript/clearType2.yml b/src/test/suite/fixtures/recorded/languages/typescript/clearType2.yml
diff --git a/src/test/suite/fixtures/recorded/updateSelections/bringFine.yml b/src/test/suite/fixtures/recorded/updateSelections/bringFine.yml
diff --git a/src/test/suite/fixtures/recorded/updateSelections/bringWhale.yml b/src/test/suite/fixtures/recorded/updateSelections/bringWhale.yml
diff --git a/src/typings/Types.ts b/src/typings/Types.ts
diff --git a/src/util/canonicalizeTargets.ts b/src/util/canonicalizeTargets.ts

Original file line number	Diff line number	Diff line change
`@@ -12,9 +12,10 @@`
`12`	`12`	`// Turn off tsc task auto detection since we have the necessary tasks as npm scripts`
`13`	`13`	`"typescript.tsc.autoDetect": "off",`
`14`	`14`	`"cSpell.words": [`
`15`		`- "subword",`
	`15`	`+ "Autoformatting",`
`16`	`16`	`"eqeqeq",`
`17`	`17`	`"nonlocal",`
`18`		`- "pojo"`
	`18`	`+ "pojo",`
	`19`	`+ "subword"`
`19`	`20`	`]`
`20`	`21`	`}`