Scope tests

.pre-commit-config.yaml

@@ -40,7 +40,7 @@ repos:
         # tests use strings with trailing white space to represent the final
         # document contents. For example
         # packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/ruby/changeCondition.yml
-        exclude: ^packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/.*/[^/]*\.yml$
+        exclude: ^packages/cursorless-vscode-e2e/src/suite/fixtures/.*/[^/]*\.(yml|scope)$
   - repo: local
     hooks:
       - id: eslint

packages/common/src/testUtil/getFixturePaths.ts

@@ -21,6 +21,10 @@ export function getRecordedTestsDirPath() {
   return path.join(getFixturesPath(), "recorded");
 }
 
+export function getScopeTestsDirPath() {
+  return path.join(getFixturesPath(), "scopes");
+}
+
 export function getRecordedTestPaths() {
   const directory = getRecordedTestsDirPath();
   const relativeDir = path.dirname(directory);
@@ -32,3 +36,17 @@ export function getRecordedTestPaths() {
       path: p,
     }));
 }
+
+export function getScopeTestPaths() {
+  const directory = getScopeTestsDirPath();
+  const relativeDir = path.dirname(directory);
+
+  return walkFilesSync(directory)
+    .filter((p) => p.endsWith(".scope"))
+    .map((p) => ({
+      path: p,
+      name: path.relative(relativeDir, p.substring(0, p.lastIndexOf("."))),
+      languageId: path.dirname(path.relative(directory, p)),
+      facetId: path.basename(p.substring(0, p.lastIndexOf("."))),
+    }));
+}

packages/common/src/types/ScopeProvider.ts

@@ -178,7 +178,13 @@ export interface ScopeRanges {
  */
 export interface TargetRanges {
   contentRange: Range;
+  removalRange: Range;
   removalHighlightRange: GeneralizedRange;
+  leadingDelimiter: TargetRanges | undefined;
+  trailingDelimiter: TargetRanges | undefined;
+  interior: TargetRanges[] | undefined;
+  boundary: TargetRanges[] | undefined;
+  insertionDelimiter: string;
 }
 
 /**

packages/cursorless-engine/src/scopeProviders/getTargetRanges.ts

@@ -6,10 +6,36 @@ import {
 import { Target } from "../typings/target.types";
 
 export function getTargetRanges(target: Target): TargetRanges {
+  const interior = (() => {
+    try {
+      target.getInteriorStrict().map(getTargetRanges);
+    } catch (error) {
+      return undefined;
+    }
+  })();
+
+  const boundary = (() => {
+    try {
+      target.getBoundaryStrict().map(getTargetRanges);
+    } catch (error) {
+      return undefined;
+    }
+  })();
+
   return {
     contentRange: target.contentRange,
+    removalRange: target.getRemovalRange(),
     removalHighlightRange: target.isLine
       ? toLineRange(target.getRemovalHighlightRange())
       : toCharacterRange(target.getRemovalHighlightRange()),
+    leadingDelimiter: getOptionalTarget(target.getLeadingDelimiterTarget()),
+    trailingDelimiter: getOptionalTarget(target.getTrailingDelimiterTarget()),
+    interior,
+    boundary,
+    insertionDelimiter: target.insertionDelimiter,
   };
 }
+
+function getOptionalTarget(target: Target | undefined) {
+  return target != null ? getTargetRanges(target) : undefined;
+}

packages/cursorless-vscode-e2e/src/suite/fixtures/scopes/javascript/assignment.name.scope

@@ -0,0 +1,30 @@
+const name = "Hello world";
+---
+
+[Content]
+ const name = "Hello world";
+       ^^^^
+
+[Removal]
+ const name = "Hello world";
+ ^^^^^^^^^^^^^
+
+[Leading delimiter: Content]
+ const name = "Hello world";
+      ^
+
+[Leading delimiter: Removal]
+ const name = "Hello world";
+      ^
+
+[Trailing delimiter: Content]
+ const name = "Hello world";
+           ^
+
+[Trailing delimiter: Removal]
+ const name = "Hello world";
+           ^
+
+[Domain]
+ const name = "Hello world";
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^

packages/cursorless-vscode-e2e/src/suite/fixtures/scopes/javascript/assignment.value.scope

@@ -0,0 +1,22 @@
+const name = "Hello world";
+---
+
+[Content]
+ const name = "Hello world";
+              ^^^^^^^^^^^^^
+
+[Removal]
+ const name = "Hello world";
+           ^^^^^^^^^^^^^^^^
+
+[Leading delimiter: Content]
+ const name = "Hello world";
+           ^^^
+
+[Leading delimiter: Removal]
+ const name = "Hello world";
+           ^^^
+
+[Domain]
+ const name = "Hello world";
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^

packages/cursorless-vscode-e2e/src/suite/fixtures/scopes/javascript/function.scope

@@ -0,0 +1,25 @@
+function myFunk() {
+
+}
+---
+
+[Content]
+[-------------------
+ function myFunk() {
+
+ }
+ -]
+
+[Removal]
+[-------------------
+ function myFunk() {
+
+ }
+ -]
+
+[Domain]
+[-------------------
+ function myFunk() {
+
+ }
+ -]

packages/cursorless-vscode-e2e/src/suite/fixtures/scopes/javascript/line.scope

@@ -0,0 +1,117 @@
+
+aaa
+
+---
+
+[#1 Content]
+
+[]
+ aaa
+
+
+[#1 Removal]
+[
+
+ aaa
+ ]
+
+
+[#1 Trailing delimiter: Content]
+[
+
+ aaa
+ ]
+
+
+[#1 Trailing delimiter: Removal]
+[
+
+ aaa
+ ]
+
+
+[#1 Domain]
+
+[]
+ aaa
+
+
+[#2 Content]
+
+ aaa
+ ^^^
+
+
+[#2 Removal]
+
+[---
+ aaa
+
+ ]
+
+[#2 Leading delimiter: Content]
+[
+
+ aaa
+ ]
+
+
+[#2 Leading delimiter: Removal]
+[
+
+ aaa
+ ]
+
+
+[#2 Trailing delimiter: Content]
+
+   [
+ aaa
+
+ ]
+
+[#2 Trailing delimiter: Removal]
+
+   [
+ aaa
+
+ ]
+
+[#2 Domain]
+
+ aaa
+ ^^^
+
+
+[#3 Content]
+
+ aaa
+
+[]
+
+[#3 Removal]
+
+   [
+ aaa
+
+ ]
+
+[#3 Leading delimiter: Content]
+
+   [
+ aaa
+
+ ]
+
+[#3 Leading delimiter: Removal]
+
+   [
+ aaa
+
+ ]
+
+[#3 Domain]
+
+ aaa
+
+[]

packages/cursorless-vscode-e2e/src/suite/fixtures/scopes/javascript/paragraph.scope

@@ -0,0 +1,91 @@
+
+aaa
+bbb
+
+---
+
+[Content]
+
+[---
+ aaa
+ bbb
+ ---]
+
+
+[Removal]
+[
+
+ aaa
+ bbb
+
+ ]
+
+[Leading delimiter: Content]
+
+[]
+ aaa
+ bbb
+
+
+[Leading delimiter: Removal]
+[
+
+ aaa
+ ]
+ bbb
+
+
+[Leading delimiter | Trailing delimiter: Content]
+[
+
+ aaa
+ ]
+ bbb
+
+
+[Leading delimiter | Trailing delimiter: Removal]
+[
+
+ aaa
+ ]
+ bbb
+
+
+[Trailing delimiter: Content]
+
+ aaa
+ bbb
+
+[]
+
+[Trailing delimiter: Removal]
+
+ aaa
+   [
+ bbb
+
+ ]
+
+[Trailing delimiter | Leading delimiter: Content]
+
+ aaa
+   [
+ bbb
+
+ ]
+
+[Trailing delimiter | Leading delimiter: Removal]
+
+ aaa
+   [
+ bbb
+
+ ]
+
+[Domain]
+
+[---
+ aaa
+ bbb
+ ---]
+