microsoft / microsoft/TypeScript

[tsserver] Multi-project goto definition with accurate results

Open
#62,080 2 comments 0 reactions 0 assignees View on GitHub
Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
PR merge metrics
PR metrics pending

Description

### 🔍 Search Terms

multi project goto definition
tsserver multiple projects
cross project goto
cross project references

### ✅ Viability Checklist

- [x] This wouldn't be a breaking change in existing TypeScript/JavaScript code
- [x] This wouldn't change the runtime behavior of existing JavaScript code
- [x] This could be implemented without emitting different JS based on the types of the expressions
- [x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
- [x] This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- [x] This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals

### ⭐ Suggestion

Take all projects that references a file into consideration when doing goto definition.

### 📃 Motivating Example

Currently when you are working on shared code that calls or uses code that differs in implementation on the client and server the accuracy of goto definition is not optimal. It will just goto either the client or the server. It would be optimal if all relevant definitions were returned.

### 💻 Use Cases

Example project:
```ts
// shared/shared.ts
let x: Thing; // < goto definition here

// project1/tsconfig.json
...

// project1/thingA.ts
interface Thing { a: string }

// project2/tsconfig.json
...

// project2/thingB.ts
interface Thing { b: number }
```

Currently this is returned (depending on order of project load):
```ts
interface Thing { a: string }
```

What ideally should be returned:
```ts
interface Thing { a: string }
interface Thing { b: number }
```

Contributor guide

Open the contributing guide

Research direction

The issue points to tsserver's multi-project goto-definition handling; start by tracing how projects referencing a shared file are selected. Compare the current single-definition result with the example's expected definitions, then establish coverage for returning all relevant results. No specific files or tests are named, so locating the implementation and test area requires project familiarity.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.