Skip to content

Add api to allow customizing options per DiagnosticAnalyzer #80200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 90 commits into from
Sep 12, 2025
Merged

Add api to allow customizing options per DiagnosticAnalyzer #80200

merged 90 commits into from
Sep 12, 2025

Conversation

CyrusNajmabadi
Copy link
Member

@CyrusNajmabadi CyrusNajmabadi commented Sep 9, 2025 •
edited
Loading

API approved in #80143

CyrusNajmabadi
CyrusNajmabadi commented Sep 10, 2025
View reviewed changes
src/Compilers/Core/Portable/DiagnosticAnalyzer/AnalyzerExecutor.cs
private const string DiagnosticCategory = "Compiler";

// internal for testing purposes only.
internal const string AnalyzerExceptionDiagnosticId = "AD0001";
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The meat of hte change is in this file.

CyrusNajmabadi
CyrusNajmabadi commented Sep 10, 2025
View reviewed changes
src/Compilers/Core/Portable/DiagnosticAnalyzer/AnalyzerExecutor.cs Outdated
// can use the same instance across all actions.
var context = new SemanticModelAnalysisContext(
semanticModel, AnalyzerOptions, diagReporter.AddDiagnosticAction,
semanticModel, options, diagReporter.AddDiagnosticAction,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
semanticModel, options, diagReporter.AddDiagnosticAction,
semanticModel, analyzerOptions, diagReporter.AddDiagnosticAction,

@CyrusNajmabadi
Copy link
Member Author

Ok. Performance seems unchanged:

| Method                      | Job        | InvocationCount | UnrollFactor | Mean    | Error    | StdDev   | Median  | Min     | Max     | Gen0        | Gen1       | Gen2      | Allocated  |
| GetDiagnosticsWithAnalyzers | Job-YBTWXS | 1               | 1            | 5.634 s | 0.0562 s | 0.0751 s | 5.649 s | 5.484 s | 5.756 s | 181000.0000 | 61000.0000 | 1000.0000 | 1440.27 MB |
| GetDiagnosticsWithAnalyzers | Job-IGTETM | 1               | 1            | 5.640 s | 0.0537 s | 0.0527 s | 5.642 s | 5.556 s | 5.760 s | 183000.0000 | 64000.0000 | 2000.0000 | 1446.7 MB |

@CyrusNajmabadi
Copy link
Member Author

@dotnet/roslyn-compiler for eyes. Tnx :)

@CyrusNajmabadi
Copy link
Member Author

@dotnet/roslyn-compiler for reviews :)

@CyrusNajmabadi
Copy link
Member Author

@dotnet/roslyn-compiler @jjonescz @jcouv ptal :)

jjonescz
jjonescz approved these changes Sep 12, 2025
View reviewed changes
src/Compilers/Core/Portable/DiagnosticAnalyzer/AnalyzerExecutor.cs

// Deduping map for the distinct AnalyzerConfigOptionsProvider we get back from getAnalyzerConfigOptionsProvider.
// The common case in VS host is that there is generally only 1-2 of these providers. For example, a provider
// that looks in editorconfig+vsoptions, and a provider that only looks in editorconfig. We only want to make
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated to this PR: I'm planning to enable analyzer redirecting in dev18 which would redirect built-in SDK analyzers to ones inserted in VS (to avoid compiler version mismatch). I'm not sure if that is going to break the logic of analyzer option loading.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pinging you offline :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Talked offline. We're good. The redirection tthat is done doesn't affect the status of these references as 'project references'. It just impacts the location they are loaded from. So we will still see these as project-level references, and will appropriately hookup the right non-fallback options.

@CyrusNajmabadi
Copy link
Member Author

@dotnet/roslyn-compiler for final set of eyes.

@CyrusNajmabadi CyrusNajmabadi merged commit 906c266 into dotnet:main Sep 12, 2025
28 checks passed
@CyrusNajmabadi CyrusNajmabadi deleted the compilationOptionsApi branch September 12, 2025 21:28
@dotnet-policy-service dotnet-policy-service bot added this to the Next milestone Sep 12, 2025
This was referenced Sep 12, 2025
Closed
Merged
@akhera99 akhera99 modified the milestones: Next, 18.0 P1, 18.0 P2 Sep 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasonmalinowski jasonmalinowski jasonmalinowski approved these changes

@333fred 333fred 333fred approved these changes

@jjonescz jjonescz jjonescz approved these changes

Assignees
No one assigned
Labels
Needs API Review Needs to be reviewed by the API review council
Projects
None yet
Milestone
18.0 P2
Development

Successfully merging this pull request may close these issues.
5 participants
@CyrusNajmabadi @jasonmalinowski @333fred @jjonescz @akhera99