-
Notifications
You must be signed in to change notification settings - Fork 511
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 SA1513 codefix to use the existing newline character sequence #3607
Update SA1513 codefix to use the existing newline character sequence #3607
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #3607 +/- ##
=======================================
Coverage 93.25% 93.25%
=======================================
Files 1077 1078 +1
Lines 113670 113713 +43
Branches 4019 4023 +4
=======================================
+ Hits 106002 106045 +43
+ Misses 6633 6632 -1
- Partials 1035 1036 +1 |
Did you have something like this in mind, @sharwell? I can imagine that some other fixers would like to use a new line which is after a specified token instead and some probably just have a span to go on. A simpler approach could be to just find the first newline in the document and use that. |
var testCode = | ||
"public class TestClass\n" + | ||
"{\n" + | ||
"}\n" + | ||
"// Hello"; |
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.
💡 You can define a ReplaceLineEndings
helper like this:
https://github.com/dotnet/roslyn/blob/f64507a8d6b6c3e01f8d1e05ce97552f3c37b341/src/Compilers/Test/Core/FX/StringExtensions.cs
This allows you to use verbatim strings like all the other tests, and just call the extension method to assign the line endings you want.
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.
Absolutely. Would you like to keep the "fancy" conversions, or just assume CRLF in the input?
|
||
DiagnosticResult[] expected = | ||
{ | ||
Diagnostic().WithLocation(3, 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.
💡 Use markup instead of separate array of expected results when there are no diagnostic arguments to test
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.
Will do
7d4dc17
to
861b432
Compare
Updated, @sharwell |
Any other comments, @sharwell? |
} | ||
} | ||
|
||
var prevToken = token.GetPreviousToken(); |
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.
💡 If there is any way to test this with a preceding #region
directive, that would be good (preprocessor directives have embedded line endings that are not EndOfLineTrivia). Will leave this for future improvement though.
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.
It looks like this rule never triggers when the closing brace is followed by a directive, so I don't see a way to test that case with this rule. But if this method will be used in other code fixers as well, then it seems reasonable to do.
[![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://togithub.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://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/releases/tag/1.2.0-beta.507) [Compare Source](https://togithub.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://togithub.com/sharwell) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3499](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3499) - Add c# 11 test project to opencover-report.ps1 by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3506](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3506) - Use GetText instead of ToFullString by [@​sharwell](https://togithub.com/sharwell) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3514](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3514) - Keep tracked nodes in a list by [@​sharwell](https://togithub.com/sharwell) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3525](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3525) - Remove unnecessary nullable directives by [@​sharwell](https://togithub.com/sharwell) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3530](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3530) - Remove hard-coded language versions in test projects for c# 8, 9 and 10 by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3528](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3528) - Update SA1515 to not let one range of trivia affect another by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3529](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3529) - Mentioned VS 2022 by [@​twojnarowski](https://togithub.com/twojnarowski) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3549](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3549) - Remove byte order mark from schema file by [@​martincostello](https://togithub.com/martincostello) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3562](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/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://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3511](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3511) - Update Microsoft.CodeAnalysis.CSharp.Workspaces to version 4.4.0 for the c# 11 test project by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3580](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3580) - Update SA1008 to handle positional patterns inside property patterns by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3579](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3579) - Update SA1000 to trigger after keywords is, or, and, not by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3585](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3585) - Update SA1000.md by [@​Youssef1313](https://togithub.com/Youssef1313) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3563](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3563) - Update SA1313 to also allow incorrect names in explicitly implemented methods from interfaces by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3569](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3569) - Update SA1023 to not trigger first in line, inside a foreach without braces by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3543](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3543) - Update SA1400 to recognize access modifier "file" by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3590](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3590) - Update SA1206 to recognize modifier "file" by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3591](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3591) - Update SA1000 to handle checked operator declarations correctly by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3505](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3505) - Update SA1402 to handle records and record structs by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3570](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3570) - Bump Newtonsoft.Json from 12.0.3 to 13.0.2 in /StyleCop.Analyzers/StyleCop.Analyzers.Status.Generator by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3584](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3584) - Update to the latest version of the testing library by [@​sharwell](https://togithub.com/sharwell) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3601](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/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://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3614](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3614) - Update reading of file_header_template and stylecop.documentation.copyrightText to allow multiple lines by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3617](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3617) - Update SA1015 to require trailing space after an explicit generic return type in a lambda expression by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3625](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3625) - Update to Microsoft.CodeAnalysis.Analyzers 3.3.5-beta1.23205.2 by [@​sharwell](https://togithub.com/sharwell) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3628](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3628) - Update SA1206 to handle c# 11 modifier "required" by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3535](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3535) - Preparations for SettingsHelper optimizations by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3635](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3635) - Correct SA1515 to not fire on the second line of a file header by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3633](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3633) - Update AnalyzersExtensions and SettingsHelper to use cached JsonValue objects where possible by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3642](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3642) - Update SA1010 to not trigger on list patterns by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3507](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3507) - Update NamingSettings and DocumentationSettings to keep one Regex instance instead of calling Regex.IsMatch by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3639](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3639) - Use ResxSourceGenerator for resource generation by [@​sharwell](https://togithub.com/sharwell) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3343](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3343) - Make XmlCommentHelper faster by [@​ninedan](https://togithub.com/ninedan) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3651](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3651) - Update RenameToUpperCaseCodeFixProvider to not offer a code fix if the identifier only consists of underscores by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3637](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3637) - Don't emit SA1414 for interface implementations by [@​CollinAlpert](https://togithub.com/CollinAlpert) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3644](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3644) - Support file-scoped namespaces in SA1516 by [@​JakubLinhart](https://togithub.com/JakubLinhart) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3513](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3513) - Update SA1137 to also consider init accessors by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3669](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3669) - Update SA1500 to also consider init accessors by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3670](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3670) - Update SA1513 to not trigger before an init accessor by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3666](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3666) - Update SA1212 to also trigger for an init accessor before a getter by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3661](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3661) - Update SA1513 codefix to use the existing newline character sequence by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3607](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3607) - Correct code fix for SA1130 when delegate expression is part of a cast expression by [@​bjornhellander](https://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3516](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/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://togithub.com/bjornhellander) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3616](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3616) - SA1629 should allow full-sentence links instead of forcing the period to glow white by [@​jnm2](https://togithub.com/jnm2) in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3371](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3371) #### New Contributors - [@​twojnarowski](https://togithub.com/twojnarowski) made their first contribution in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3549](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3549) - [@​ninedan](https://togithub.com/ninedan) made their first contribution in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3651](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3651) - [@​CollinAlpert](https://togithub.com/CollinAlpert) made their first contribution in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3644](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3644) - [@​JakubLinhart](https://togithub.com/JakubLinhart) made their first contribution in [https://github.com/DotNetAnalyzers/StyleCopAnalyzers/pull/3513](https://togithub.com/DotNetAnalyzers/StyleCopAnalyzers/pull/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 #3360