dotnet/runtime

Analyzer: Introduce an analyzer to recommend the more efficient string splitting features in .NET 8

Open

#85,487 opened on Apr 27, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)C# (5,445 forks)batch import
api-approvedarea-System.Runtimecode-analyzerhelp wantedpartner-impact

Repository metrics

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

Description

Introduce a performance-centric analyzer that detects uses of String.Split and recommends the new more efficient string splitting functionality from MemoryExtensions. I'm not sure a fixer can be provided here, it might be too complicated for that. But having an analyzer to point out an obvious place that can get a perf boost is still useful.

Category : Performance Severity : Info

Contributor guide

Research direction
Investigate the new MemoryExtensions.Split overloads in .NET 8 and design a diagnostic analyzer that detects calls to String.Split and suggests using the more efficient MemoryExtensions.Split. Study existing Roslyn analyzer samples and the Performance analyzer pattern in dotnet/roslyn analyzers.
Tech stack
csharp
Domain
developer experienceperformance
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
C#.NETRoslyn Analyzer Basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60