Add `$env:__SuppressAnsiEscapeSequences` to control whether to have VT escape sequence in output by SteveL-MSFT · Pull Request #10814 · PowerShell/PowerShell · GitHub

PR Summary

After some discussion, we decided we want to spend more time on the design for customer facing use. Since we need this due to issues with AzDevOps pipelines having some rendering problems, we will make it an undocumented env var for now to use internally and revisit this post PS7 as part of #10811.

Introduce $env:__SuppressAnsiEscapeSequences to suppress VT escape sequences in their output. Updated Select-String, ConciseView, and Get-Error to respect this variable. Also added helper to retrieve VT escape sequences.

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
This PR is ready to merge and is not Work in Progress.
- If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
Breaking changes
- None
- OR
- Experimental feature(s) needed
  - Experimental feature name(s):
User-facing changes
- Not Applicable
- OR
- Documentation needed
  - Issue filed: Document $OutputPreference MicrosoftDocs/PowerShell-Docs#4947
Testing - New and feature
- N/A or can only be tested interactively
- OR
- Make sure you've added a new test if existing tests do not effectively test the code changed
Tooling
- I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
- OR
- I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include:
  - Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode (which runs in a different PS Host).
  - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
  - Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
  - Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).

update select-string cmdlet to support this update ConciseView to support this update Get-Error to support this add tests

…sting code

LGTM

… variable

The remaining CodeFactor issue is wrong. Looks like it's looking at an older version of that source file.

Co-Authored-By: Joel Sallow (/u/ta11ow) <32407840+vexx32@users.noreply.github.com>

…into outputpreference

Remaining Codacy issues are by-design

Why not add a command line option instead?

It's somewhat common to support an option like --color [always|auto|never].

Jason Shirk (@lzybkr) This would cause this to be needed in a lot of places in testing.

Jason Shirk (@lzybkr) you mean cmdline option to pwsh?

Steve Lee (@SteveL-MSFT) - exactly. There are many tools that have such an option, mostly with the same syntax and options - here's a sampling:

…rShell#10814)

🎉v7.0.0-preview.6 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

…rShell#10814)

add $OutputPreference to control whether to have VT escape seq in output

753531d

update select-string cmdlet to support this update ConciseView to support this update Get-Error to support this add tests

Steve Lee (SteveL-MSFT) requested a review from Dongbo Wang (daxian-dbw) October 17, 2019 05:38

Steve Lee (SteveL-MSFT) assigned Travis Plunk (TravisEz13) Oct 17, 2019

Steve Lee (SteveL-MSFT) mentioned this pull request Oct 17, 2019

Document $OutputPreference MicrosoftDocs/PowerShell-Docs#4947

Closed

address soem CodeFactor issues, but rest are for consistency with exi…

696a009

…sting code

PoshChan-Bot (PoshChan) reviewed Oct 17, 2019

View reviewed changes

Comment thread src/Microsoft.PowerShell.Commands.Utility/commands/utility/MatchString.cs

PoshChan-Bot (PoshChan) reviewed Oct 17, 2019

View reviewed changes

Comment thread src/Microsoft.PowerShell.Commands.Utility/commands/utility/MatchString.cs

Ilya (iSazonov) reviewed Oct 17, 2019

View reviewed changes

Comment thread src/System.Management.Automation/utils/VTUtils.cs Outdated

Paul Higinbotham (PaulHigin) suggested changes Oct 17, 2019

View reviewed changes

ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Oct 17, 2019

address Paul's feedback

a981c59

Paul Higinbotham (PaulHigin) approved these changes Oct 17, 2019

View reviewed changes

Steve Lee (SteveL-MSFT) changed the title Add $OutputPreference to control whether to have VT escape sequence in output Add $env:SuppressAnsiEscapeSequences to control whether to have VT escape sequence in output Oct 18, 2019

Steve Lee (SteveL-MSFT) changed the title Add $env:SuppressAnsiEscapeSequences to control whether to have VT escape sequence in output Add $env:__SuppressAnsiEscapeSequences to control whether to have VT escape sequence in output Oct 18, 2019

Steve Lee (SteveL-MSFT) requested a review from Travis Plunk (TravisEz13) October 18, 2019 19:58

Steve Lee (SteveL-MSFT) added 3 commits October 18, 2019 13:13

change to use $env:__SuppressAnsiEscapeSequences instead of automatic…

4a67fe2

… variable

fix tests

4a10b30

address CodeFactor

a8c396e

Rain Sallow (/u/ta11ow) (vexx32) reviewed Oct 18, 2019

View reviewed changes

Comment thread src/System.Management.Automation/utils/VTUtils.cs Outdated

Travis Plunk (TravisEz13) requested changes Oct 18, 2019

View reviewed changes

Comment thread ...stem.Management.Automation/FormatAndOutput/DefaultFormatters/PowerShellCore_format_ps1xml.cs

Comment thread test/powershell/Modules/Microsoft.PowerShell.Utility/Select-String.Tests.ps1 Outdated

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Oct 18, 2019

Update src/System.Management.Automation/utils/VTUtils.cs

847b288

Co-Authored-By: Joel Sallow (/u/ta11ow) <32407840+vexx32@users.noreply.github.com>

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Oct 18, 2019

Steve Lee (SteveL-MSFT) added 2 commits October 18, 2019 14:06

address Travis' feedback

3e980bb

Merge branch 'outputpreference' of github.com:SteveL-MSFT/PowerShell …

630a9f3

…into outputpreference

Steve Lee (SteveL-MSFT) requested review from Aditya Patwardhan (adityapatwardhan) and Andrew (anmenaga) as code owners October 18, 2019 21:07

fix codacy issues

6371cee

PoshChan-Bot (PoshChan) reviewed Oct 18, 2019

View reviewed changes

Comment thread .vsts-ci/linux.yml

fix select-string tests

2c5b4a9

Travis Plunk (TravisEz13) approved these changes Oct 21, 2019

View reviewed changes

Steve Lee (SteveL-MSFT) mentioned this pull request Oct 21, 2019

Pester fails to generate logs after changes to error format #10809

Closed

Travis Plunk (TravisEz13) merged commit 4ff9924 into PowerShell:master Oct 24, 2019

Steve Lee (SteveL-MSFT) deleted the outputpreference branch October 24, 2019 20:42

Ryan Yates (kilasuit) pushed a commit to kilasuit/PowerShell that referenced this pull request Nov 9, 2019

Add $env:__SuppressAnsiEscapeSequences to control whether to… (Powe…

df9e0f2

…rShell#10814)

Paul Higinbotham (PaulHigin) added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Nov 19, 2019

Paul Higinbotham (PaulHigin) added this to the 7.0.0-preview.6 milestone Nov 19, 2019

Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj/PowerShell that referenced this pull request Aug 6, 2026

Add $env:__SuppressAnsiEscapeSequences to control whether to… (Powe…

1cd854c

…rShell#10814)

Add `$env:__SuppressAnsiEscapeSequences` to control whether to have VT escape sequence in output by SteveL-MSFT · Pull Request #10814 · PowerShell/PowerShell · GitHub

Uh oh!

Add $env:__SuppressAnsiEscapeSequences to control whether to have VT escape sequence in output - #10814

Add $env:__SuppressAnsiEscapeSequences to control whether to have VT escape sequence in output#10814Travis Plunk (TravisEz13) merged 11 commits intoPowerShell:masterPowerShell/PowerShell:masterfrom SteveL-MSFT:outputpreferenceSteveL-MSFT/PowerShell:outputpreferenceCopy head branch name to clipboard

Conversation

Steve Lee (SteveL-MSFT) commented Oct 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Paul Higinbotham (PaulHigin) left a comment

Choose a reason for hiding this comment

Uh oh!

Steve Lee (SteveL-MSFT) commented Oct 18, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Steve Lee (SteveL-MSFT) commented Oct 18, 2019

Uh oh!

Uh oh!

Jason Shirk (lzybkr) commented Oct 23, 2019

Uh oh!

Travis Plunk (TravisEz13) commented Oct 24, 2019

Uh oh!

Steve Lee (SteveL-MSFT) commented Oct 24, 2019

Uh oh!

Jason Shirk (lzybkr) commented Oct 24, 2019

Uh oh!

Deleted user (ghost) commented Nov 21, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Add $env:__SuppressAnsiEscapeSequences to control whether to have VT escape sequence in output#10814
Travis Plunk (TravisEz13) merged 11 commits into
PowerShell:masterfrom
SteveL-MSFT:outputpreference

Steve Lee (SteveL-MSFT) commented Oct 17, 2019 •
edited
Loading