dotnet/roslyn

Source generator warning duplication and missing link and description

Open

#69,826 opened on Sep 5, 2023

View on GitHub
 (8 comments) (1 reaction) (0 assignees)C# (4,257 forks)batch import
Area-IDEBughelp wanted

Repository metrics

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

Description

Version Used:

  • Microsoft Visual Studio Enterprise 2022 (64-bit) - Preview Version 17.8.0 Preview 1.0

Steps to Reproduce:

  1. Clone/download https://github.com/kzu/SourceGeneratorWarning/
  2. Build once: a warning should appear, with a link, message and description
  3. Rebuild the Tests project. A duplicate warning missing the right link (takes you instead to a generic VS F1 help page) and missing the description is shown:

image

Expected Behavior:

Only one warning is ever shown, and it is consistent, showing the description and link as provided by the diagnostic descriptor.

Actual Behavior:

Duplicate warning, missing link and description.

Contributor guide

Research direction
Examine the source generator warning emission logic in Roslyn, focusing on how diagnostic descriptors are registered and cached. Investigate if the warning is being emitted multiple times due to improper caching or regeneration of descriptors, causing duplication and loss of metadata like link and description.
Tech stack
csharp
Domain
compilers
Issue type
Bug
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.
Half day
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#source generators
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60