microsoft / microsoft/TypeScript

Outline view does not show props of typescript type

Open
#62,205 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

🔍 Search Terms

tsserver type outline view

✅ Viability Checklist
⭐ Suggestion

When using typescript interface instead of type:

export interface User {
     id?: string | undefined;
     username: string;
}

the props are shown in the editor's Outline view.

However, when I have a typical typescript type:

 export type User = {
     id?: string | undefined;
     username: string;
}

the props are not shown in the Outline view (e.g. VSCode or Eclipse Editor Outline View)

Please show the props in the Ouline view also for typescript type.

This issue was previously created on other repos and delegated to this repo:

📃 Motivating Example

Show the props in the Ouline view also for typescript type.

💻 Use Cases
  1. What do you want to use this for? for outline view
  2. What shortcomings exist with current approaches? properties in the Ouline view does not appear for typescript type
  3. What workarounds are you using in the meantime? nothing

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

No source file or test is named. Start by investigating the tsserver document-symbol or outline handling, comparing the symbols produced for the interface and type examples in the issue. Done means the type alias's properties appear in the editor Outline view as the interface properties do.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.