Traverse additional nodes for global definitions

Author: skovhus

server/src/util/declarations.ts

@@ -13,11 +13,16 @@ const TREE_SITTER_TYPE_TO_LSP_KIND: { [type: string]: LSP.SymbolKind | undefined
 export type GlobalDeclarations = { [word: string]: LSP.SymbolInformation }
 export type Declarations = { [word: string]: LSP.SymbolInformation[] }
 
+const GLOBAL_DECLARATION_LEAF_NODE_TYPES = new Set([
+  'if_statement',
+  'function_definition',
+])
+
 /**
  * Returns declarations (functions or variables) from a given root node
  * that would be available after sourcing the file. This currently does
- * not include global variables defined inside function as we do not do
- * any flow tracing.
+ * not include global variables defined inside if statements or functions
+ * as we do not do any flow tracing.
  *
  * Will only return one declaration per symbol name – the latest definition.
  * This behavior is consistent with how Bash behaves, but differs between
@@ -39,7 +44,11 @@ export function getGlobalDeclarations({
   const diagnostics: LSP.Diagnostic[] = []
   const globalDeclarations: GlobalDeclarations = {}
 
-  tree.rootNode.children.forEach((node) => {
+  TreeSitterUtil.forEach(tree.rootNode, (node) => {
+    const followChildren = !GLOBAL_DECLARATION_LEAF_NODE_TYPES.has(node.type)
+
+    // TODO: is there really a need for this error
+    // Rather weird that this is here.
     if (node.type === 'ERROR') {
       diagnostics.push(
         LSP.Diagnostic.create(
@@ -50,7 +59,6 @@ export function getGlobalDeclarations({
           'bash-language-server',
         ),
       )
-      return
     }
 
     if (TreeSitterUtil.isDefinition(node)) {
@@ -61,6 +69,8 @@ export function getGlobalDeclarations({
         globalDeclarations[word] = symbol
       }
     }
+
+    return followChildren
   })
 
   return { diagnostics, globalDeclarations }

server/src/util/tree-sitter.ts

@@ -1,10 +1,16 @@
 import { Range } from 'vscode-languageserver/node'
 import { SyntaxNode } from 'web-tree-sitter'
 
-export function forEach(node: SyntaxNode, cb: (n: SyntaxNode) => void) {
-  cb(node)
-  if (node.children.length) {
-    node.children.forEach((n) => forEach(n, cb))
+/**
+ * Recursively iterate over all nodes in a tree.
+ *
+ * @param node The node to start iterating from
+ * @param callback The callback to call for each node. Return false to stop following children.
+ */
+export function forEach(node: SyntaxNode, callback: (n: SyntaxNode) => void | boolean) {
+  const followChildren = callback(node) !== false
+  if (followChildren && node.children.length) {
+    node.children.forEach((n) => forEach(n, callback))
   }
 }