Microsoft/TypeScript

Don't suggest converting custom promise-like returning function to async ones

Open

#40,701 opened on Sep 22, 2020

View on GitHubContributor guide
 (4 comments) (1 reaction) (0 assignees)TypeScript (13,395 forks)batch import
Domain: LS: RefactoringsExperience EnhancementHelp WantedSuggestion

Repository metrics

Stars
 (108,860 stars)
PR merge metrics
 (PR metrics pending)

Description

Search Terms

async converted function

Suggestion

Do not suggest that a function is converted to async if its return value is explicitly set to something that is not the global Promise type.

Use Cases

If using a package that provides an extended version of promises (for instance cancellable promises) then the transformation is wrong to occur.

Examples

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

Research direction
Find the code in the TypeScript compiler that suggests converting non async functions to async. Identify where it checks for Promise return type and modify it to exclude custom promise like types.
Tech stack
typescript
Domain
compilers
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40