Do not simplify type name to a type with the EditorBrowsable attribute on it. #75235
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
dotnet-issue-labeler
bot
added
Area-IDE
untriaged
CyrusNajmabadi
commented
Sep 25, 2024
| switch (expression.Kind()) | ||
| // Ensure that replacement doesn't change semantics. | ||
| var speculationAnalyzer = new SpeculationAnalyzer(expression, replacementNode, semanticModel, cancellationToken); | ||
| return !speculationAnalyzer.ReplacementChangesSemantics(); |
There was a problem hiding this comment.
removed helper method and pulled this to common location.
CyrusNajmabadi
commented
Sep 25, 2024
| } | ||
|
|
||
| enclosingSymbol = enclosingSymbol.ContainingSymbol; | ||
| } |
There was a problem hiding this comment.
this entire while loop did absolutely nothing.
CyrusNajmabadi
commented
Sep 25, 2024
| @@ -40,7 +40,7 @@ public override bool TrySimplify( | |||
| replacementNode = null; | |||
| issueSpan = default; | |||
|
|
|||
| if (expression is MemberAccessExpressionSyntax { Expression.RawKind: (int)SyntaxKind.ThisExpression } memberAccessExpression) | |||
| if (expression is MemberAccessExpressionSyntax(SyntaxKind.ThisExpression) memberAccessExpression) | |||
There was a problem hiding this comment.
simpler pattern form, without unnecessary casts.
CyrusNajmabadi
commented
Sep 25, 2024
|
|
||
| if (TrySimplifyMemberAccessOrQualifiedName(memberAccess.Expression, memberAccess.Name, semanticModel, out var newLeft, out issueSpan)) | ||
| switch (expression) |
There was a problem hiding this comment.
view with whitespace off.
CyrusNajmabadi
commented
Sep 25, 2024
| // replacement node might not be in it's simplest form, so add simplify annotation to it. | ||
| replacementNode = memberAccess.Update(newLeft, memberAccess.OperatorToken, memberAccess.Name) | ||
| .WithAdditionalAnnotations(Simplifier.Annotation); | ||
|
|
||
| // Ensure that replacement doesn't change semantics. | ||
| return !ReplacementChangesSemantics(memberAccess, replacementNode, semanticModel); |
There was a problem hiding this comment.
the two calls to ReplacementChangesSemantics were pulled up and then inlined.
CyrusNajmabadi
commented
Sep 25, 2024
| // Don't simplify to a base type if it has the EditorBrowsable attribute on it. This is | ||
| // occasionally done in some APIs to have a 'pseudo internal' base type that has functionality, | ||
| // which a user is supposed to only access through some 'pseudo public' derived type instead. | ||
| if (!containingType.IsEditorBrowsable(hideAdvancedMembers: true, semanticModel.Compilation, includingSourceSymbols: true)) |
akhera99
approved these changes
Sep 25, 2024
This was referenced Sep 27, 2024
bzd3y
referenced
this pull request
in dotnet/android
Oct 14, 2024
…IDE (#9310) Context: #8381 Add a `DiagnosticSuppressor` to "turn off" the `IDE0002` style diagnostic message which incorrectly tells users to use the `_Microsoft.Android.Resource.Designer.ResourceConstant` type directly. This can cause allot of annoyance with our users because it appears on EVERY single usage of `Resource.*`. So you end up with what looks like code spagetti. So we need to start shipping an `Analyzer` assembly along with the `Ref` framework pack. This is the place these things need to go. Unfortunately it means that the older frameworks will not get this analyzer. Only the current one. On the packaging side, the Analyzer assembly has to go in a `analyzers/dotnet/<language>` folder in the .Ref Nuget Package. There also needs to be an entry in the `FrameworkList.xml` file which has a `Type="Analyzer" ` and a `Language="cs"`. This allows the IDE's to pickup the code. We can ship both regular Analyzers and the DiagnosticSuppressors in the same assembly. So we can extend this with more if needed. How this works is we use Rosyln to look for the IDE0002 diagnsotic message, we then check the code and see if it is refering to a `_Microsoft.Android.Resource.Designer.*` derived class. If it is , we add a suppression. This will stop the hint appearing in the IDE. I have tested this on VS in devbox and it appears to work . Also we generate a Resource Designer assembly and an Intermediate source file at build time. Both of these contain classes which should have the `GeneratedCode` Attribute. So lets add it. The version will be the same as the build assembly used to generate it.
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.
Fixes #75162