microsoft / microsoft/TypeScript

"Go To Type Definition" for type names should navigate to the type definition

Open
#33,147 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Domain: LS: Symbol Navigation In Discussion Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

"Go To Type Definition" doesn't doesn't work when the selection is itself a type. Instead, you get a "No type definition found" error. I can understand why it was implemented in this way ("types don't have a type!") but IMHO this behavior unnecessarily inconsistent and confusing for users. If I ask for the type definition of a type, then I should be taken to the... type definition! ;-)

I'm filing this at @weswigham's request to split it out of #6209. IMHO, if #6209 is implemented as I'm suggesting (where Go To Definition would navigate to the actual implementing source, not the DefinitelyTyped .d.ts) then fixing this issue would be helpful because it'd make both operations more consistent:

  • Go To Definition would always navigate to implementation code (not to type declarations), regardless of what symbol is selected.
  • Go to Type Definition would always navigate to type declarations, regardless of what symbol is selected

Search Terms

Go to Type Definition
No type definition found for
getTypeDefinitionsAtPosition - this is one possible method to change in a PR

Suggestion

Go to Type Definition should, when called for a type, return the location of the type definition.

Use Cases

Discussed above

Examples

type X = {a: number};
const a: X = {a: 1};

In VSCode, select and right-click on the second X and choose Go To Type Definition.

Expected: navigates to declaration
Actual: No type definition for 'X'

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the getTypeDefinitionsAtPosition entry point named in the issue and reproduce the example by selecting the type name in the TypeScript language service. Done means Go To Type Definition returns the type declaration for a selected type instead of reporting that no type definition was found.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers, developer-experience
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.