Add support for "find references" to glint-language-server

packages/core/__tests__/language-server/references.test.ts

@@ -0,0 +1,166 @@
+import Project from '../utils/project';
+import { stripIndent } from 'common-tags';
+
+describe('Language Server: References', () => {
+  let project!: Project;
+
+  beforeEach(async () => {
+    jest.setTimeout(20_000);
+    project = await Project.create();
+  });
+
+  afterEach(async () => {
+    await project.destroy();
+  });
+
+  test('component references', () => {
+    project.write({
+      'greeting.ts': stripIndent`
+        import Component, { hbs } from '@glimmerx/component';
+
+        export default class Greeting extends Component {
+          private nested = Math.random() > 0.5;
+
+          static template = hbs\`
+            {{#if this.nested}}
+              <Greeting />!
+            {{else}}
+              Hello!
+            {{/if}}
+          \`;
+        }
+      `,
+      'index.ts': stripIndent`
+        import Component, { hbs } from '@glimmerx/component';
+        import Greeting from './greeting';
+
+        export default class Application extends Component {
+          static template = hbs\`
+            <Greeting />
+          \`;
+        }
+      `,
+    });
+
+    let server = project.startLanguageServer();
+    let expectedReferences = new Set([
+      {
+        uri: project.fileURI('greeting.ts'),
+        range: {
+          start: { line: 2, character: 21 },
+          end: { line: 2, character: 29 },
+        },
+      },
+      {
+        uri: project.fileURI('greeting.ts'),
+        range: {
+          start: { line: 7, character: 7 },
+          end: { line: 7, character: 15 },
+        },
+      },
+      {
+        uri: project.fileURI('index.ts'),
+        range: {
+          start: { line: 5, character: 5 },
+          end: { line: 5, character: 13 },
+        },
+      },
+      {
+        uri: project.fileURI('index.ts'),
+        range: {
+          start: { line: 1, character: 7 },
+          end: { line: 1, character: 15 },
+        },
+      },
+    ]);
+
+    let referencesFromClassDeclaration = server.getReferences(project.fileURI('greeting.ts'), {
+      line: 2,
+      character: 24,
+    });
+
+    expect(new Set(referencesFromClassDeclaration)).toEqual(expectedReferences);
+
+    let referencesFromComponentInvocation = server.getReferences(project.fileURI('index.ts'), {
+      line: 5,
+      character: 7,
+    });
+
+    expect(new Set(referencesFromComponentInvocation)).toEqual(expectedReferences);
+  });
+
+  test('arg references', async () => {
+    project.write({
+      'greeting.ts': stripIndent`
+        import Component, { hbs } from '@glimmerx/component';
+
+        export interface GreetingArgs {
+          /** Who to greet */
+          target: string;
+        }
+
+        export default class Greeting extends Component<GreetingArgs> {
+          static template = hbs\`
+            Hello, {{@target}}
+          \`;
+        }
+      `,
+      'index.ts': stripIndent`
+        import Component, { hbs } from '@glimmerx/component';
+        import Greeting from './greeting';
+
+        export default class Application extends Component {
+          static template = hbs\`
+            <Greeting @target="World" />
+          \`;
+        }
+      `,
+    });
+
+    let server = project.startLanguageServer();
+    let expectedReferences = new Set([
+      {
+        uri: project.fileURI('index.ts'),
+        range: {
+          start: { line: 5, character: 15 },
+          end: { line: 5, character: 21 },
+        },
+      },
+      {
+        uri: project.fileURI('greeting.ts'),
+        range: {
+          start: { line: 9, character: 14 },
+          end: { line: 9, character: 20 },
+        },
+      },
+      {
+        uri: project.fileURI('greeting.ts'),
+        range: {
+          start: { line: 4, character: 2 },
+          end: { line: 4, character: 8 },
+        },
+      },
+    ]);
+
+    let referencesFromDefinition = server.getReferences(project.fileURI('greeting.ts'), {
+      line: 4,
+      character: 4,
+    });
+
+    expect(new Set(referencesFromDefinition)).toEqual(expectedReferences);
+
+    let referencesFromInvocation = server.getReferences(project.fileURI('index.ts'), {
+      line: 5,
+      character: 17,
+    });
+
+    expect(new Set(referencesFromInvocation)).toEqual(expectedReferences);
+
+    let referencesFromUsage = server.getReferences(project.fileURI('greeting.ts'), {
+      line: 9,
+      character: 16,
+    });
+
+    expect(new Set(referencesFromUsage)).toEqual(expectedReferences);
+  });
+});

packages/core/src/language-server/glint-language-server.ts

@@ -243,19 +243,39 @@ export default class GlintLanguageServer {
     let definitions =
       this.service.getDefinitionAtPosition(transformedFileName, transformedOffset) ?? [];
 
-    return definitions.map(({ fileName, textSpan }) => {
-      let { originalFileName, originalStart, originalEnd } = this.transformManager.getOriginalRange(
-        fileName,
-        textSpan.start,
-        textSpan.start + textSpan.length
-      );
+    return this.calculateOriginalLocations(definitions);
+  }
 
-      let originalContents = this.documents.getDocumentContents(originalFileName);
-      let start = offsetToPosition(originalContents, originalStart);
-      let end = offsetToPosition(originalContents, originalEnd);
+  public getReferences(uri: string, position: Position): Location[] {
+    let { transformedFileName, transformedOffset } = this.getTransformedOffset(uri, position);
+    let references =
+      this.service.getReferencesAtPosition(transformedFileName, transformedOffset) ?? [];
 
-      return Location.create(filePathToUri(originalFileName), { start, end });
-    });
+    return this.calculateOriginalLocations(references);
+  }
+
+  private calculateOriginalLocations(spans: ReadonlyArray<ts.DocumentSpan>): Array<Location> {
+    return spans
+      .map((span) => this.documentSpanToLocation(span))
+      .filter((loc): loc is Location => Boolean(loc));
+  }
+
+  private documentSpanToLocation({ fileName, textSpan }: ts.DocumentSpan): Location | undefined {
+    let { originalFileName, originalStart, originalEnd } = this.transformManager.getOriginalRange(
+      fileName,
+      textSpan.start,
+      textSpan.start + textSpan.length
+    );
+
+    // Zero-length spans correspond to a synthetic use of the symbol, so we don't
+    // want to actually show them to the user.
+    if (originalStart === originalEnd) return;
+
+    let originalContents = this.documents.getDocumentContents(originalFileName);
+    let start = offsetToPosition(originalContents, originalStart);
+    let end = offsetToPosition(originalContents, originalEnd);
+
+    return Location.create(filePathToUri(originalFileName), { start, end });
   }
 
   private findDiagnosticsSource(fileName: string): string | undefined {

packages/core/src/language-server/index.ts

@@ -26,6 +26,7 @@ connection.onInitialize(() => ({
     completionProvider: {
       resolveProvider: true,
     },
+    referencesProvider: true,
     hoverProvider: true,
     definitionProvider: true,
     renameProvider: {
@@ -88,5 +89,9 @@ connection.onDefinition(({ textDocument, position }) => {
   return gls.getDefinition(textDocument.uri, position);
 });
 
+connection.onReferences(({ textDocument, position }) => {
+  return gls.getReferences(textDocument.uri, position);
+});
+
 documents.listen(connection);
 connection.listen();