microsoft / microsoft/TypeScript
prettify complex type display (for generic-heavy types)
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
https://github.com/microsoft/TypeScript/labels/Domain%3A%20Type%20Display
Suggestion
give indentations + line-changes on type representation. User config for this might be an option.
Examples
suppose I have some generic-heavy function someFunc that returns
const a = someFunc();
// typeof a = RootGeneric<GenericA, GenericB<number, SubGenericB_A<number> ...
// full type not shown 😭
A better output can be:
// typeof a =
RootGeneric<
GenericA,
GenericB<
number,
SubGenericB_A<number> ...
more things:
- editors can implement "expand(+)" buttons ?
(collapsed-tree-view)
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Start with the issue's generic-heavy type examples and determine the intended scope for indentation, line changes, user configuration, and editor expansion. Done requires an agreed design and implementation plan for the type display behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100