Rename configuration option

Author: skovhus

server/src/__tests__/analyzer.test.ts

@@ -296,14 +296,14 @@ describe('commandNameAtPoint', () => {
 })
 
 describe('findSymbolsMatchingWord', () => {
-  it('return a list of symbols across the workspace when isSourcingAware is false', async () => {
+  it('return a list of symbols across the workspace when includeAllWorkspaceSymbols is true', async () => {
     const parser = await initializeParser()
     const connection = getMockConnection()
 
     const analyzer = new Analyzer({
       console: connection.console,
       parser,
-      isSourcingAware: false,
+      includeAllWorkspaceSymbols: true,
       workspaceFolder: FIXTURE_FOLDER,
     })
     await analyzer.initiateBackgroundAnalysis({
@@ -421,14 +421,14 @@ describe('findSymbolsMatchingWord', () => {
     `)
   })
 
-  it('return a list of symbols accessible to the uri when isSourcingAware is true', async () => {
+  it('return a list of symbols accessible to the uri when includeAllWorkspaceSymbols is false', async () => {
     const parser = await initializeParser()
     const connection = getMockConnection()
 
     const analyzer = new Analyzer({
       console: connection.console,
       parser,
-      isSourcingAware: true,
+      includeAllWorkspaceSymbols: false,
       workspaceFolder: FIXTURE_FOLDER,
     })
     await analyzer.initiateBackgroundAnalysis({

server/src/__tests__/config.test.ts

@@ -1,34 +1,37 @@
 import { ConfigSchema, getConfigFromEnvironmentVariables } from '../config'
 
 describe('ConfigSchema', () => {
-  it('parses an object', () => {
+  it('returns a default', () => {
     expect(ConfigSchema.parse({})).toMatchInlineSnapshot(`
       Object {
         "backgroundAnalysisMaxFiles": 500,
-        "completionBasedOnImports": true,
         "explainshellEndpoint": "",
         "globPattern": "**/*@(.sh|.inc|.bash|.command)",
         "highlightParsingErrors": false,
+        "includeAllWorkspaceSymbols": false,
         "shellcheckArguments": Array [],
         "shellcheckPath": "shellcheck",
       }
     `)
+  })
+  it('parses an object', () => {
     expect(
       ConfigSchema.parse({
         backgroundAnalysisMaxFiles: 1,
         explainshellEndpoint: 'localhost:8080',
         globPattern: '**/*@(.sh)',
         highlightParsingErrors: true,
+        includeAllWorkspaceSymbols: true,
         shellcheckArguments: ' -e SC2001  -e SC2002 ',
         shellcheckPath: '',
       }),
     ).toMatchInlineSnapshot(`
       Object {
         "backgroundAnalysisMaxFiles": 1,
-        "completionBasedOnImports": true,
         "explainshellEndpoint": "localhost:8080",
         "globPattern": "**/*@(.sh)",
         "highlightParsingErrors": true,
+        "includeAllWorkspaceSymbols": true,
         "shellcheckArguments": Array [
           "-e",
           "SC2001",

server/src/analyser.ts

@@ -45,22 +45,22 @@ export default class Analyzer {
     variable_assignment: LSP.SymbolKind.Variable,
   }
 
-  private isSourcingAware: boolean
+  private includeAllWorkspaceSymbols: boolean
   private workspaceFolder: string | null
 
   public constructor({
     console,
-    isSourcingAware = true,
+    includeAllWorkspaceSymbols = false,
     parser,
     workspaceFolder,
   }: {
     console: LSP.RemoteConsole
-    isSourcingAware?: boolean
+    includeAllWorkspaceSymbols?: boolean
     parser: Parser
     workspaceFolder: string | null
   }) {
     this.console = console
-    this.isSourcingAware = isSourcingAware
+    this.includeAllWorkspaceSymbols = includeAllWorkspaceSymbols
     this.parser = parser
     this.workspaceFolder = workspaceFolder
   }
@@ -564,14 +564,14 @@ export default class Analyzer {
     )
   }
 
-  public setIsSourcingAware(isSourcingAware: boolean): void {
-    this.isSourcingAware = isSourcingAware
+  public setIncludeAllWorkspaceSymbols(includeAllWorkspaceSymbols: boolean): void {
+    this.includeAllWorkspaceSymbols = includeAllWorkspaceSymbols
   }
 
   private getReachableUriToDeclarations({
     uri: fromUri,
   }: { uri?: string } = {}): FileDeclarations {
-    if (!fromUri || !this.isSourcingAware) {
+    if (!fromUri || this.includeAllWorkspaceSymbols) {
       return this.uriToDeclarations
     }
 

server/src/config.ts

@@ -2,10 +2,6 @@ import { z } from 'zod'
 
 export const ConfigSchema = z
   .object({
-    // Controls if completions are based only on analyzing the import/sourcing of files.
-    // If false, completion will be based on all files in the workspace.
-    completionBasedOnImports: z.boolean().default(true),
-
     // Maximum number of files to analyze in the background. Set to 0 to disable background analysis.
     backgroundAnalysisMaxFiles: z.number().int().min(0).default(500),
 
@@ -19,6 +15,11 @@ export const ConfigSchema = z
     // Controls if Treesitter parsing errors will be highlighted as problems.
     highlightParsingErrors: z.boolean().default(false),
 
+    // Controls how symbols (e.g. variables and functions) are included and used for completion and documentation.
+    // If false, then we only include symbols from sourced files (i.e. using non dynamic statements like 'source file.sh' or '. file.sh').
+    // If true, then all symbols from the workspace are included.
+    includeAllWorkspaceSymbols: z.boolean().default(false),
+
     // Additional ShellCheck arguments. Note that we already add the following arguments: --shell, --format, --external-sources."
     shellcheckArguments: z
       .preprocess((arg) => {
@@ -48,10 +49,10 @@ export function getConfigFromEnvironmentVariables(): {
 } {
   const rawConfig = {
     backgroundAnalysisMaxFiles: process.env.BACKGROUND_ANALYSIS_MAX_FILES,
-    completionBasedOnImports: toBoolean(process.env.COMPLETION_BASED_ON_IMPORTS),
     explainshellEndpoint: process.env.EXPLAINSHELL_ENDPOINT,
     globPattern: process.env.GLOB_PATTERN,
     highlightParsingErrors: toBoolean(process.env.HIGHLIGHT_PARSING_ERRORS),
+    includeAllWorkspaceSymbols: toBoolean(process.env.INCLUDE_ALL_WORKSPACE_SYMBOLS),
     shellcheckArguments: process.env.SHELLCHECK_ARGUMENTS,
     shellcheckPath: process.env.SHELLCHECK_PATH,
   }

server/src/server.ts

@@ -227,7 +227,9 @@ export default class BashServer {
             })
           }
 
-          this.analyzer.setIsSourcingAware(this.config.completionBasedOnImports)
+          this.analyzer.setIncludeAllWorkspaceSymbols(
+            this.config.includeAllWorkspaceSymbols,
+          )
 
           return true
         }

vscode-client/package.json

@@ -37,11 +37,6 @@
           "description": "Maximum number of files to analyze in the background. Set to 0 to disable background analysis.",
           "minimum": 0
         },
-        "bashIde.completionBasedOnImports": {
-          "type": "boolean",
-          "default": true,
-          "description": "Controls if symbols completion across files is based on parsing sourcing statements (i.e. 'source file.sh' or '. file.sh'). If false then all symbols found in the workspace will be used."
-        },
         "bashIde.explainshellEndpoint": {
           "type": "string",
           "default": "",
@@ -57,6 +52,11 @@
           "default": false,
           "description": "Controls if Treesitter parsing errors will be highlighted as problems."
         },
+        "bashIde.includeAllWorkspaceSymbols": {
+          "type": "boolean",
+          "default": false,
+          "description": "Controls how symbols (e.g. variables and functions) are included and used for completion and documentation. If false (default and recommended), then we only include symbols from sourced files (i.e. using non dynamic statements like 'source file.sh' or '. file.sh'). If true, then all symbols from the workspace are included."
+        },
         "bashIde.shellcheckPath": {
           "type": "string",
           "default": "shellcheck",