microsoft / microsoft/TypeScript

Refactors which in TS would generate a type annotation should generate jsdoc in JS

Open
#26,306 2 comments 0 reactions 0 assignees View on GitHub

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:
jsneedsdocs

Playground Link:

Related Issues:

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 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.