dotnet/roslyn

Remove or document "CompilerDiagnostic" type

Open

#63,938 opened on Sep 12, 2022

View on GitHub
 (0 comments) (0 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

See https://github.com/dotnet/roslyn/pull/63937 for details

For compiler diagnostics which have a non-null property bag attached to it, the CompilerDiagnosticAnalyzer reports a wrapping CompilerDiagnostic: https://github.com/dotnet/roslyn/blob/c71fa5419aa035a8d76c8a82387353e3892180a7/src/Compilers/Core/Portable/DiagnosticAnalyzer/CompilerDiagnosticAnalyzer.CompilationAnalyzer.cs#L70-L71

I do not have historical context on why we report this wrapping CompilerDiagnostic in presence of a non-null property bag on the diagnostic. We may want to consider experimenting removing this type and verify what, if anything, breaks. At the minimum, we should document the reason behind this wrapping diagnostic. I'll file a tracking issue for this work.

Contributor guide

Research direction
Investigate the CompilerDiagnostic type, its usage, and the reason for wrapping. Consider removing it and verify what breaks. Document the reason if kept.
Tech stack
csharp
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
C#
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30