Skip to content

Preserve CR-only line endings when formatting files #2234

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

Merged
Christoph Bergmeister (bergmeister) merged 3 commits into from
Oct 23, 2026
Merged

Preserve CR-only line endings when formatting files #2234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6a710f0
Initial plan
Copilot Oct 23, 2026
9cb9639
Handle CR-only formatter line endings
Copilot Oct 23, 2026
e6c9134
Make legacy encoding fixture source-independent
Copilot Oct 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Engine/Commands/InvokeFormatterCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@
using System.Collections.Generic;
using System.IO;
using System.Globalization;
using System.Linq;
using System.Text;
using System.Management.Automation;
using System.Management.Automation.Language;
using Microsoft.Windows.PowerShell.ScriptAnalyzer.Extensions;

namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands
{
Expand Down Expand Up @@ -239,7 +241,7 @@ private static string GetIndentationKind(string scriptDefinition)
int spaceIndentedLines = 0;
string firstIndentationKind = "space";
bool foundIndentation = false;
string[] lines = scriptDefinition.Split('\n');
string[] lines = scriptDefinition.GetLines().ToArray();
Parser.ParseInput(scriptDefinition, out Token[] tokens, out ParseError[] errors);
var countedLines = new HashSet<int>();

Expand Down
2 changes: 1 addition & 1 deletion Engine/Extensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public static class Extensions
/// <returns></returns>
public static IEnumerable<string> GetLines(this string text)
{
return text.Split('\n').Select(line => line.TrimEnd('\r'));
return text.Split(new[] { "\r\n", "\r", "\n" }, StringSplitOptions.None);
}

/// <summary>
Expand Down
16 changes: 14 additions & 2 deletions Tests/Engine/InvokeFormatter.tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,22 @@ Describe "Invoke-Formatter Cmdlet" {
[System.IO.File]::ReadAllBytes($path)[0..1] | Should -Be @(255, 254)
}

It 'Formats a file with CR-only line endings' {
$path = Join-Path $TestDrive 'cr-only.ps1'
$scriptDefinition = "function foo {`r`t`$x=1`r}"
$expected = "function foo {`r`t`$x = 1`r}"
[System.IO.File]::WriteAllText($path, $scriptDefinition)

Invoke-Formatter -Path $path | Should -Be $expected

[System.IO.File]::ReadAllText($path) | Should -Be $expected
}

It 'Best-effort formats BOM-less files using a legacy encoding' {
$path = Join-Path $TestDrive 'legacy-encoding.ps1'
$scriptDefinition = '$name=''café'''
$expected = '$name = ''café'''
$cafe = 'caf' + [char]0xE9
$scriptDefinition = "`$name='$cafe'"
$expected = "`$name = '$cafe'"
$encoding = [System.Text.Encoding]::GetEncoding(1252)
[System.IO.File]::WriteAllBytes($path, $encoding.GetBytes($scriptDefinition))

Expand Down
Loading