microsoft / microsoft/TypeScript
Type completions in jsDoc @augments and @implements tags.
Open
@sandersn is already working on this.
Since Feb 26, 2020.
Needs Investigation
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Suggestion
Add code completions in jsDoc @augments and @implements clauses.
Use Cases
Anybody using the new @implements and @augments jsDoc tags will benefit from this.
Examples
Inside the {} triggering code completions should show types.
/**
* @augments {}
* @implements {}
*/
declare class B {
b(): void;
i(): void;
}
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.
This is a flow-on from #36292 cc: @sandersn
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.
Assessment
This issue has not been assessed yet.