Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update SA1513 codefix to use the existing newline character sequence #3607

Merged
merged 1 commit into from
Jun 21, 2023
Merged

Update SA1513 codefix to use the existing newline character sequence #3607

merged 1 commit into from
Jun 21, 2023

Conversation

bjornhellander
Copy link
Contributor

Fixes #3360

@codecov
Copy link

codecov bot commented Feb 25, 2023 •
edited

Codecov Report

Merging #3607 (2678b86) into master (50610bc) will increase coverage by 0.00%.
The diff coverage is 93.18%.

❗ Current head 2678b86 differs from pull request most recent head 861b432. Consider uploading reports for the commit 861b432 to get more accurate results

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

@bjornhellander
Copy link
Contributor Author

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.

sharwell
sharwell reviewed Mar 6, 2023
View reviewed changes
StyleCop.Analyzers/StyleCop.Analyzers.Test/LayoutRules/SA1513UnitTests.cs Outdated
Comment on lines 1021 to 1025
var testCode =
"public class TestClass\n" +
"{\n" +
"}\n" +
"// Hello";
Copy link
Member

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.

Copy link
Contributor Author

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?

sharwell
sharwell reviewed Mar 6, 2023
View reviewed changes
StyleCop.Analyzers/StyleCop.Analyzers.Test/LayoutRules/SA1513UnitTests.cs Outdated

DiagnosticResult[] expected =
{
Diagnostic().WithLocation(3, 2),
Copy link
Member

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will do

@bjornhellander
Copy link
Contributor Author

Updated, @sharwell

@bjornhellander
Copy link
Contributor Author

Any other comments, @sharwell?

sharwell
sharwell reviewed Jun 21, 2023
View reviewed changes
StyleCop.Analyzers/StyleCop.Analyzers/Helpers/TokenHelper.cs
}
}

var prevToken = token.GetPreviousToken();
Copy link
Member

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.

Copy link
Contributor Author

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.

@sharwell sharwell merged commit ec1112e into DotNetAnalyzers:master Jun 21, 2023
@sharwell sharwell added this to the 1.2-beta.next milestone Jun 21, 2023
@bjornhellander bjornhellander deleted the feature/sa1513-linefeed branch June 21, 2023 18:42
ThorstenSauter added a commit to ThorstenSauter/NoPlan that referenced this pull request Jun 22, 2023
@renovate @ThorstenSauter
Update dependency StyleCop.Analyzers to v1.2.0-beta.507 (#463)
05ac919 
[![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
[@&#8203;sharwell](https://togithub.com/sharwell) in
[DotNetAnalyzers/StyleCopAnalyzers#3499
- Add c# 11 test project to opencover-report.ps1 by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3506
- Use GetText instead of ToFullString by
[@&#8203;sharwell](https://togithub.com/sharwell) in
[DotNetAnalyzers/StyleCopAnalyzers#3514
- Keep tracked nodes in a list by
[@&#8203;sharwell](https://togithub.com/sharwell) in
[DotNetAnalyzers/StyleCopAnalyzers#3525
- Remove unnecessary nullable directives by
[@&#8203;sharwell](https://togithub.com/sharwell) in
[DotNetAnalyzers/StyleCopAnalyzers#3530
- Remove hard-coded language versions in test projects for c# 8, 9 and
10 by [@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3528
- Update SA1515 to not let one range of trivia affect another by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3529
- Mentioned VS 2022 by
[@&#8203;twojnarowski](https://togithub.com/twojnarowski) in
[DotNetAnalyzers/StyleCopAnalyzers#3549
- Remove byte order mark from schema file by
[@&#8203;martincostello](https://togithub.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
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3511
- Update Microsoft.CodeAnalysis.CSharp.Workspaces to version 4.4.0 for
the c# 11 test project by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3580
- Update SA1008 to handle positional patterns inside property patterns
by [@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3579
- Update SA1000 to trigger after keywords is, or, and, not by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3585
- Update SA1000.md by
[@&#8203;Youssef1313](https://togithub.com/Youssef1313) in
[DotNetAnalyzers/StyleCopAnalyzers#3563
- Update SA1313 to also allow incorrect names in explicitly implemented
methods from interfaces by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3569
- Update SA1023 to not trigger first in line, inside a foreach without
braces by [@&#8203;bjornhellander](https://togithub.com/bjornhellander)
in
[DotNetAnalyzers/StyleCopAnalyzers#3543
- Update SA1400 to recognize access modifier "file" by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3590
- Update SA1206 to recognize modifier "file" by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3591
- Update SA1000 to handle checked operator declarations correctly by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3505
- Update SA1402 to handle records and record structs by
[@&#8203;bjornhellander](https://togithub.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
[@&#8203;dependabot](https://togithub.com/dependabot) in
[DotNetAnalyzers/StyleCopAnalyzers#3584
- Update to the latest version of the testing library by
[@&#8203;sharwell](https://togithub.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
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3614
- Update reading of file_header_template and
stylecop.documentation.copyrightText to allow multiple lines by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3617
- Update SA1015 to require trailing space after an explicit generic
return type in a lambda expression by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3625
- Update to Microsoft.CodeAnalysis.Analyzers 3.3.5-beta1.23205.2 by
[@&#8203;sharwell](https://togithub.com/sharwell) in
[DotNetAnalyzers/StyleCopAnalyzers#3628
- Update SA1206 to handle c# 11 modifier "required" by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3535
- Preparations for SettingsHelper optimizations by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3635
- Correct SA1515 to not fire on the second line of a file header by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3633
- Update AnalyzersExtensions and SettingsHelper to use cached JsonValue
objects where possible by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3642
- Update SA1010 to not trigger on list patterns by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3507
- Update NamingSettings and DocumentationSettings to keep one Regex
instance instead of calling Regex.IsMatch by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3639
- Use ResxSourceGenerator for resource generation by
[@&#8203;sharwell](https://togithub.com/sharwell) in
[DotNetAnalyzers/StyleCopAnalyzers#3343
- Make XmlCommentHelper faster by
[@&#8203;ninedan](https://togithub.com/ninedan) in
[DotNetAnalyzers/StyleCopAnalyzers#3651
- Update RenameToUpperCaseCodeFixProvider to not offer a code fix if the
identifier only consists of underscores by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3637
- Don't emit SA1414 for interface implementations by
[@&#8203;CollinAlpert](https://togithub.com/CollinAlpert) in
[DotNetAnalyzers/StyleCopAnalyzers#3644
- Support file-scoped namespaces in SA1516 by
[@&#8203;JakubLinhart](https://togithub.com/JakubLinhart) in
[DotNetAnalyzers/StyleCopAnalyzers#3513
- Update SA1137 to also consider init accessors by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3669
- Update SA1500 to also consider init accessors by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3670
- Update SA1513 to not trigger before an init accessor by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3666
- Update SA1212 to also trigger for an init accessor before a getter by
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3661
- Update SA1513 codefix to use the existing newline character sequence
by [@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3607
- Correct code fix for SA1130 when delegate expression is part of a cast
expression by
[@&#8203;bjornhellander](https://togithub.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
[@&#8203;bjornhellander](https://togithub.com/bjornhellander) in
[DotNetAnalyzers/StyleCopAnalyzers#3616
- SA1629 should allow full-sentence links instead of forcing the period
to glow white by [@&#8203;jnm2](https://togithub.com/jnm2) in
[DotNetAnalyzers/StyleCopAnalyzers#3371

#### New Contributors

- [@&#8203;twojnarowski](https://togithub.com/twojnarowski) made their
first contribution in
[DotNetAnalyzers/StyleCopAnalyzers#3549
- [@&#8203;ninedan](https://togithub.com/ninedan) made their first
contribution in
[DotNetAnalyzers/StyleCopAnalyzers#3651
- [@&#8203;CollinAlpert](https://togithub.com/CollinAlpert) made their
first contribution in
[DotNetAnalyzers/StyleCopAnalyzers#3644
- [@&#8203;JakubLinhart](https://togithub.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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sharwell sharwell sharwell approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
1.2.0-beta.507
Development

Successfully merging this pull request may close these issues.

Applying autofixes uses wrong line endings / should honour .editorconfig
2 participants
@bjornhellander @sharwell