chore: implement references provider

.changeset/soft-garlics-raise.md

@@ -0,0 +1,6 @@
+---
+"marko-vscode": patch
+"@marko/language-server": patch
+---
+
+Implements references provider (currently for stylesheets).

clients/vscode/src/__tests__/references.test.ts

@@ -0,0 +1,49 @@
+import vscode from "vscode";
+import snap from "mocha-snap";
+import { getTestDoc, getTestEditor, updateTestDoc } from "./setup.test";
+
+describe("references", () => {
+  it("css custom property", async () => {
+    await snap.inline(
+      () =>
+        references(
+          `style {
+  :root {
+      --color█: green;
+  }
+
+  body {
+      color: var(--color);
+  }
+}`
+        ),
+      `[
+  {
+    offset: 24,
+    value: '--color'
+  },
+  {
+    offset: 71,
+    value: '--color'
+  },
+  [length]: 2
+]`
+    );
+  });
+});
+
+async function references(src: string) {
+  const doc = getTestDoc();
+  const editor = getTestEditor();
+  await updateTestDoc(src);
+  const locations = await vscode.commands.executeCommand<vscode.Location[]>(
+    "vscode.executeReferenceProvider",
+    doc.uri,
+    editor.selection.start
+  );
+
+  return locations.map((it) => ({
+    offset: doc.offsetAt(it.range.start),
+    value: doc.getText(it.range),
+  }));
+}

server/src/index.ts

@@ -46,6 +46,7 @@ connection.onInitialize(() => {
       hoverProvider: true,
       renameProvider: true,
       codeActionProvider: true,
+      referencesProvider: true,
       colorProvider: true,
       documentHighlightProvider: true,
       completionProvider: {
@@ -103,6 +104,16 @@ connection.onDefinition(async (params, cancel) => {
   );
 });
 
+connection.onReferences(async (params, cancel) => {
+  return (
+    (await service.findReferences(
+      documents.get(params.textDocument.uri)!,
+      params,
+      cancel
+    )) || null
+  );
+});
+
 connection.onDocumentHighlight(async (params, cancel) => {
   return (
     (await service.findDocumentHighlights(

server/src/service/index.ts

@@ -75,6 +75,30 @@ const service: Plugin = {
 
     return result;
   },
+  async findReferences(doc, params, cancel) {
+    let result: Location[] | undefined;
+
+    try {
+      const requests = plugins.map((plugin) =>
+        plugin.findReferences?.(doc, params, cancel)
+      );
+      for (const pending of requests) {
+        const cur = await pending;
+        if (cancel.isCancellationRequested) return;
+        if (cur) {
+          if (result) {
+            result.push(...cur);
+          } else {
+            result = cur;
+          }
+        }
+      }
+    } catch (err) {
+      displayError(err);
+    }
+
+    return result;
+  },
   async findDocumentHighlights(doc, params, cancel) {
     let result: DocumentHighlight[] | undefined;
 

server/src/service/stylesheet/index.ts

@@ -6,6 +6,7 @@ import {
   InsertReplaceEdit,
   Range,
   TextDocumentEdit,
+  Location,
   TextEdit,
 } from "vscode-languageserver";
 import {
@@ -105,6 +106,32 @@ const StyleSheetService: Partial<Plugin> = {
       break;
     }
   },
+  async findReferences(doc, params) {
+    const infoByExt = getStyleSheetInfo(doc);
+    const sourceOffset = doc.offsetAt(params.position);
+
+    for (const ext in infoByExt) {
+      const info = infoByExt[ext];
+      // Find the first stylesheet data that contains the offset.
+      const generatedOffset = info.generatedOffsetAt(sourceOffset);
+      if (generatedOffset === undefined) continue;
+
+      const { service, virtualDoc } = info;
+      const result: Location[] = [];
+
+      for (const location of service.findReferences(
+        virtualDoc,
+        virtualDoc.positionAt(generatedOffset),
+        info.parsed
+      )) {
+        if (updateRange(doc, info, location.range)) {
+          result.push(location);
+        }
+      }
+
+      return result.length ? result : undefined;
+    }
+  },
   async findDocumentHighlights(doc, params) {
     const infoByExt = getStyleSheetInfo(doc);
     const sourceOffset = doc.offsetAt(params.position);

server/src/service/types.ts

@@ -19,6 +19,7 @@ import type {
   HoverParams,
   Location,
   LocationLink,
+  ReferenceParams,
   RenameParams,
   TextEdit,
   WorkspaceEdit,
@@ -42,6 +43,7 @@ export type Plugin = {
     DefinitionParams,
     Location | LocationLink | (Location | LocationLink)[]
   >;
+  findReferences: Handler<ReferenceParams, Location[]>;
   findDocumentHighlights: Handler<DocumentHighlightParams, DocumentHighlight[]>;
   findDocumentColors: Handler<DocumentColorParams, ColorInformation[]>;
   getColorPresentations: Handler<ColorPresentationParams, ColorPresentation[]>;