migrate Go scopes statement, comment, string, and textFragment (#1685)

This begins the Go migration to treesitter.

In addition to migrating scopes, this commit includes two bug fixes.

(1)

It adds a statement scope for expression statements.
This fixes #1592.

Note that block statements are omitted.
There are many block statements in a normal Go program,
most of which are not of interest.

For example, in:

if x() {
    // nada
}

there are two statements, one that is the entire if statement,
and one block statement that runs from brace to brace.
As the typical block statement includes other statements,
and is usually part of other named statements,
it will not typically be helpful during editing.

(2)

It fixes an existing bug in the handling of paired delimiters
when used with treesitter-based scopes.

When looking for paired delimiters from inside a string,
we first search inside the string only,
then outside the string only.

This lets us find the parens in both

"(hello)"

and

("hello")

given command "take round odd".

However, that fallback logic did not get replicated
to the treesitter-based scope flow.
As a result, we never searched outside the string.

Co-authored-by: Pokey Rule <[email protected]>



## Checklist

- [x] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [x] I have updated the
[docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and
[cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)
- [x] I have not broken the cheatsheet

Co-authored-by: Pokey Rule <[email protected]>

Author: josharian

packages/cursorless-engine/src/languages/getTextFragmentExtractor.ts

@@ -135,7 +135,6 @@ const textFragmentExtractors: Record<
     "css",
     scssStringTextFragmentExtractor,
   ),
-  go: constructDefaultTextFragmentExtractor("go"),
   html: constructDefaultTextFragmentExtractor(
     "html",
     htmlStringTextFragmentExtractor,

packages/cursorless-engine/src/languages/go.ts

@@ -8,46 +8,14 @@ import {
 import { NodeMatcherAlternative } from "../typings/Types";
 import { SimpleScopeTypeType } from "@cursorless/common";
 
-// Generated by the following command:
-// `curl https://raw.githubusercontent.com/tree-sitter/tree-sitter-go/master/src/node-types.json | jq '[.[] | select(.type == "_statement" or .type == "_simple_statement") | .subtypes[].type]'`
-const STATEMENT_TYPES = [
-  "_expression",
-  "assignment_statement",
-  "dec_statement",
-  "inc_statement",
-  "send_statement",
-  "short_var_declaration",
-  "_simple_statement",
-  "break_statement",
-  "const_declaration",
-  "continue_statement",
-  "defer_statement",
-  "empty_statement",
-  "expression_switch_statement",
-  "fallthrough_statement",
-  "for_statement",
-  "go_statement",
-  "goto_statement",
-  "if_statement",
-  "labeled_statement",
-  "return_statement",
-  "select_statement",
-  "type_declaration",
-  "type_switch_statement",
-  "var_declaration",
-];
-
 const nodeMatchers: Partial<
   Record<SimpleScopeTypeType, NodeMatcherAlternative>
 > = {
   map: "composite_literal",
   list: ["composite_literal", "slice_type", "array_type"],
-  statement: STATEMENT_TYPES,
-  string: ["interpreted_string_literal", "raw_string_literal"],
   ifStatement: "if_statement",
   functionCall: ["call_expression", "composite_literal"],
   functionCallee: ["call_expression[function]", "composite_literal[type]"],
-  comment: "comment",
   namedFunction: ["function_declaration", "method_declaration"],
   type: [
     "pointer_type",

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

@@ -86,13 +86,25 @@ function processSurroundingPairCore(
     );
 
     if (containingScope != null) {
-      return findSurroundingPairTextBased(
+      const surroundingRange = findSurroundingPairTextBased(
         editor,
         range,
         containingScope[0].contentRange,
         delimiters,
         scopeType,
       );
+      if (surroundingRange != null) {
+        // Found the pair within this text fragment or comment, e.g. "(abc)"
+        return surroundingRange;
+      }
+      // Search in the rest of the file, to find e.g. ("abc")
+      return findSurroundingPairTextBased(
+        editor,
+        range,
+        null,
+        delimiters,
+        scopeType,
+      );
     }
   }
 

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/go/assignStatement.yml

@@ -0,0 +1,27 @@
+languageId: go
+command:
+  version: 6
+  spokenForm: change state plex
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: statement}
+      mark: {type: decoratedSymbol, symbolColor: default, character: x}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: x = 1
+  selections:
+    - anchor: {line: 0, character: 5}
+      active: {line: 0, character: 5}
+  marks:
+    default.x:
+      start: {line: 0, character: 0}
+      end: {line: 0, character: 1}
+finalState:
+  documentContents: ""
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/go/changeRound.yml

@@ -0,0 +1,23 @@
+languageId: go
+command:
+  version: 6
+  spokenForm: change round
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: surroundingPair, delimiter: parentheses}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: _ = ("abc")
+  selections:
+    - anchor: {line: 0, character: 9}
+      active: {line: 0, character: 9}
+  marks: {}
+finalState:
+  documentContents: "_ = "
+  selections:
+    - anchor: {line: 0, character: 4}
+      active: {line: 0, character: 4}

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

@@ -0,0 +1,23 @@
+languageId: go
+command:
+  version: 6
+  spokenForm: change round
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: surroundingPair, delimiter: parentheses}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: _ = "(abc)"
+  selections:
+    - anchor: {line: 0, character: 9}
+      active: {line: 0, character: 9}
+  marks: {}
+finalState:
+  documentContents: _ = ""
+  selections:
+    - anchor: {line: 0, character: 5}
+      active: {line: 0, character: 5}

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/go/constStatement.yml

@@ -0,0 +1,27 @@
+languageId: go
+command:
+  version: 6
+  spokenForm: change state plex
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: statement}
+      mark: {type: decoratedSymbol, symbolColor: default, character: x}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: const x = 1
+  selections:
+    - anchor: {line: 0, character: 11}
+      active: {line: 0, character: 11}
+  marks:
+    default.x:
+      start: {line: 0, character: 6}
+      end: {line: 0, character: 7}
+finalState:
+  documentContents: ""
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/go/decStatement.yml

@@ -0,0 +1,27 @@
+languageId: go
+command:
+  version: 6
+  spokenForm: change state plex
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: statement}
+      mark: {type: decoratedSymbol, symbolColor: default, character: x}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: x--
+  selections:
+    - anchor: {line: 0, character: 3}
+      active: {line: 0, character: 3}
+  marks:
+    default.x:
+      start: {line: 0, character: 0}
+      end: {line: 0, character: 1}
+finalState:
+  documentContents: ""
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/go/expressionStatement.yml

@@ -0,0 +1,23 @@
+languageId: go
+command:
+  version: 6
+  spokenForm: change state
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: statement}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: fmt.Print("hi")
+  selections:
+    - anchor: {line: 0, character: 13}
+      active: {line: 0, character: 13}
+  marks: {}
+finalState:
+  documentContents: ""
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/go/ifStatement.yml

@@ -0,0 +1,27 @@
+languageId: go
+command:
+  version: 6
+  spokenForm: change state plex
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: statement}
+      mark: {type: decoratedSymbol, symbolColor: default, character: x}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: if x {}
+  selections:
+    - anchor: {line: 0, character: 6}
+      active: {line: 0, character: 6}
+  marks:
+    default.x:
+      start: {line: 0, character: 3}
+      end: {line: 0, character: 4}
+finalState:
+  documentContents: ""
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}