Add an analyzer that warns about non-literal sequence numbers #35805
Conversation
This file contains hidden or 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
ghost
added
the
area-infrastructure
MackinnonBuck
commented
Aug 26, 2021
src/Framework/Analyzer/src/RenderTreeBuilder/DiagnosticDescriptors.cs
Outdated
Show resolved
Hide resolved
pranavkm
reviewed
Aug 27, 2021
There was a problem hiding this comment.
The changes look great. I'd prefer if @SteveSandersonMS to sign off on this to see if there was more / less we should be doing here.
src/Framework/Analyzer/src/RenderTreeBuilder/DiagnosticDescriptors.cs
Outdated
Show resolved
Hide resolved
src/Framework/Analyzer/src/RenderTreeBuilder/DiagnosticDescriptors.cs
Outdated
Show resolved
Hide resolved
src/Framework/Analyzer/src/RenderTreeBuilder/DiagnosticDescriptors.cs
Outdated
Show resolved
Hide resolved
src/Framework/Analyzer/src/RenderTreeBuilder/RenderTreeBuilderAnalyzer.cs
Outdated
Show resolved
Hide resolved
src/Framework/Analyzer/test/Components/DisallowNonLiteralSequenceNumbersTest.cs
Show resolved
Hide resolved
SteveSandersonMS
approved these changes
Sep 3, 2021
Applying the change in main.
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.
Add an analyzer that warns about non-literal sequence numbers
The analyzer warns when using anything other than integer literals for sequence numbers in
RenderTreeBuildermethods.Potential improvements to consider
There are definitely situations where it's appropriate for developers to use non-literals as the sequence number (e.g.
RenderTreeBuilderextension methods that accept asequenceand pass it to aRenderTreeBuildermethod). In such cases, should we expect developers to suppress the warning, or should we attempt something smarter? For example, if the argument passed as the sequence number is itself a parameter of the containing method, should we perform the same analysis on the method containing theRenderTreeBuildermethod invocation? Should we go even further and ensure that the parameter is not reassigned anywhere in the containing method?Fixes #14579