-
Notifications
You must be signed in to change notification settings - Fork 506
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.
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
Update SA1010 to not trigger on list patterns #3507
Update SA1010 to not trigger on list patterns #3507
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #3507 +/- ##
=======================================
Coverage 93.26% 93.26%
=======================================
Files 1079 1080 +1
Lines 113737 113762 +25
Branches 4027 4028 +1
=======================================
+ Hits 106072 106097 +25
Misses 6630 6630
Partials 1035 1035 |
ebe9bf1
to
a5572b8
Compare
StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/SpacingRules/SA1010CSharp11UnitTests.cs
Outdated
Show resolved
Hide resolved
_ = x is [1]; | ||
_ = x is not [1]; | ||
_ = x is ([1] or [2]); | ||
_ = x is ([1] or not [2]); | ||
_ = x is ([1] and [1]); | ||
_ = x is ([1] and not [2]); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 This should be converted to a code fix test, which includes examples of various incorrect formatting that is then corrected (there is no need to separately test valid syntax, since all code fix tests automatically verify that the fixed code contains no undeclared diagnostics).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This specific analyzer only suggests to remove spaces now, never to add them. I filed #3508 a couple of days ago to update SA1000/SA1003 to get a diagnostic where a space is missing, but that might be a mistake. Not sure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interesting. Based on other analyzers (e.g. {
used in property patterns), SA1010 would be the analyzer that wants to add the space here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this seems to be in line with the current implementation, would it be ok to merge this if I create another issue to investigate the resposibility of this analyzer?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you want to do, @sharwell?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💭 Is this analyzer not responsible for reporting a this?
x is ( [1]);
^
In #3511 a very similar scenario does report a diagnostic.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The only diagnostic I would like to see in that example is SA1008. I am thinking that the list pattern's opening bracket itself should not trigger any opinion about preceding space, anymore than a literal value does. It is always something else that is causing the opinion, like a preceding open parenthesis, operator, keyword, etc. Before this PR, your example would trigger both SA1008 and SA1010. Is that a behaviour that you would like to keep? I could very well not be seeing the whole picture here, but I feel that not having an opinion at all is the correct behaviour for this rule in this specific case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I actually feel the same way about the property pattern changes made in SA1012, now that I think of it. I assume that both these statements will trigger two diagnostics:
_ = x is ( { P: 0 }, { P: 0 }) // SA1008 and SA1012
_ = x is [ { P: 0 }, { P: 0 }] // SA1010 and SA1012
With my thinking, only SA1008 and SA1010 should be triggered.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Returning to SA1010 again, there was already a similar case implemented where this code only triggers SA1012 and not SA1010:
var test = new Dictionary<ulong, string>() {[100] = "100" };
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
76772c8
to
7e25f23
Compare
Would you be interested in fixing #3509 at the same time? |
7e25f23
to
94243e6
Compare
I rebased this since it was getting old and turned the test into a theory to make it easier to debug |
Thanks! |
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [StyleCop.Analyzers](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) | nuget | patch | `1.2.0-beta.435` -> `1.2.0-beta.507` | --- ### Release Notes <details> <summary>DotNetAnalyzers/StyleCopAnalyzers</summary> ### [`v1.2.0-beta.507`](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/releases/tag/1.2.0-beta.507) [Compare Source](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.435...1.2.0-beta.507) #### What's Changed - Update to StyleCop.Analyzers 1.2.0-beta.435 by [@​sharwell](https://github.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3499 - Add c# 11 test project to opencover-report.ps1 by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3506 - Use GetText instead of ToFullString by [@​sharwell](https://github.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3514 - Keep tracked nodes in a list by [@​sharwell](https://github.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3525 - Remove unnecessary nullable directives by [@​sharwell](https://github.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3530 - Remove hard-coded language versions in test projects for c# 8, 9 and 10 by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3528 - Update SA1515 to not let one range of trivia affect another by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3529 - Mentioned VS 2022 by [@​twojnarowski](https://github.com/twojnarowski) in [DotNetAnalyzers/StyleCopAnalyzers#3549 - Remove byte order mark from schema file by [@​martincostello](https://github.com/martincostello) in [DotNetAnalyzers/StyleCopAnalyzers#3562 - Update SA1012 to expect no space between a property pattern's opening brace and an enclosing list pattern's opening bracket by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3511 - Update Microsoft.CodeAnalysis.CSharp.Workspaces to version 4.4.0 for the c# 11 test project by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3580 - Update SA1008 to handle positional patterns inside property patterns by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3579 - Update SA1000 to trigger after keywords is, or, and, not by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3585 - Update SA1000.md by [@​Youssef1313](https://github.com/Youssef1313) in [DotNetAnalyzers/StyleCopAnalyzers#3563 - Update SA1313 to also allow incorrect names in explicitly implemented methods from interfaces by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3569 - Update SA1023 to not trigger first in line, inside a foreach without braces by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3543 - Update SA1400 to recognize access modifier "file" by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3590 - Update SA1206 to recognize modifier "file" by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3591 - Update SA1000 to handle checked operator declarations correctly by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3505 - Update SA1402 to handle records and record structs by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3570 - Bump Newtonsoft.Json from 12.0.3 to 13.0.2 in /StyleCop.Analyzers/StyleCop.Analyzers.Status.Generator by [@​dependabot](https://github.com/dependabot) in [DotNetAnalyzers/StyleCopAnalyzers#3584 - Update to the latest version of the testing library by [@​sharwell](https://github.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3601 - Update so that SA1600 tests will be run with the expected language version in test projects for c# 8 and above by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3614 - Update reading of file_header_template and stylecop.documentation.copyrightText to allow multiple lines by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3617 - Update SA1015 to require trailing space after an explicit generic return type in a lambda expression by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3625 - Update to Microsoft.CodeAnalysis.Analyzers 3.3.5-beta1.23205.2 by [@​sharwell](https://github.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3628 - Update SA1206 to handle c# 11 modifier "required" by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3535 - Preparations for SettingsHelper optimizations by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3635 - Correct SA1515 to not fire on the second line of a file header by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3633 - Update AnalyzersExtensions and SettingsHelper to use cached JsonValue objects where possible by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3642 - Update SA1010 to not trigger on list patterns by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3507 - Update NamingSettings and DocumentationSettings to keep one Regex instance instead of calling Regex.IsMatch by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3639 - Use ResxSourceGenerator for resource generation by [@​sharwell](https://github.com/sharwell) in [DotNetAnalyzers/StyleCopAnalyzers#3343 - Make XmlCommentHelper faster by [@​ninedan](https://github.com/ninedan) in [DotNetAnalyzers/StyleCopAnalyzers#3651 - Update RenameToUpperCaseCodeFixProvider to not offer a code fix if the identifier only consists of underscores by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3637 - Don't emit SA1414 for interface implementations by [@​CollinAlpert](https://github.com/CollinAlpert) in [DotNetAnalyzers/StyleCopAnalyzers#3644 - Support file-scoped namespaces in SA1516 by [@​JakubLinhart](https://github.com/JakubLinhart) in [DotNetAnalyzers/StyleCopAnalyzers#3513 - Update SA1137 to also consider init accessors by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3669 - Update SA1500 to also consider init accessors by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3670 - Update SA1513 to not trigger before an init accessor by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3666 - Update SA1212 to also trigger for an init accessor before a getter by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3661 - Update SA1513 codefix to use the existing newline character sequence by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3607 - Correct code fix for SA1130 when delegate expression is part of a cast expression by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3516 - Update so that c# 7 tests will be run with the expected language version in test projects for c# 8 and above by [@​bjornhellander](https://github.com/bjornhellander) in [DotNetAnalyzers/StyleCopAnalyzers#3616 - SA1629 should allow full-sentence links instead of forcing the period to glow white by [@​jnm2](https://github.com/jnm2) in [DotNetAnalyzers/StyleCopAnalyzers#3371 #### New Contributors - [@​twojnarowski](https://github.com/twojnarowski) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3549 - [@​ninedan](https://github.com/ninedan) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3651 - [@​CollinAlpert](https://github.com/CollinAlpert) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3644 - [@​JakubLinhart](https://github.com/JakubLinhart) made their first contribution in [DotNetAnalyzers/StyleCopAnalyzers#3513 **Full Changelog**: DotNetAnalyzers/StyleCopAnalyzers@1.2.0-beta.435...1.2.0-beta.507 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 4am" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/ThorstenSauter/NoPlan). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xMzEuMCIsInVwZGF0ZWRJblZlciI6IjM1LjEzMS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Thorsten Sauter <Thorsten.Sauter@gmail.com>
Fixes #3503