Merge branch 'contiguous_scope' of github.com:cursorless-dev/cursorless into contiguous_scope

Author: AndreasArvidsson

.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$|/generated/|^patches/
+        exclude: ^packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/.*/[^/]*\.yml$|\.scope$|/generated/|^patches/
   - repo: local
     hooks:
       - id: eslint

changelog/2023-09-addedJoinLinesAction.md

@@ -0,0 +1,6 @@
+---
+tags: [enhancement]
+pullRequest: 1901
+---
+
+- Added `join` action. This action will join multiple lines together. eg `"join air"` or `"join three lines air"`.

cursorless-talon/src/spoken_forms.json

@@ -26,6 +26,7 @@
       "hover": "showHover",
       "indent": "indentLine",
       "inspect": "showDebugHover",
+      "join": "joinLines",
       "post": "setSelectionAfter",
       "pour": "editNewLineAfter",
       "pre": "setSelectionBefore",

docs/user/README.md

@@ -706,6 +706,17 @@ eg:
 
 Extracts the function call containing the decorated 'a' into its own variable.
 
+### Join
+
+Join multiple lines together.
+
+- `"join <TARGET>"`
+
+eg:
+
+- `join air`: Join the line with the token containing the letter 'a' with its next line.
+- `join block air`: Joines all lines in the paragraph with the token containing the letter 'a' together into a single line.
+
 ## Paired delimiters
 
 | Default spoken form | Delimiter name        | Symbol inserted before target | Symbol inserted after target | Is wrapper? | Is selectable? |

packages/common/src/index.ts

@@ -94,3 +94,7 @@ export * from "./types/TestCaseFixture";
 export * from "./util/getEnvironmentVariableStrict";
 export * from "./util/CompositeKeyDefaultMap";
 export * from "./util/toPlainObject";
+export * from "./scopeSupportFacets/scopeSupportFacets.types";
+export * from "./scopeSupportFacets/scopeSupportFacetInfos";
+export * from "./scopeSupportFacets/textualScopeSupportFacetInfos";
+export * from "./scopeSupportFacets/getLanguageScopeSupport";

packages/common/src/scopeSupportFacets/getLanguageScopeSupport.ts

@@ -0,0 +1,15 @@
+import { htmlScopeSupport } from "./html";
+import { javascriptScopeSupport } from "./javascript";
+import { LanguageScopeSupportFacetMap } from "./scopeSupportFacets.types";
+
+export function getLanguageScopeSupport(
+  languageId: string,
+): LanguageScopeSupportFacetMap {
+  switch (languageId) {
+    case "javascript":
+      return javascriptScopeSupport;
+    case "html":
+      return htmlScopeSupport;
+  }
+  throw Error(`Unsupported language: '${languageId}'`);
+}

packages/common/src/scopeSupportFacets/html.ts

@@ -0,0 +1,19 @@
+import {
+  LanguageScopeSupportFacetMap,
+  ScopeSupportFacetLevel,
+} from "./scopeSupportFacets.types";
+
+const { supported, notApplicable } = ScopeSupportFacetLevel;
+
+export const htmlScopeSupport: LanguageScopeSupportFacetMap = {
+  ["key.attribute"]: supported,
+  ["tags"]: supported,
+
+  namedFunction: notApplicable,
+  ["name.assignment"]: notApplicable,
+  ["key.mapPair"]: notApplicable,
+  ["key.mapPair.iteration"]: notApplicable,
+  ["value.mapPair"]: notApplicable,
+  ["value.mapPair.iteration"]: notApplicable,
+  ["value.assignment"]: notApplicable,
+};

packages/common/src/scopeSupportFacets/javascript.ts

@@ -0,0 +1,19 @@
+import {
+  LanguageScopeSupportFacetMap,
+  ScopeSupportFacetLevel,
+} from "./scopeSupportFacets.types";
+
+const { supported, notApplicable } = ScopeSupportFacetLevel;
+
+export const javascriptScopeSupport: LanguageScopeSupportFacetMap = {
+  namedFunction: supported,
+  ["name.assignment"]: supported,
+  ["key.mapPair"]: supported,
+  ["key.mapPair.iteration"]: supported,
+  ["value.mapPair"]: supported,
+  ["value.mapPair.iteration"]: supported,
+  ["value.assignment"]: supported,
+
+  ["key.attribute"]: notApplicable,
+  ["tags"]: notApplicable,
+};

packages/common/src/scopeSupportFacets/scopeSupportFacetInfos.ts

@@ -0,0 +1,48 @@
+import {
+  ScopeSupportFacet,
+  ScopeSupportFacetInfo,
+} from "./scopeSupportFacets.types";
+
+export const scopeSupportFacetInfos: Record<
+  ScopeSupportFacet,
+  ScopeSupportFacetInfo
+> = {
+  namedFunction: {
+    description: "A named function",
+    scopeType: "namedFunction",
+  },
+  ["name.assignment"]: {
+    description: "Name(LHS) of an assignment",
+    scopeType: "name",
+  },
+  ["key.attribute"]: {
+    description: "Key(LHS) of an attribute",
+    scopeType: "collectionKey",
+  },
+  ["key.mapPair"]: {
+    description: "Key(LHS) of a map pair",
+    scopeType: "collectionKey",
+  },
+  ["key.mapPair.iteration"]: {
+    description: "Iteration of map pair keys",
+    scopeType: "collectionKey",
+    isIteration: true,
+  },
+  ["value.assignment"]: {
+    description: "Value(RHS) of an assignment",
+    scopeType: "value",
+  },
+  ["value.mapPair"]: {
+    description: "Key(RHS) of a map pair",
+    scopeType: "value",
+  },
+  ["value.mapPair.iteration"]: {
+    description: "Iteration of map pair values",
+    scopeType: "value",
+    isIteration: true,
+  },
+  ["tags"]: {
+    description: "Both tags in an xml element",
+    scopeType: "xmlBothTags",
+  },
+};

packages/common/src/scopeSupportFacets/scopeSupportFacets.types.ts

@@ -0,0 +1,80 @@
+import { SimpleScopeTypeType } from "../types/command/PartialTargetDescriptor.types";
+
+const scopeSupportFacets = [
+  //   "list",
+  //   "list.interior",
+  //   "map",
+  //   "map.interior",
+  //   "collectionKey",
+  "namedFunction",
+  //   "namedFunction.interior",
+  //   "functionName",
+  //   "anonymousFunction",
+  //   "anonymousFunction.interior",
+  "name.assignment",
+  "key.attribute",
+  "key.mapPair",
+  "key.mapPair.iteration",
+  "value.assignment",
+  "value.mapPair",
+  "value.mapPair.iteration",
+  //   "value.assignment.removal",
+  //   "value.return",
+  //   "value.return.removal",
+  //   "value.collectionItem",
+  //   "value.collectionItem.removal",
+  //   "statement",
+  //   "ifStatement",
+  //   "condition.if",
+  //   "condition.while",
+  //   "condition.doWhile",
+  //   "condition.for",
+  //   "condition.ternary",
+  //   "branch",
+  //   "comment.line",
+  //   "comment.block",
+  //   "string.singleLine",
+  //   "string.multiLine",
+  //   "textFragment",
+  //   "functionCall",
+  //   "functionCallee",
+  //   "argumentOrParameter.argument",
+  //   "argumentOrParameter.argument.removal",
+  //   "argumentOrParameter.parameter",
+  //   "argumentOrParameter.parameter.removal",
+  //   "class",
+  //   "class.interior",
+  //   "className",
+  //   "type",
+  "tags",
+] as const;
+
+const textualScopeSupportFacets = [
+  "character",
+  "word",
+  "token",
+  "line",
+  "paragraph",
+  "document",
+] as const;
+
+export interface ScopeSupportFacetInfo {
+  readonly description: string;
+  readonly scopeType: SimpleScopeTypeType;
+  readonly isIteration?: boolean;
+}
+
+export enum ScopeSupportFacetLevel {
+  supported,
+  unsupported,
+  notApplicable,
+}
+
+export type ScopeSupportFacet = (typeof scopeSupportFacets)[number];
+
+export type TextualScopeSupportFacet =
+  (typeof textualScopeSupportFacets)[number];
+
+export type LanguageScopeSupportFacetMap = Partial<
+  Record<ScopeSupportFacet, ScopeSupportFacetLevel>
+>;