Ignore sourcing like statements in heredoc and raw strings

Author: skovhus

Diff for: server/src/analyser.ts

@@ -360,6 +360,7 @@ export default class Analyzer {
       fileContent: contents,
       fileUri: uri,
       rootPath: this.workspaceFolder,
+      tree,
     })
 
     const problems: LSP.Diagnostic[] = []

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

@@ -1,28 +1,37 @@
+import * as fs from 'fs'
 import * as os from 'os'
+import * as Parser from 'web-tree-sitter'
 
+import { initializeParser } from '../../parser'
 import { getSourcedUris } from '../sourcing'
 
 const fileDirectory = '/Users/bash'
 const fileUri = `${fileDirectory}/file.sh`
 
-// mock fs.existsSync to always return true
-jest.mock('fs', () => ({
-  existsSync: () => true,
-}))
+let parser: Parser
+beforeAll(async () => {
+  parser = await initializeParser()
+})
+
+jest.spyOn(fs, 'existsSync').mockImplementation(() => true)
 
 // mock os.homedir() to return a fixed path
 jest.spyOn(os, 'homedir').mockImplementation(() => '/Users/bash-user')
 
 describe('getSourcedUris', () => {
   it('returns an empty set if no files were sourced', () => {
-    const result = getSourcedUris({ fileContent: '', fileUri, rootPath: null })
+    const fileContent = ''
+    const result = getSourcedUris({
+      fileContent,
+      fileUri,
+      rootPath: null,
+      tree: parser.parse(fileContent),
+    })
     expect(result).toEqual(new Set([]))
   })
 
   it('returns a set of sourced files', () => {
-    const result = getSourcedUris({
-      fileContent: `
-
+    const fileContent = `
       source file-in-path.sh # does not contain a slash (i.e. is maybe somewhere on the path)
 
       source /bin/extension.inc # absolute path
@@ -41,9 +50,34 @@ describe('getSourcedUris', () => {
 
       # conditional is currently not supported
       if [[ -z $__COMPLETION_LIB_LOADED ]]; then source "$LIBPATH" ; fi
-    `,
+
+      show ()
+      {
+        about 'Shows SVN proxy settings'
+        group 'proxy'
+
+        echo "SVN Proxy Settings"
+        echo "=================="
+        python2 - <<END
+      import ConfigParser
+      source ./this-should-be-ignored.sh
+      END
+      }
+
+      cat $f | python -c '
+      import sys
+      source also-ignore.sh
+      ' | sort > $counts_file
+        fi
+      done
+
+    `
+
+    const result = getSourcedUris({
+      fileContent,
       fileUri,
       rootPath: null,
+      tree: parser.parse(fileContent),
     })
 
     expect(result).toMatchInlineSnapshot(`

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

@@ -6,7 +6,8 @@ import * as Parser from 'web-tree-sitter'
 import { untildify } from './fs'
 
 // Until the grammar supports sourcing, we use this little regular expression
-const SOURCED_FILES_REG_EXP = /^(?:\t|[ ])*(?:source|[.])\s*(\S*)/gm
+const SOURCING_STATEMENTS = /^(?:\t|[ ])*(?:source|[.])\s*(\S*)/
+const SOURCING_COMMANDS = ['source', '.']
 
 /**
  * Analysis the given file content and returns a set of URIs that are
@@ -16,22 +17,37 @@ export function getSourcedUris({
   fileContent,
   fileUri,
   rootPath,
+  tree,
 }: {
   fileContent: string
   fileUri: string
   rootPath: string | null
+  tree: Parser.Tree
 }): Set<string> {
   const uris: Set<string> = new Set([])
-  let match: RegExpExecArray | null
   const rootPaths = [path.dirname(fileUri), rootPath].filter(Boolean) as string[]
 
-  while ((match = SOURCED_FILES_REG_EXP.exec(fileContent)) !== null) {
-    const word = match[1]
-    const sourcedUri = getSourcedUri({ rootPaths, word })
-    if (sourcedUri) {
-      uris.add(sourcedUri)
+  fileContent.split(/\r?\n/).forEach((line, lineIndex) => {
+    const match = line.match(SOURCING_STATEMENTS)
+    if (match) {
+      const [statement, word] = match
+
+      if (tree.rootNode) {
+        const node = tree.rootNode.descendantForPosition({
+          row: lineIndex,
+          column: statement.length - 2,
+        })
+        if (['heredoc_body', 'raw_string'].includes(node?.type)) {
+          return
+        }
+      }
+
+      const sourcedUri = getSourcedUri({ rootPaths, word })
+      if (sourcedUri) {
+        uris.add(sourcedUri)
+      }
     }
-  }
+  })
 
   return uris
 }
@@ -67,7 +83,7 @@ export function getSourcedLocation({
     }
 
     const isSourced = node.previousNamedSibling
-      ? ['.', 'source'].includes(node.previousNamedSibling.text.trim())
+      ? SOURCING_COMMANDS.includes(node.previousNamedSibling.text.trim())
       : false
 
     const rootPaths = [path.dirname(uri), rootPath].filter(Boolean) as string[]