Add workspace symbols feature

Author: wkillerud

pkgs/sass_language_server/lib/src/language_server.dart

@@ -173,6 +173,7 @@ class LanguageServer {
           documentLinkProvider: DocumentLinkOptions(resolveProvider: false),
           documentSymbolProvider: Either2.t1(true),
           textDocumentSync: Either2.t1(TextDocumentSyncKind.Incremental),
+          workspaceSymbolProvider: Either2.t1(true),
         );
 
         var result = InitializeResult(capabilities: serverCapabilities);
@@ -285,6 +286,22 @@ class LanguageServer {
       _connection.peer
           .registerMethod('textDocument/documentSymbol', onDocumentSymbol);
 
+      // TODO: add this handler upstream
+      Future<List<WorkspaceSymbol>> onWorkspaceSymbol(dynamic params) async {
+        try {
+          var query =
+              (params.value as Map<String, Object?>)['query'] as String?;
+
+          var result = _ls.findWorkspaceSymbols(query);
+          return result;
+        } on Exception catch (e) {
+          _log.debug(e.toString());
+          return [];
+        }
+      }
+
+      _connection.peer.registerMethod('workspace/symbol', onWorkspaceSymbol);
+
       _connection.onShutdown(() async {
         await _socket?.close();
         exitCode = 0;

pkgs/sass_language_services/lib/src/configuration/language_configuration.dart

@@ -12,14 +12,21 @@ class DocumentLinksConfiguration extends FeatureConfiguration {
   DocumentLinksConfiguration({required super.enabled});
 }
 
+class WorkspaceSymbolsConfiguration extends FeatureConfiguration {
+  WorkspaceSymbolsConfiguration({required super.enabled});
+}
+
 class LanguageConfiguration {
   late final DocumentSymbolsConfiguration documentSymbols;
   late final DocumentLinksConfiguration documentLinks;
+  late final WorkspaceSymbolsConfiguration workspaceSymbols;
 
   LanguageConfiguration.from(dynamic config) {
     documentSymbols = DocumentSymbolsConfiguration(
         enabled: config?['documentSymbols']?['enabled'] as bool? ?? true);
     documentLinks = DocumentLinksConfiguration(
         enabled: config?['documentLinks']?['enabled'] as bool? ?? true);
+    workspaceSymbols = WorkspaceSymbolsConfiguration(
+        enabled: config?['workspaceSymbols']?['enabled'] as bool? ?? true);
   }
 }

pkgs/sass_language_services/lib/src/features/workspace_symbols/workspace_symbols_feature.dart

@@ -0,0 +1,33 @@
+import 'package:lsp_server/lsp_server.dart' as lsp;
+
+import '../language_feature.dart';
+
+class WorkspaceSymbolsFeature extends LanguageFeature {
+  WorkspaceSymbolsFeature({required super.ls});
+
+  List<lsp.WorkspaceSymbol> findWorkspaceSymbols(String? query) {
+    var result = <lsp.WorkspaceSymbol>[];
+    for (var document in ls.cache.getDocuments()) {
+      // This is the exception to the rule that this enabled check
+      // should happen at the server edge. It's only at this point
+      // we know if the document should be included or not.
+      var config = getLanguageConfiguration(document);
+      if (config.workspaceSymbols.enabled) {
+        var symbols = ls.findDocumentSymbols(document);
+        for (var symbol in symbols) {
+          if (query != null && !symbol.name.contains(query)) {
+            continue;
+          }
+
+          result.add(lsp.WorkspaceSymbol(
+              kind: symbol.kind,
+              location: lsp.Either2.t1(
+                  lsp.Location(range: symbol.range, uri: document.uri)),
+              name: symbol.name,
+              tags: symbol.tags));
+        }
+      }
+    }
+    return result;
+  }
+}

pkgs/sass_language_services/lib/src/language_services.dart

@@ -4,6 +4,7 @@ import 'package:sass_language_services/sass_language_services.dart';
 
 import 'features/document_links/document_links_feature.dart';
 import 'features/document_symbols/document_symbols_feature.dart';
+import 'features/workspace_symbols/workspace_symbols_feature.dart';
 import 'language_services_cache.dart';
 
 class LanguageServices {
@@ -16,13 +17,15 @@ class LanguageServices {
 
   late final DocumentLinksFeature _documentLinks;
   late final DocumentSymbolsFeature _documentSymbols;
+  late final WorkspaceSymbolsFeature _workspaceSymbols;
 
   LanguageServices({
     required this.clientCapabilities,
     required this.fs,
   }) : cache = LanguageServicesCache() {
     _documentLinks = DocumentLinksFeature(ls: this);
     _documentSymbols = DocumentSymbolsFeature(ls: this);
+    _workspaceSymbols = WorkspaceSymbolsFeature(ls: this);
   }
 
   void configure(LanguageServerConfiguration configuration) {
@@ -38,6 +41,10 @@ class LanguageServices {
     return _documentSymbols.findDocumentSymbols(document);
   }
 
+  List<lsp.WorkspaceSymbol> findWorkspaceSymbols(String? query) {
+    return _workspaceSymbols.findWorkspaceSymbols(query);
+  }
+
   sass.Stylesheet parseStylesheet(TextDocument document) {
     return cache.getStylesheet(document);
   }