Add new analyzer for deprecating implementing an interface #7419
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
We're officially marking `ISourceGenerator` as deprecated, but we can't actually deprecate the interface, because it's used in several APIs like AnalyzerFileReference. So instead, we just add an analyzer to indicate that the interface should not be implemented. I've made this more general so we can do this with more interfaces in the future if necessary, based the implementation on InternalImplementationOnlyAnalyzer.
333fred
added a commit
to 333fred/roslyn
that referenced
this pull request
Sep 24, 2024
Analyzer that will flag implementation is dotnet/roslyn-analyzers#7419. We don't just mark `ISourceGenerator` as obsolete directly because we do use it in public APIs like `AnalyzerFileReference` and `GeneratorDriver`, and we can't remove it from there.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #7419 +/- ##
========================================
Coverage 96.50% 96.50%
========================================
Files 1443 1445 +2
Lines 346376 346598 +222
Branches 11387 11390 +3
========================================
+ Hits 334263 334488 +225
+ Misses 9232 9229 -3
Partials 2881 2881 |
chsienki
approved these changes
Sep 25, 2024
jcouv
reviewed
Sep 27, 2024
| // CodeAnalysis.dll itself has this attribute and if the user assembly also had it, symbol equality will fail | ||
| // but we should still issue the error. | ||
| if (attributes.FirstOrDefault(a => a is { AttributeClass.Name: ImplementationIsObsoleteAttributeName, ConstructorArguments: [{ Value: string }] } | ||
| && a.AttributeClass.ToDisplayString().Equals(ImplementationIsObsoleteAttributeFullName, StringComparison.Ordinal)) is { } attr && |
There was a problem hiding this comment.
This is a copy/paste from our existing DoNotImplementInternalInterfaces analyzer (the one we use to flag IOperation/ISymbol). If this was a perf problem, I would expect that to have been updated a while ago.
jcouv
reviewed
Sep 27, 2024
src/Microsoft.CodeAnalysis.Analyzers/Core/ImplementationIsObsoleteAnalyzer.cs
Show resolved
Hide resolved
jcouv
approved these changes
Sep 27, 2024
sharwell
reviewed
Sep 27, 2024
| </data> | ||
| <data name="ImplementationIsObsoleteMessage" xml:space="preserve"> | ||
| <value>Type {0} cannot implement interface {1} because {1} is obsolete for implementation. See {2} for more details.</value> |
There was a problem hiding this comment.
📝 Placeholders should be surrounded by ' (single quotes)
src/Microsoft.CodeAnalysis.Analyzers/Core/ImplementationIsObsoleteAnalyzer.cs
Show resolved
Hide resolved
333fred
added a commit
to dotnet/roslyn
that referenced
this pull request
Oct 5, 2024
* Mark ISourceGenerator as obsolete for implementation Analyzer that will flag implementation is dotnet/roslyn-analyzers#7419. We don't just mark `ISourceGenerator` as obsolete directly because we do use it in public APIs like `AnalyzerFileReference` and `GeneratorDriver`, and we can't remove it from there. * Suppress warnings * Fix attribute name * Update Microsoft.CodeAnalysis.Analyzers * Address warnings
AptiviCEO
added a commit
to Aptivi/Terminaux
that referenced
this pull request
Oct 6, 2024
--- There was a breaking change between Microsoft.CodeAnalysis.Analyzers 3.3.4 and 3.11.0 that necessitated the usage of IIncrementalGenerator according to https://github.com/dotnet/roslyn/blob/main/docs/features/source-generators.cookbook.md, https://github.com/dotnet/roslyn/blob/main/docs/features/incremental-generators.md, and dotnet/roslyn-analyzers#7419. As a result, we've made necessary changes to achieve the same result, cleaning up clutter in the process. --- Type: imp Breaking: False Doc Required: False Backport Required: False Part: 1/1
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.
We're officially marking
ISourceGeneratoras deprecated, but we can't actually deprecate the interface, because it's used in several APIs like AnalyzerFileReference. So instead, we just add an analyzer to indicate that the interface should not be implemented. I've made this more general so we can do this with more interfaces in the future if necessary, based the implementation on InternalImplementationOnlyAnalyzer.