dotnet/roslyn

await code fix / analyzer enhancement

Open

#60,318 opened on Mar 22, 2022

View on GitHub
 (1 comment) (4 reactions) (0 assignees)C# (4,257 forks)batch import
Area-AnalyzersConcept-Continuous Improvementhelp wanted

Repository metrics

Stars
 (20,414 stars)
PR merge metrics
 (Avg merge 6d 17h) (256 merged PRs in 30d)

Description

Discussed in https://github.com/dotnet/roslyn/discussions/60285

Originally posted by TonyValenti March 20, 2022 Today, if you have a method like this:

public Task FooAsync() {

  return Task.Completed;
}

and you type "await " in the body of the method, the signature of the method automatically changes to include "async" so that it reads as so:

public async Task FooAsync() { // Notice that async was added.

  await //this is where I was typing

  return Task.CompletedTask;
}

This is great but it would be even better if a few other changes would happen:

  1. Change any "return Task.CompletedTask" to just "Return" (or, perhaps, omit it completely depending on location)
  2. Change any "Task.FromResult(x)" to just x

Contributor guide

Research direction
Study the existing 'async' code fix provider in the Roslyn codebase (likely in Features/Core/Async). Understand how it currently inserts the async modifier when 'await' is typed. Then, plan to extend it to also remove 'return Task.CompletedTask' or 'Task.FromResult' calls, replacing them with plain return. Look for existing tests related to this code fix to understand expected behavior.
Tech stack
csharp
Domain
developer experience
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.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60