microsoft / microsoft/TypeScript
Refactors which in TS would generate a type annotation should generate jsdoc in JS
Open
Nobody has claimed this yet.
Committed
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version: 3.1.0-dev.201xxxxx
Search Terms:
Code
// In TS
function x(): 42 {
return /*extract to inner function*/42;
}
// In JS
// @ts-check
/**
* @returns {42}
*/
function x() {
return /*extract to inner function*/42;
}
Expected behavior:
Under ts-check, a refactoring should apply appropriate jsdocs to allow js to typecheck after a refactoring if it typechecked before it.
Actual behavior:

Playground Link:
Related Issues:
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 implementation file, test, or entry point is named. Reproduce the supplied TypeScript and JavaScript refactoring example with typescript@next, then trace the refactoring behavior; done means JavaScript refactors add appropriate JSDoc so the result continues to typecheck under ts-check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100