We need to update docs https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_ansi_terminals?view=powershell-7.2

about ANSI terminals - PowerShell

Describes the features of PowerShell that use ANSI escape sequences and the terminal hosts that support them.

@PowerShell/powershell-committee Need the committee to review the breaking change comparing with 7.2.x.
Below is a summary of the breaking change. The corresponding issue is #17452.

In 7.2.x, Out-File and Out-String remove escape sequences from the passed-in strings when $PSStyle.OutputRendering is Host or PlainText.

When the passed-in object has formatting views applied to it, removing escape sequences from the resulted formatting text makes perfect sense when the output rendering option is Host and PlainText.

However, when the passed-in objects are pure strings, those 2 cmdlets shouldn't make any changes to the string objects, because

1. that will make the scenarios like (Get-Content file-a -Raw).Replace("`r`n", "`n") > file-b not working. Another example is that Set-Content and Out-File behave differently on string input under those output rendering options but they should really behave the same:

   ## Out-File changes the input strings when output rendering is `Host` or `PlainText`
   "`e[31mabc`e[0m" | Set-Content -Path .\abc.txt
   "`e[31mabc`e[0m" | Out-File -Path .\abc.txt
   

2. that also cause potential security problems as we are altering the string input when doing redirection. This was the reason why we changed the default OutputRendering option from Host to Ansi in v7.2.1

3. given that we have changed the default output rendering option back to Host in 7.3 preview, "`e[31mabc`e[0m" > .\abc.txt won't work the same as in 7.0.x and 7.2.x by default. That is a regression to 2 LTS releases.

I think the $PSStyle.OutputRendering option should only affect formatting output when it comes to Out-File and Out-String. When the input objects are pure strings, they should not be altered by Out-File or Out-String regardless of the output rendering option.

Is this going to get rid of the extra linebreak that happens too?

@ImportTaste This PR only affects escape sequences.

This PR has 66 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Label      : Small
Size       : +60 -6
Percentile : 26.4%

Total files changed: 5

Change summary by file extension:
.cs : +6 -4
.ps1 : +54 -2

Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

I agree that we should consider so, but maybe wait until we get issue reports that someone really gets affected by this breaking change.
Also, -AsPlainText may be misleading because it means "leaves the string as is" in other places where this name is used, not "removing ANSI sequences", but we can discuss this more when we really get to consider adding this parameter.

@PowerShell/powershell-committee reviewed this, we would recommend adding a parameter to enable users to get back the previous behavior.

@SteveL-MSFT Is that a requirement for this PR or could do in separate PR? Also, is that supposed to be done now or should wait until there is a report about needing the previous behavior?

Given that the recommendation is a separate feature, I think it would be fine to use a separate PR if we really decided to add a parameter for the previous behavior. I will merge this PR and open an issue for that.

Opened the issue #17509. I also left my comments there.

🎉v7.3.0-preview.5 has been released which incorporates this pull request.:tada:

Handy links:

• Release Notes

/backport to release/v7.2.6

Started backporting to release/v7.2.6: https://github.com/PowerShell/PowerShell/actions/runs/2784883343

GitHub

Make `Out-String` and `Out-File` keep string input unchanged · PowerShell/PowerShell@0e4d2e4

PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

@adityapatwardhan backporting to release/v7.2.6 failed, the patch most likely resulted in conflicts:

$ git am --3way --ignore-whitespace --keep-non-patch changes.patch

Applying: Make Out-String and Out-File keep string input unchanged
.git/rebase-apply/patch:91: trailing whitespace.
            (Get-Verb -Verb Get | Out-String).Contains("`e[") | Should -BeTrue 
warning: 1 line adds whitespace errors.
Using index info to reconstruct a base tree...
M	src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs
M	test/powershell/engine/Formatting/PSStyle.Tests.ps1
Falling back to patching base and 3-way merge...
Auto-merging test/powershell/engine/Formatting/PSStyle.Tests.ps1
CONFLICT (content): Merge conflict in test/powershell/engine/Formatting/PSStyle.Tests.ps1
Auto-merging src/System.Management.Automation/FormatAndOutput/common/ILineOutput.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Make Out-String and Out-File keep string input unchanged
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

Backport done via #17859

🎉v7.2.6 has been released which incorporates this pull request.:tada:

Handy links:

• Release Notes