refactor: dry up scoped symbols

wkillerud · wkillerud · commit 41233e1c028f · 2025-01-11T21:42:48.000+01:00
diff --git a/pkgs/sass_language_services/lib/sass_language_services.dart b/pkgs/sass_language_services/lib/sass_language_services.dart
@@ -23,4 +23,5 @@ export 'src/file_system_provider.dart'
 export 'src/language_services.dart' show LanguageServices;
 
 export 'src/features/document_links/stylesheet_document_link.dart';
+export 'src/features/document_symbols/scoped_symbols.dart';
 export 'src/features/document_symbols/stylesheet_document_symbol.dart';
diff --git a/pkgs/sass_language_services/lib/src/features/document_highlights/document_highlights_feature.dart b/pkgs/sass_language_services/lib/src/features/document_highlights/document_highlights_feature.dart
@@ -3,8 +3,6 @@ import 'package:sass_api/sass_api.dart' as sass;
 import 'package:sass_language_services/sass_language_services.dart';
 import 'package:sass_language_services/src/features/find_references/find_references_visitor.dart';
 
-import '../go_to_definition/scope_visitor.dart';
-import '../go_to_definition/scoped_symbols.dart';
 import '../language_feature.dart';
 import '../node_at_offset_visitor.dart';
 
@@ -28,12 +26,7 @@ class DocumentHighlightsFeature extends LanguageFeature {
     }
     var kind = getNodeReferenceKind(node);
 
-    var symbols = ls.cache.getDocumentSymbols(document) ??
-        ScopedSymbols(
-          stylesheet,
-          document.languageId == 'sass' ? Dialect.indented : Dialect.scss,
-        );
-    ls.cache.setDocumentSymbols(document, symbols);
+    var symbols = ls.getScopedSymbols(document);
 
     var symbol = symbols.findSymbolFromNode(node);
 
diff --git a/pkgs/sass_language_services/lib/src/features/document_symbols/document_symbols_feature.dart b/pkgs/sass_language_services/lib/src/features/document_symbols/document_symbols_feature.dart
@@ -14,4 +14,17 @@ class DocumentSymbolsFeature extends LanguageFeature {
 
     return symbolsVisitor.symbols;
   }
+
+  ScopedSymbols getScopedSymbols(TextDocument document) {
+    var stylesheet = ls.parseStylesheet(document);
+
+    var symbols = ls.cache.getScopedSymbols(document) ??
+        ScopedSymbols(
+          stylesheet,
+          document.languageId == 'sass' ? Dialect.indented : Dialect.scss,
+        );
+    ls.cache.setScopedSymbols(document, symbols);
+
+    return symbols;
+  }
 }
diff --git a/pkgs/sass_language_services/lib/src/features/document_symbols/scope.dart b/pkgs/sass_language_services/lib/src/features/document_symbols/scope.dart
@@ -1,4 +1,4 @@
-import '../document_symbols/stylesheet_document_symbol.dart';
+import 'stylesheet_document_symbol.dart';
 
 class Scope {
   Scope? parent;
diff --git a/pkgs/sass_language_services/lib/src/features/document_symbols/scope_visitor.dart b/pkgs/sass_language_services/lib/src/features/document_symbols/scope_visitor.dart
@@ -2,14 +2,13 @@ import 'package:lsp_server/lsp_server.dart' as lsp;
 import 'package:sass_api/sass_api.dart' as sass;
 
 import '../../utils/sass_lsp_utils.dart';
-import '../document_symbols/stylesheet_document_symbol.dart';
+import 'scoped_symbols.dart';
+import 'stylesheet_document_symbol.dart';
 import 'scope.dart';
 
 final deprecated = RegExp(r'///\s*@deprecated');
 final openBracketOrNewline = RegExp(r'[\{\n]');
 
-enum Dialect { scss, indented }
-
 /// Builds scopes and a list of symbols in those scopes starting at [scope] (typically the global scope).
 class ScopeVisitor with sass.RecursiveStatementVisitor {
   final Scope scope;
diff --git a/pkgs/sass_language_services/lib/src/features/document_symbols/scoped_symbols.dart b/pkgs/sass_language_services/lib/src/features/document_symbols/scoped_symbols.dart
@@ -1,11 +1,13 @@
 import 'package:sass_api/sass_api.dart' as sass;
 import 'package:sass_language_services/src/utils/sass_lsp_utils.dart';
 
-import '../document_symbols/stylesheet_document_symbol.dart';
+import 'stylesheet_document_symbol.dart';
 import '../find_references/reference.dart';
 import 'scope.dart';
 import 'scope_visitor.dart';
 
+enum Dialect { scss, indented }
+
 ReferenceKind? getNodeReferenceKind(sass.AstNode node) {
   if (node is sass.VariableDeclaration) {
     return ReferenceKind.variable;
diff --git a/pkgs/sass_language_services/lib/src/features/folding_ranges/folding_ranges_feature.dart b/pkgs/sass_language_services/lib/src/features/folding_ranges/folding_ranges_feature.dart
@@ -1,23 +1,14 @@
 import 'package:lsp_server/lsp_server.dart' as lsp;
 import 'package:sass_language_services/sass_language_services.dart';
 
-import '../go_to_definition/scope.dart';
-import '../go_to_definition/scope_visitor.dart';
-import '../go_to_definition/scoped_symbols.dart';
+import '../document_symbols/scope.dart';
 import '../language_feature.dart';
 
 class FoldingRangesFeature extends LanguageFeature {
   FoldingRangesFeature({required super.ls});
 
   List<lsp.FoldingRange> getFoldingRanges(TextDocument document) {
-    var stylesheet = ls.parseStylesheet(document);
-
-    var symbols = ls.cache.getDocumentSymbols(document) ??
-        ScopedSymbols(
-          stylesheet,
-          document.languageId == 'sass' ? Dialect.indented : Dialect.scss,
-        );
-    ls.cache.setDocumentSymbols(document, symbols);
+    var symbols = ls.getScopedSymbols(document);
 
     var result = <lsp.FoldingRange>[];
     // Omit the global scope.
diff --git a/pkgs/sass_language_services/lib/src/features/go_to_definition/go_to_definition_feature.dart b/pkgs/sass_language_services/lib/src/features/go_to_definition/go_to_definition_feature.dart
@@ -1,13 +1,11 @@
 import 'package:lsp_server/lsp_server.dart' as lsp;
 import 'package:sass_api/sass_api.dart' as sass;
 import 'package:sass_language_services/sass_language_services.dart';
-import 'package:sass_language_services/src/features/go_to_definition/scoped_symbols.dart';
 import 'package:sass_language_services/src/features/node_at_offset_visitor.dart';
 
 import '../../utils/sass_lsp_utils.dart';
 import '../language_feature.dart';
 import 'definition.dart';
-import 'scope_visitor.dart';
 
 class GoToDefinitionFeature extends LanguageFeature {
   GoToDefinitionFeature({required super.ls});
@@ -59,13 +57,7 @@ class GoToDefinitionFeature extends LanguageFeature {
 
       // Look for the symbol in the current document.
       // It may be a scoped symbol.
-      // TODO: refactor so L63-68 is a function in DocumentSymbolsFeature, remove duplicates.
-      var symbols = ls.cache.getDocumentSymbols(document) ??
-          ScopedSymbols(
-            stylesheet,
-            document.languageId == 'sass' ? Dialect.indented : Dialect.scss,
-          );
-      ls.cache.setDocumentSymbols(document, symbols);
+      var symbols = ls.getScopedSymbols(document);
       var symbol = symbols.findSymbolFromNode(node);
       if (symbol != null) {
         // Found the definition in the same document.
@@ -134,14 +126,7 @@ class GoToDefinitionFeature extends LanguageFeature {
               ? name!.replaceFirst(prefix, '')
               : name!;
 
-          var stylesheet = ls.parseStylesheet(document);
-
-          var symbols = ls.cache.getDocumentSymbols(document) ??
-              ScopedSymbols(
-                stylesheet,
-                document.languageId == 'sass' ? Dialect.indented : Dialect.scss,
-              );
-          ls.cache.setDocumentSymbols(document, symbols);
+          var symbols = ls.getScopedSymbols(document);
 
           var symbol = symbols.globalScope.getSymbol(
             name: unprefixedName,
@@ -180,13 +165,7 @@ class GoToDefinitionFeature extends LanguageFeature {
         continue;
       }
 
-      var stylesheet = ls.parseStylesheet(document);
-      var symbols = ls.cache.getDocumentSymbols(document) ??
-          ScopedSymbols(
-            stylesheet,
-            document.languageId == 'sass' ? Dialect.indented : Dialect.scss,
-          );
-      ls.cache.setDocumentSymbols(document, symbols);
+      var symbols = ls.getScopedSymbols(document);
 
       for (var kind in kinds) {
         var symbol = symbols.globalScope.getSymbol(
diff --git a/pkgs/sass_language_services/lib/src/features/rename/rename_feature.dart b/pkgs/sass_language_services/lib/src/features/rename/rename_feature.dart
@@ -1,7 +1,6 @@
 import 'package:lsp_server/lsp_server.dart' as lsp;
 import 'package:sass_api/sass_api.dart';
 import 'package:sass_language_services/sass_language_services.dart';
-import 'package:sass_language_services/src/features/go_to_definition/scoped_symbols.dart';
 import 'package:sass_language_services/src/features/node_at_offset_visitor.dart';
 
 import '../find_references/find_references_feature.dart';
diff --git a/pkgs/sass_language_services/lib/src/features/selection_ranges/selection_ranges_feature.dart b/pkgs/sass_language_services/lib/src/features/selection_ranges/selection_ranges_feature.dart
@@ -3,8 +3,6 @@ import 'package:sass_language_services/sass_language_services.dart';
 import 'package:sass_language_services/src/features/selection_ranges/selection_ranges_visitor.dart';
 import 'package:sass_language_services/src/utils/sass_lsp_utils.dart';
 
-import '../go_to_definition/scope_visitor.dart';
-import '../go_to_definition/scoped_symbols.dart';
 import '../language_feature.dart';
 
 class SelectionRangesFeature extends LanguageFeature {
@@ -13,12 +11,6 @@ class SelectionRangesFeature extends LanguageFeature {
   List<lsp.SelectionRange> getSelectionRanges(
       TextDocument document, List<lsp.Position> positions) {
     var stylesheet = ls.parseStylesheet(document);
-    var symbols = ls.cache.getDocumentSymbols(document) ??
-        ScopedSymbols(
-          stylesheet,
-          document.languageId == 'sass' ? Dialect.indented : Dialect.scss,
-        );
-    ls.cache.setDocumentSymbols(document, symbols);
 
     var result = <lsp.SelectionRange>[];
 
diff --git a/pkgs/sass_language_services/lib/src/language_services.dart b/pkgs/sass_language_services/lib/src/language_services.dart
@@ -82,6 +82,11 @@ class LanguageServices {
     return _documentSymbols.findDocumentSymbols(document);
   }
 
+  /// Builds scopes and a list of symbols in those scopes starting at the global scope.
+  ScopedSymbols getScopedSymbols(TextDocument document) {
+    return _documentSymbols.getScopedSymbols(document);
+  }
+
   /// Get a response for the [references](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.18/specification/#textDocument_references) request.
   Future<List<lsp.Location>> findReferences(TextDocument document,
       lsp.Position position, lsp.ReferenceContext context) {
diff --git a/pkgs/sass_language_services/lib/src/language_services_cache.dart b/pkgs/sass_language_services/lib/src/language_services_cache.dart
@@ -1,6 +1,5 @@
 import 'package:sass_api/sass_api.dart' as sass;
 import 'package:sass_language_services/sass_language_services.dart';
-import 'package:sass_language_services/src/features/go_to_definition/scoped_symbols.dart';
 
 class CacheEntry {
   TextDocument document;
@@ -95,11 +94,11 @@ class LanguageServicesCache {
     return _cache[document.uri.toString()]?.links;
   }
 
-  /// Get the cached symbols for [TextDocument].
+  /// Get the cached [ScopedSymbols] for [TextDocument].
   ///
   /// We cache this since some workspace features read these symbols
   /// for all linked documents (recursively), which can get CPU intensive.
-  ScopedSymbols? getDocumentSymbols(TextDocument document) {
+  ScopedSymbols? getScopedSymbols(TextDocument document) {
     return _cache[document.uri.toString()]?.symbols;
   }
 
@@ -110,7 +109,7 @@ class LanguageServicesCache {
   }
 
   /// Store the result from [ScopedSymbols].
-  void setDocumentSymbols(TextDocument document, ScopedSymbols symbols) {
+  void setScopedSymbols(TextDocument document, ScopedSymbols symbols) {
     _cache[document.uri.toString()]?.symbols = symbols;
   }
 
diff --git a/pkgs/sass_language_services/test/features/go_to_definition/scope_test.dart b/pkgs/sass_language_services/test/features/go_to_definition/scope_test.dart
@@ -1,5 +1,5 @@
 import 'package:sass_language_services/sass_language_services.dart';
-import 'package:sass_language_services/src/features/go_to_definition/scope.dart';
+import 'package:sass_language_services/src/features/document_symbols/scope.dart';
 import 'package:test/test.dart';
 
 import '../../memory_file_system.dart';
diff --git a/pkgs/sass_language_services/test/features/go_to_definition/scoped_symbols_test.dart b/pkgs/sass_language_services/test/features/go_to_definition/scoped_symbols_test.dart
@@ -1,6 +1,4 @@
 import 'package:sass_language_services/sass_language_services.dart';
-import 'package:sass_language_services/src/features/go_to_definition/scope_visitor.dart';
-import 'package:sass_language_services/src/features/go_to_definition/scoped_symbols.dart';
 import 'package:test/test.dart';
 
 import '../../memory_file_system.dart';

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import '../document_symbols/stylesheet_document_symbol.dart';`
	`1`	`+import 'stylesheet_document_symbol.dart';`
`2`	`2`
`3`	`3`	`class Scope {`
`4`	`4`	`Scope? parent;`