dotnet/runtime

[Analyzer] Replacing direct LoggerExtensions.Log* usage with source-generated logging methods

Open

#78,406 opened on Nov 15, 2022

View on GitHub
 (11 comments) (3 reactions) (0 assignees)C# (5,445 forks)batch import
api-approvedarea-Extensions-Loggingcode-analyzercode-fixerhelp wantedpartner-impact

Repository metrics

Stars
 (17,886 stars)
PR merge metrics
 (Avg merge 12d 11h) (661 merged PRs in 30d)

Description

Just as we have a regex source generator analyzer that flags use of Regex and creates a replacement that uses the source generator, we should consider an analyzer that will push code to use the logging source generator. The analyzer would flag direct use of LoggerExtensions.Log* methods and recommend replacing them with use of the logging generator, with the fixer generating a partial method stub for the generator and changing the call site to use it.

Performance rules Category Severity = none (off by default)

Contributor guide

Research direction
Study the implementation of the existing Regex source generator analyzer in the dotnet/runtime repository and understand the pattern for creating a similar analyzer for LoggerExtensions.Log* methods.
Tech stack
csharp
Domain
developer experiencetoolingperformance
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 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
C#Roslyn
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35