feat: add a way to add excludes to workspace symbol search (eg to exclude node_modules for source search only, also improves performance)

Author: zardoy

src/configurationType.ts

@@ -199,6 +199,16 @@ export type Configuration = {
      * @default []
      */
     additionalIncludeExtensions: string[]
+    /**
+     * Patterns to exclude from workspace symbol search
+     * Example: `["**\/node_modules/**"]`
+     * Can gradually improve performance, will be set to node_modules by default in future
+     * @uniqueItems true
+     * @default []
+     * @defaultTODO ["**\/node_modules/**"]
+     */
+    // TODO enable node_modules default when cancellationToken is properly used
+    workspaceSymbolSearchExcludePatterns: string[]
     /**
      * @default ["fixMissingFunctionDeclaration"]
      * @uniqueItems true

typescript/src/decorateProxy.ts

@@ -11,6 +11,7 @@ import decorateDocumentHighlights from './documentHighlights'
 import completionEntryDetails from './completionEntryDetails'
 import { GetConfig } from './types'
 import lodashGet from 'lodash.get'
+import decorateWorkspaceSymbolSearch from './workspaceSymbolSearch'
 
 /** @internal */
 export const thisPluginMarker = '__essentialPluginsMarker__'
@@ -107,6 +108,7 @@ export const decorateLanguageService = (
     decorateDefinitions(proxy, info, c)
     decorateReferences(proxy, languageService, c)
     decorateDocumentHighlights(proxy, languageService, c)
+    decorateWorkspaceSymbolSearch(proxy, languageService, c, languageServiceHost)
 
     if (pluginSpecificSyntaxServerConfigCheck) {
         if (!__WEB__) {

typescript/src/workspaceSymbolSearch.ts

@@ -0,0 +1,33 @@
+import { GetConfig } from './types'
+
+export default (proxy: ts.LanguageService, languageService: ts.LanguageService, c: GetConfig, languageServiceHost: ts.LanguageServiceHost) => {
+    proxy.getNavigateToItems = (searchValue, maxResultCount, fileName, excludeDtsFiles) => {
+        const workspaceSymbolSearchExcludePatterns = c('workspaceSymbolSearchExcludePatterns')
+        if (!workspaceSymbolSearchExcludePatterns.length) {
+            return languageService.getNavigateToItems(searchValue, maxResultCount, fileName, excludeDtsFiles)
+        }
+
+        const program = languageService.getProgram()!
+        const cancellationToken = languageServiceHost.getCompilerHost?.()?.getCancellationToken?.() ?? {
+            isCancellationRequested: () => false,
+            throwIfCancellationRequested: () => {},
+        }
+        let sourceFiles = fileName ? [program.getSourceFile(fileName)!] : program.getSourceFiles()
+        if (!fileName) {
+            const excludes = tsFull.getRegularExpressionForWildcard(workspaceSymbolSearchExcludePatterns, '', 'exclude')?.slice(1)
+            if (excludes) {
+                const re = new RegExp(excludes)
+                sourceFiles = sourceFiles.filter(x => !re.test(x.fileName))
+            }
+        }
+        return tsFull.NavigateTo.getNavigateToItems(
+            sourceFiles as any,
+            program.getTypeChecker() as any,
+            // TODO! use real cancellationToken
+            cancellationToken,
+            searchValue,
+            maxResultCount,
+            excludeDtsFiles ?? false,
+        )
+    }
+}