Error when users use a file type for things we need to load
#7501
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Inspired by dotnet/roslyn#76355. `file` types can cause errors on .NET Framework hosts, and we should just prevent these from being used. The purpose of `file` types is to not be visible outside the current file, and the purpose of analyzers is to be loaded by some other plugin system. These goals are mutually exclusive.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #7501 +/- ##
========================================
Coverage 96.50% 96.50%
========================================
Files 1450 1452 +2
Lines 347435 347566 +131
Branches 11413 11416 +3
========================================
+ Hits 335297 335426 +129
- Misses 9245 9246 +1
- Partials 2893 2894 +1 |
...osoft.CodeAnalysis.Analyzers/Core/MetaAnalyzers/DoNotUseFileTypesForAnalyzersOrGenerators.cs
Show resolved
Hide resolved
...osoft.CodeAnalysis.Analyzers/Core/MetaAnalyzers/DoNotUseFileTypesForAnalyzersOrGenerators.cs
Outdated
Show resolved
Hide resolved
CyrusNajmabadi
approved these changes
Dec 10, 2024
jaredpar
reviewed
Dec 10, 2024
src/Microsoft.CodeAnalysis.Analyzers/Core/CodeAnalysisDiagnosticsResources.resx
Outdated
Show resolved
Hide resolved
...osoft.CodeAnalysis.Analyzers/Core/MetaAnalyzers/DoNotUseFileTypesForAnalyzersOrGenerators.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.CodeAnalysis.Analyzers/Microsoft.CodeAnalysis.Analyzers.md
Outdated
Show resolved
Hide resolved
RikkiGibson
approved these changes
Dec 11, 2024
sharwell
approved these changes
Dec 12, 2024
There was a problem hiding this comment.
This seems more like a compiler bug than an analyzer issue, but can maybe be mitigated here. Would recommend the compiler report a better error for the scenario, as users who encounter the problem will not be able to make the connection between the current error and this change.
| CreateLocalizableResourceString(nameof(DoNotUseFileTypesForAnalyzersOrGeneratorsTitle)), | ||
| CreateLocalizableResourceString(nameof(DoNotUseFileTypesForAnalyzersOrGeneratorsMessage)), | ||
| DiagnosticCategory.MicrosoftCodeAnalysisCorrectness, | ||
| DiagnosticSeverity.Error, |
There was a problem hiding this comment.
If this is an error, then users do not need to make a connection between a compiler load failure and a warning.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Inspired by dotnet/roslyn#76355.
filetypes can cause errors on .NET Framework hosts, and we should just prevent these from being used. The purpose offiletypes is to not be visible outside the current file, and the purpose of analyzers is to be loaded by some other plugin system. These goals are mutually exclusive.