Support variables defined using the : command

Author: skovhus

Diff for: server/src/__tests__/__snapshots__/analyzer.test.ts.snap

@@ -934,5 +934,22 @@ Array [
     },
     "name": "ret",
   },
+  Object {
+    "kind": 13,
+    "location": Object {
+      "range": Object {
+        "end": Object {
+          "character": 24,
+          "line": 273,
+        },
+        "start": Object {
+          "character": 5,
+          "line": 273,
+        },
+      },
+      "uri": "dummy-uri.sh",
+    },
+    "name": "FILE_PATH_EXPANSION",
+  },
 ]
 `;

Diff for: server/src/__tests__/analyzer.test.ts

@@ -979,6 +979,23 @@ describe('getAllVariables', () => {
           },
           "name": "RESET",
         },
+        Object {
+          "kind": 13,
+          "location": Object {
+            "range": Object {
+              "end": Object {
+                "character": 14,
+                "line": 25,
+              },
+              "start": Object {
+                "character": 5,
+                "line": 25,
+              },
+            },
+            "uri": "file://__REPO_ROOT_FOLDER__/testing/fixtures/extension.inc",
+          },
+          "name": "FILE_PATH",
+        },
       ]
     `)
   })

Diff for: server/src/__tests__/server.test.ts

@@ -560,61 +560,72 @@ describe('server', () => {
 
       // they are all variables
       expect(result).toMatchInlineSnapshot(`
-              Array [
-                Object {
-                  "data": Object {
-                    "type": 3,
-                  },
-                  "documentation": undefined,
-                  "kind": 6,
-                  "label": "BOLD",
-                },
-                Object {
-                  "data": Object {
-                    "type": 3,
-                  },
-                  "documentation": Object {
-                    "kind": "markdown",
-                    "value": "Variable: **RED** - *defined in extension.inc*",
-                  },
-                  "kind": 6,
-                  "label": "RED",
-                },
-                Object {
-                  "data": Object {
-                    "type": 3,
-                  },
-                  "documentation": Object {
-                    "kind": "markdown",
-                    "value": "Variable: **GREEN** - *defined in extension.inc*",
-                  },
-                  "kind": 6,
-                  "label": "GREEN",
-                },
-                Object {
-                  "data": Object {
-                    "type": 3,
-                  },
-                  "documentation": Object {
-                    "kind": "markdown",
-                    "value": "Variable: **BLUE** - *defined in extension.inc*",
-                  },
-                  "kind": 6,
-                  "label": "BLUE",
-                },
-                Object {
-                  "data": Object {
-                    "type": 3,
-                  },
-                  "documentation": Object {
-                    "kind": "markdown",
-                    "value": "Variable: **RESET** - *defined in extension.inc*",
-                  },
-                  "kind": 6,
-                  "label": "RESET",
-                },
-              ]
-          `)
+        Array [
+          Object {
+            "data": Object {
+              "type": 3,
+            },
+            "documentation": undefined,
+            "kind": 6,
+            "label": "BOLD",
+          },
+          Object {
+            "data": Object {
+              "type": 3,
+            },
+            "documentation": Object {
+              "kind": "markdown",
+              "value": "Variable: **RED** - *defined in extension.inc*",
+            },
+            "kind": 6,
+            "label": "RED",
+          },
+          Object {
+            "data": Object {
+              "type": 3,
+            },
+            "documentation": Object {
+              "kind": "markdown",
+              "value": "Variable: **GREEN** - *defined in extension.inc*",
+            },
+            "kind": 6,
+            "label": "GREEN",
+          },
+          Object {
+            "data": Object {
+              "type": 3,
+            },
+            "documentation": Object {
+              "kind": "markdown",
+              "value": "Variable: **BLUE** - *defined in extension.inc*",
+            },
+            "kind": 6,
+            "label": "BLUE",
+          },
+          Object {
+            "data": Object {
+              "type": 3,
+            },
+            "documentation": Object {
+              "kind": "markdown",
+              "value": "Variable: **RESET** - *defined in extension.inc*",
+            },
+            "kind": 6,
+            "label": "RESET",
+          },
+          Object {
+            "data": Object {
+              "type": 3,
+            },
+            "documentation": Object {
+              "kind": "markdown",
+              "value": "Variable: **FILE_PATH** - *defined in extension.inc*",
+            },
+            "kind": 6,
+            "label": "FILE_PATH",
+          },
+        ]
+      `)
     })
   })
 

Diff for: server/src/util/declarations.ts

@@ -43,12 +43,10 @@ export function getGlobalDeclarations({
   TreeSitterUtil.forEach(tree.rootNode, (node) => {
     const followChildren = !GLOBAL_DECLARATION_LEAF_NODE_TYPES.has(node.type)
 
-    if (TreeSitterUtil.isDefinition(node)) {
-      const symbol = nodeToSymbolInformation({ node, uri })
-      if (symbol) {
-        const word = symbol.name
-        globalDeclarations[word] = symbol
-      }
+    const symbol = getDeclarationSymbolFromNode({ node, uri })
+    if (symbol) {
+      const word = symbol.name
+      globalDeclarations[word] = symbol
     }
 
     return followChildren
@@ -71,15 +69,10 @@ export function getAllDeclarationsInTree({
   const symbols: LSP.SymbolInformation[] = []
 
   TreeSitterUtil.forEach(tree.rootNode, (node) => {
-    if (TreeSitterUtil.isDefinition(node)) {
-      const symbol = nodeToSymbolInformation({ node, uri })
-
-      if (symbol) {
-        symbols.push(symbol)
-      }
+    const symbol = getDeclarationSymbolFromNode({ node, uri })
+    if (symbol) {
+      symbols.push(symbol)
     }
-
-    return
   })
 
   return symbols
@@ -122,8 +115,6 @@ export function getLocalDeclarations({
               uri,
             })
           }
-        } else if (TreeSitterUtil.isDefinition(childNode)) {
-          symbol = nodeToSymbolInformation({ node: childNode, uri })
         } else if (childNode.type === 'for_statement') {
           const variableNode = childNode.child(1)
           if (variableNode && variableNode.type === 'variable_name') {
@@ -134,6 +125,8 @@ export function getLocalDeclarations({
               uri,
             )
           }
+        } else {
+          symbol = getDeclarationSymbolFromNode({ node: childNode, uri })
         }
 
         if (symbol) {
@@ -222,3 +215,33 @@ function nodeToSymbolInformation({
     containerName,
   )
 }
+
+function getDeclarationSymbolFromNode({
+  node,
+  uri,
+}: {
+  node: Parser.SyntaxNode
+  uri: string
+}): LSP.SymbolInformation | null {
+  if (TreeSitterUtil.isDefinition(node)) {
+    return nodeToSymbolInformation({ node, uri })
+  } else if (node.type === 'command' && node.text.startsWith(': ')) {
+    // : does argument expansion and retains the side effects.
+    // A common usage is to define default values of environment variables, e.g. : "${VARIABLE:="default"}".
+    const variableNode = node.namedChildren
+      .find((c) => c.type === 'string')
+      ?.namedChildren.find((c) => c.type === 'expansion')
+      ?.namedChildren.find((c) => c.type === 'variable_name')
+
+    if (variableNode) {
+      return LSP.SymbolInformation.create(
+        variableNode.text,
+        LSP.SymbolKind.Variable,
+        TreeSitterUtil.range(variableNode),
+        uri,
+      )
+    }
+  }
+
+  return null
+}