Add key/value support and fix some edge interpolation edge cases

Author: fidgetingbits

data/playground/shellscript/shellscript.sh

@@ -1,15 +1,15 @@
 #!/bin/bash
 
+
 # Variable declaration
 var="Hello, World"
-number=42
 array=("apple" "banana" "cherry")
 
 # Output variables
 echo "String variable: $var"
 echo "Number variable: $number"
 echo "Array variable: ${array[*]}"
-
+echo A B C
 # If statement
 if [ "$number" -eq 42 ]; then
   echo "The number is 42"
@@ -36,6 +36,9 @@ my_function() {
   echo "$local_var from function"
 }
 
+sub_function() (foo)
+sub_function() ((foo++))
+
 my_function "Function Argument"
 
 # Case statement
@@ -163,3 +166,7 @@ echo "Incremented value: $value"
 numbers=(1 2 3 4 5)
 sliced_numbers=("${numbers[@]:1:3}")
 echo "Sliced array: ${sliced_numbers[*]}"
+
+declare -A arr
+arr["key1"]=val1
+arr+=(["key2"]=val2 ["key3"]=val3)

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/containingScope/changeGrandState.yml

@@ -1,7 +1,7 @@
 languageId: javascript
 command:
   version: 6
-  spokenForm: change grand state
+  spokenForm: change state
   action:
     name: clearAndSetSelection
     target:

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/containingScope/changeGrandState2.yml

@@ -1,7 +1,7 @@
 languageId: python
 command:
   version: 6
-  spokenForm: change grand state
+  spokenForm: change state
   action:
     name: clearAndSetSelection
     target:

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/containingScope/changeGrandState3.yml

@@ -1,7 +1,7 @@
 languageId: javascript
 command:
   version: 6
-  spokenForm: change grand state
+  spokenForm: change state
   action:
     name: clearAndSetSelection
     target:

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/shellscript/changeEveryArgInsideTrap.yml

@@ -0,0 +1,32 @@
+languageId: shellscript
+command:
+  version: 6
+  spokenForm: change every arg inside trap
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: t}
+      modifiers:
+        - type: everyScope
+          scopeType: {type: argumentOrParameter}
+        - {type: interiorOnly}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |
+    echo "Test ${foo} ${bar}"
+  selections:
+    - anchor: {line: 0, character: 13}
+      active: {line: 0, character: 13}
+  marks:
+    default.t:
+      start: {line: 0, character: 6}
+      end: {line: 0, character: 10}
+finalState:
+  documentContents: |
+    echo "Test  "
+  selections:
+    - anchor: {line: 0, character: 11}
+      active: {line: 0, character: 11}
+    - anchor: {line: 0, character: 12}
+      active: {line: 0, character: 12}

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/shellscript/changeEveryArgInsideTrap2.yml

@@ -0,0 +1,32 @@
+languageId: shellscript
+command:
+  version: 6
+  spokenForm: change every arg inside trap
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: t}
+      modifiers:
+        - type: everyScope
+          scopeType: {type: argumentOrParameter}
+        - {type: interiorOnly}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |
+    echo "Test $foo $bar"
+  selections:
+    - anchor: {line: 0, character: 14}
+      active: {line: 0, character: 14}
+  marks:
+    default.t:
+      start: {line: 0, character: 6}
+      end: {line: 0, character: 10}
+finalState:
+  documentContents: |
+    echo "Test  "
+  selections:
+    - anchor: {line: 0, character: 11}
+      active: {line: 0, character: 11}
+    - anchor: {line: 0, character: 12}
+      active: {line: 0, character: 12}

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/shellscript/changeKeyCrunch.yml

@@ -0,0 +1,33 @@
+languageId: shellscript
+command:
+  version: 6
+  spokenForm: change key crunch
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: k}
+      modifiers:
+        - type: containingScope
+          scopeType: {type: collectionKey}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |-
+    declare -A arr
+    arr["key1"]=val1
+    arr+=([key2]=val2 ["key3"]=val3)
+  selections:
+    - anchor: {line: 2, character: 17}
+      active: {line: 2, character: 17}
+  marks:
+    default.k:
+      start: {line: 2, character: 7}
+      end: {line: 2, character: 11}
+finalState:
+  documentContents: |-
+    declare -A arr
+    arr["key1"]=val1
+    arr+=([]=val2 ["key3"]=val3)
+  selections:
+    - anchor: {line: 2, character: 7}
+      active: {line: 2, character: 7}

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/shellscript/changeValueVest.yml

@@ -0,0 +1,33 @@
+languageId: shellscript
+command:
+  version: 6
+  spokenForm: change value vest
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: v}
+      modifiers:
+        - type: containingScope
+          scopeType: {type: value}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |-
+    declare -A arr
+    arr["key1"]=val1
+    arr+=([key2]=val2 ["key3"]=val3)
+  selections:
+    - anchor: {line: 2, character: 17}
+      active: {line: 2, character: 17}
+  marks:
+    default.v:
+      start: {line: 2, character: 13}
+      end: {line: 2, character: 17}
+finalState:
+  documentContents: |-
+    declare -A arr
+    arr["key1"]=val1
+    arr+=([key2]= ["key3"]=val3)
+  selections:
+    - anchor: {line: 2, character: 13}
+      active: {line: 2, character: 13}

queries/shellscript.scm

@@ -171,6 +171,23 @@
   ")" @_.interior.end.startOf
 ) @list @collectionItem.iteration
 
+;;!! FIXME: I will file an issue in tree-sitter-bash as I think the grammar is
+;;!! bad. But the below does work for now
+;;!! arr+=(["key2"]=val2 ["key3"]=val3)
+(array
+  (
+    (concatenation
+      ;; This matches the [ which is (word) for some reason
+      (_) @collectionKey.leading.start
+      (_) @collectionKey
+      ;; This matches the ] which is also (word) for some reason
+      (_) @collectionKey.trailing.end
+      (_) @value
+    ) @collectionItem
+    (#shrink-to-match! @value "\=(?<keep>.*)")
+  )
+)
+
 ;;
 ;; Strings
 ;;
@@ -183,27 +200,20 @@
 ;;!      ^^^^^
 (string) @string @textFragment
 
-;; TODO: These two cases are broken as they are a single (expression), and the " " isn't recognized
-;; echo "Foo ${BAR} ${BAZ}"
-;; echo "Foo $BAR $BAZ"
 ;;!! var="foo ${bar}"
 ;;!           ^^^^^^
 ;;!           xxxxxx
 (string
-  (expansion
-    "${" @argumentOrParameter.start.startOf
-    .
-    (_)
-    .
-    "}" @argumentOrParameter.end.endOf
+  (
+    (expansion) @argumentOrParameter
+    ;; FIXME: This is due to a tree-sitter-bash bug (imo) where given: "Foo ${BAR} ${BAZ}"
+    ;; ${BAZ} incorrectly includes preceding space
+    (#shrink-to-match! @argumentOrParameter "\\s*(?<keep>.*)")
   )
 )
 (string
-  (simple_expansion
-    "$" @argumentOrParameter.start.startOf
-    .
-    (_) @argumentOrParameter.end.endOf
-  )
+  (simple_expansion) @argumentOrParameter
+  (#shrink-to-match! @argumentOrParameter "\\s*(?<keep>.*)")
 )
 
 ;;
@@ -307,6 +317,19 @@
   (#not-parent-type? @dummy declaration_command)
 )
 
+;;!! local foo="bar"
+;;!            ^^^^^
+;;!           xxxxxx
+;;!  ---------------
+(declaration_command
+  "local" @_.domain.start.startOf
+  (variable_assignment
+    "=" @value.leading.start.startOf
+    .
+    value: (_) @value @value.leading.end.endOf
+  ) @_.domain.end.endOf
+)
+
 ;;!! for ((i = 1; i <= 5; i++)); do
 ;;!            ^
 ;;!         xxxx
@@ -322,13 +345,4 @@
   ) @_.domain
 )
 
-(declaration_command
-  "local" @_.domain.start.startOf
-  (variable_assignment
-    "=" @value.leading.start.startOf
-    .
-    value: (_) @value @value.leading.end.endOf
-  ) @_.domain.end.endOf
-)
-
 (regex) @regularExpression @textFragment