feat: workspace symbols support (#2769)

#2375.
Adding support in the Svelte language server so that you don't need to open ts/js files to use this feature. You can trigger this feature with Ctrl + T and search for symbol names. Some of the handling is also synced to the typescript-plugin so that it's more consistent, which also means vscode can better deduplicate the results from both tsserver and Svelte language server.

Author: jasonlyu123

packages/language-server/README.md

@@ -135,6 +135,10 @@ Enable signature help (parameter hints) for JS/TS. _Default_: `true`
 
 Enable semantic tokens (semantic highlight) for TypeScript. _Default_: `true`
 
+#### `svelte.plugin.typescript.workspaceSymbols.enable`
+
+Enable workspace symbols for TypeScript. You can disable this if the language server client you're using doesn't deduplicate results from the TSServer. _Default_: `true`.
+
 ##### `svelte.plugin.css.enable`
 
 Enable the CSS plugin. _Default_: `true`

packages/language-server/src/ls-config.ts

@@ -21,7 +21,8 @@ const defaultLSConfig: LSConfig = {
         codeActions: { enable: true },
         selectionRange: { enable: true },
         signatureHelp: { enable: true },
-        semanticTokens: { enable: true }
+        semanticTokens: { enable: true },
+        workspaceSymbols: { enable: true }
     },
     css: {
         enable: true,
@@ -105,6 +106,9 @@ export interface LSTypescriptConfig {
     semanticTokens: {
         enable: boolean;
     };
+    workspaceSymbols: {
+        enable: boolean;
+    };
 }
 
 export interface LSCSSConfig {
@@ -205,6 +209,7 @@ export interface TSUserConfig {
     inlayHints?: TsInlayHintsConfig;
     referencesCodeLens?: TsReferenceCodeLensConfig;
     implementationsCodeLens?: TsImplementationCodeLensConfig;
+    workspaceSymbols?: TsWorkspaceSymbolsConfig;
 }
 
 /**
@@ -280,6 +285,10 @@ export interface TsImplementationCodeLensConfig {
     showOnInterfaceMethods?: boolean | undefined;
 }
 
+export interface TsWorkspaceSymbolsConfig {
+    excludeLibrarySymbols?: boolean;
+}
+
 export type TsUserConfigLang = 'typescript' | 'javascript';
 
 /**
@@ -509,7 +518,9 @@ export class LSConfigManager {
             organizeImportsTypeOrder: this.withDefaultAsUndefined(
                 config.preferences?.organizeImports?.typeOrder,
                 'auto'
-            )
+            ),
+
+            excludeLibrarySymbolsInNavTo: config.workspaceSymbols?.excludeLibrarySymbols ?? true
         };
     }
 

packages/language-server/src/plugins/PluginHost.ts

@@ -34,7 +34,8 @@ import {
     TextDocumentIdentifier,
     TextEdit,
     WorkspaceEdit,
-    InlayHint
+    InlayHint,
+    WorkspaceSymbol
 } from 'vscode-languageserver';
 import { DocumentManager, getNodeIfIsInHTMLStartTag } from '../lib/documents';
 import { Logger } from '../logger';
@@ -697,6 +698,18 @@ export class PluginHost implements LSProvider, OnWatchFileChanges {
         );
     }
 
+    async getWorkspaceSymbols(
+        query: string,
+        token: CancellationToken
+    ): Promise<WorkspaceSymbol[] | null> {
+        return await this.execute<WorkspaceSymbol[]>(
+            'getWorkspaceSymbols',
+            [query, token],
+            ExecuteMode.FirstNonNull,
+            'high'
+        );
+    }
+
     onWatchFileChanges(onWatchFileChangesParas: OnWatchFileChangesPara[]): void {
         for (const support of this.plugins) {
             support.onWatchFileChanges?.(onWatchFileChangesParas);

packages/language-server/src/plugins/interfaces.ts

@@ -35,7 +35,8 @@ import {
     SymbolInformation,
     TextDocumentIdentifier,
     TextEdit,
-    WorkspaceEdit
+    WorkspaceEdit,
+    WorkspaceSymbol
 } from 'vscode-languageserver-types';
 import { Document } from '../lib/documents';
 
@@ -251,6 +252,13 @@ export interface DocumentHighlightProvider {
     ): Resolvable<DocumentHighlight[] | null>;
 }
 
+export interface WorkspaceSymbolsProvider {
+    getWorkspaceSymbols(
+        query: string,
+        cancellationToken?: CancellationToken
+    ): Resolvable<WorkspaceSymbol[] | null>;
+}
+
 export interface OnWatchFileChanges {
     onWatchFileChanges(onWatchFileChangesParas: OnWatchFileChangesPara[]): void;
 }
@@ -282,7 +290,8 @@ type ProviderBase = DiagnosticsProvider &
     CallHierarchyProvider &
     FoldingRangeProvider &
     CodeLensProvider &
-    DocumentHighlightProvider;
+    DocumentHighlightProvider &
+    WorkspaceSymbolsProvider;
 
 export type LSProvider = ProviderBase & BackwardsCompatibleDefinitionsProvider;
 

packages/language-server/src/plugins/typescript/SnapshotManager.ts

@@ -290,6 +290,16 @@ export class SnapshotManager {
         }
     }
 
+    allFilesAreJsOrDts() {
+        for (const doc of this.documents.values()) {
+            if (doc.scriptKind === ts.ScriptKind.TS || doc.scriptKind === ts.ScriptKind.TSX) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
     dispose() {
         this.globalSnapshotsManager.removeChangeListener(this.onSnapshotChange);
     }

packages/language-server/src/plugins/typescript/TypeScriptPlugin.ts

@@ -28,7 +28,8 @@ import {
     SymbolInformation,
     SymbolKind,
     TextDocumentContentChangeEvent,
-    WorkspaceEdit
+    WorkspaceEdit,
+    WorkspaceSymbol
 } from 'vscode-languageserver';
 import {
     Document,
@@ -65,7 +66,8 @@ import {
     SignatureHelpProvider,
     TypeDefinitionProvider,
     UpdateImportsProvider,
-    UpdateTsOrJsFile
+    UpdateTsOrJsFile,
+    WorkspaceSymbolsProvider
 } from '../interfaces';
 import { LSAndTSDocResolver } from './LSAndTSDocResolver';
 import { ignoredBuildDirectories } from './SnapshotManager';
@@ -103,6 +105,7 @@ import {
 } from './utils';
 import { CallHierarchyProviderImpl } from './features/CallHierarchyProvider';
 import { CodeLensProviderImpl } from './features/CodeLensProvider';
+import { WorkspaceSymbolsProviderImpl } from './features/WorkspaceSymbolProvider';
 
 export class TypeScriptPlugin
     implements
@@ -126,6 +129,7 @@ export class TypeScriptPlugin
         CallHierarchyProvider,
         FoldingRangeProvider,
         CodeLensProvider,
+        WorkspaceSymbolsProvider,
         OnWatchFileChanges,
         CompletionsProvider<CompletionResolveInfo>,
         UpdateTsOrJsFile
@@ -154,6 +158,7 @@ export class TypeScriptPlugin
     private readonly callHierarchyProvider: CallHierarchyProviderImpl;
     private readonly codLensProvider: CodeLensProviderImpl;
     private readonly documentHeightProvider: DocumentHighlightProviderImpl;
+    private readonly workspaceSymbolsProvider: WorkspaceSymbolsProvider;
 
     constructor(
         configManager: LSConfigManager,
@@ -214,6 +219,10 @@ export class TypeScriptPlugin
             this.configManager
         );
         this.documentHeightProvider = new DocumentHighlightProviderImpl(this.lsAndTsDocResolver);
+        this.workspaceSymbolsProvider = new WorkspaceSymbolsProviderImpl(
+            this.lsAndTsDocResolver,
+            configManager
+        );
     }
 
     async getDiagnostics(
@@ -701,6 +710,16 @@ export class TypeScriptPlugin
         return this.documentHeightProvider.findDocumentHighlight(document, position);
     }
 
+    async getWorkspaceSymbols(
+        query: string,
+        cancellationToken?: CancellationToken
+    ): Promise<WorkspaceSymbol[] | null> {
+        if (!this.featureEnabled('workspaceSymbols')) {
+            return null;
+        }
+        return this.workspaceSymbolsProvider.getWorkspaceSymbols(query, cancellationToken);
+    }
+
     private featureEnabled(feature: keyof LSTypescriptConfig) {
         return (
             this.configManager.enabled('typescript.enable') &&