microsoft / microsoft/TypeScript
Allow type parameters instead of @template tags in JSDoc
Open
Nobody has claimed this yet.
Domain: JSDoc
Experience Enhancement
In Discussion
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Rather than
/**
* @typedef Arrayify
* @type {{ [K in keyof T]: T[K][] }}
* @template T
*/
/**
* @typedef Bar
* @type {{ x: string, y: number }}
*/
/**
* @type {Arrayify<Bar>}
*/
var x;
I hate writing out the @template tag. Can we just write it out like this?
/**
* @typedef Arrayify<T>
* @type {{ [K in keyof T]: T[K][] }}
*/
/**
* @typedef Bar
* @type {{ x: string, y: number }}
*/
/**
* @type {Arrayify<Bar>}
*/
var x;
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 by locating the JSDoc handling for @template and @typedef, then trace how generic parameters are represented and used in the Arrayify example. Done means the proposed type-parameter syntax works without @template while existing JSDoc behavior remains intact.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100