Cache scoped symbols, not document symbols

Designed the cache with the assumption that findDocumentSymbols
would be on the hot path for workspace traversal, findReferences
etc. Forgot to update once that turned out not to be the case.

Author: wkillerud

pkgs/sass_language_services/lib/src/features/document_highlights/document_highlights_feature.dart

@@ -29,14 +29,22 @@ class DocumentHighlightsFeature extends LanguageFeature {
     }
     var kind = getNodeReferenceKind(node);
 
-    var symbols = ScopedSymbols(
-      stylesheet,
-      document.languageId == 'sass' ? Dialect.indented : Dialect.scss,
-    );
+    var symbols = ls.cache.getDocumentSymbols(document) ??
+        ScopedSymbols(
+          stylesheet,
+          document.languageId == 'sass' ? Dialect.indented : Dialect.scss,
+        );
+    ls.cache.setDocumentSymbols(document, symbols);
+
     var symbol = symbols.findSymbolFromNode(node);
 
     var result = <lsp.DocumentHighlight>[];
-    var references = FindReferencesVisitor(document, name);
+    var references = FindReferencesVisitor(
+      document,
+      name,
+      includeDeclaration: true,
+    );
+
     for (var reference in references.candidates) {
       if (symbol != null) {
         if (symbol.referenceKind == reference.kind &&

pkgs/sass_language_services/lib/src/features/document_symbols/document_symbols_feature.dart

@@ -7,18 +7,11 @@ class DocumentSymbolsFeature extends LanguageFeature {
   DocumentSymbolsFeature({required super.ls});
 
   List<StylesheetDocumentSymbol> findDocumentSymbols(TextDocument document) {
-    final cached = ls.cache.getDocumentSymbols(document);
-    if (cached != null) {
-      return cached;
-    }
-
     var stylesheet = ls.parseStylesheet(document);
 
     var symbolsVisitor = DocumentSymbolsVisitor();
     stylesheet.accept(symbolsVisitor);
 
-    ls.cache.setDocumentSymbols(document, symbolsVisitor.symbols);
-
     return symbolsVisitor.symbols;
   }
 }

pkgs/sass_language_services/lib/src/features/go_to_definition/go_to_definition_feature.dart

@@ -60,8 +60,12 @@ class GoToDefinitionFeature extends LanguageFeature {
 
       // Look for the symbol in the current document.
       // It may be a scoped symbol.
-      var symbols = ScopedSymbols(stylesheet,
-          document.languageId == 'sass' ? Dialect.indented : Dialect.scss);
+      var symbols = ls.cache.getDocumentSymbols(document) ??
+          ScopedSymbols(
+            stylesheet,
+            document.languageId == 'sass' ? Dialect.indented : Dialect.scss,
+          );
+      ls.cache.setDocumentSymbols(document, symbols);
       var symbol = symbols.findSymbolFromNode(node);
       if (symbol != null) {
         // Found the definition in the same document.
@@ -128,8 +132,14 @@ class GoToDefinitionFeature extends LanguageFeature {
               : name!;
 
           var stylesheet = ls.parseStylesheet(document);
-          var symbols = ScopedSymbols(stylesheet,
-              document.languageId == 'sass' ? Dialect.indented : Dialect.scss);
+
+          var symbols = ls.cache.getDocumentSymbols(document) ??
+              ScopedSymbols(
+                stylesheet,
+                document.languageId == 'sass' ? Dialect.indented : Dialect.scss,
+              );
+          ls.cache.setDocumentSymbols(document, symbols);
+
           var symbol = symbols.globalScope.getSymbol(
             name: unprefixedName,
             referenceKind: kind,

pkgs/sass_language_services/lib/src/features/go_to_definition/scoped_symbols.dart

@@ -11,13 +11,14 @@ ReferenceKind? getNodeReferenceKind(sass.AstNode node) {
     return ReferenceKind.variable;
   } else if (node is sass.Declaration) {
     var isCustomProperty =
-        node.name.isPlain && node.name.asPlain!.startsWith("--");
+        node.name.isPlain && node.name.asPlain!.startsWith('--');
     if (isCustomProperty) {
       return ReferenceKind.customProperty;
     }
   } else if (node is sass.StringExpression) {
-    var isCustomProperty =
-        node.text.isPlain && node.text.asPlain!.startsWith("--");
+    var isCustomProperty = node.text.isPlain &&
+        (node.text.asPlain!.startsWith('--') ||
+            node.text.asPlain!.startsWith('var(--'));
     if (isCustomProperty) {
       return ReferenceKind.customProperty;
     }
@@ -60,15 +61,21 @@ String? getNodeName(sass.AstNode node) {
     return node.name;
   } else if (node is sass.Declaration) {
     var isCustomProperty =
-        node.name.isPlain && node.name.asPlain!.startsWith("--");
+        node.name.isPlain && node.name.asPlain!.startsWith('--');
     if (isCustomProperty) {
       return node.name.asPlain;
     }
   } else if (node is sass.StringExpression) {
-    var isCustomProperty =
-        node.text.isPlain && node.text.asPlain!.startsWith("--");
+    var isCustomProperty = node.text.isPlain &&
+        (node.text.asPlain!.startsWith('--') ||
+            node.text.asPlain!.startsWith('var(--'));
     if (isCustomProperty) {
-      return node.text.asPlain;
+      var name = node.text.asPlain!;
+      if (name.startsWith('var(')) {
+        name = name.replaceAll('var(', '');
+        name = name.replaceAll(')', '');
+      }
+      return name;
     }
   } else if (node is sass.AtRule) {
     var name = node.name;

pkgs/sass_language_services/lib/src/language_services_cache.dart

@@ -1,11 +1,12 @@
 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;
   sass.Stylesheet stylesheet;
   List<StylesheetDocumentLink>? links;
-  List<StylesheetDocumentSymbol>? symbols;
+  ScopedSymbols? symbols;
 
   CacheEntry({
     required this.document,
@@ -53,7 +54,7 @@ class LanguageServicesCache {
     return _cache[document.uri.toString()]?.links;
   }
 
-  List<StylesheetDocumentSymbol>? getDocumentSymbols(TextDocument document) {
+  ScopedSymbols? getDocumentSymbols(TextDocument document) {
     return _cache[document.uri.toString()]?.symbols;
   }
 
@@ -62,8 +63,7 @@ class LanguageServicesCache {
     _cache[document.uri.toString()]?.links = links;
   }
 
-  void setDocumentSymbols(
-      TextDocument document, List<StylesheetDocumentSymbol> symbols) {
+  void setDocumentSymbols(TextDocument document, ScopedSymbols symbols) {
     _cache[document.uri.toString()]?.symbols = symbols;
   }