Skip to content

Enable use of TERM and NO_COLOR env var plaintext #14969

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
anmenaga merged 1 commit into from
Apr 13, 2021
Merged

Enable use of TERM and NO_COLOR env var plaintext #14969

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 31 additions & 1 deletion src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHostUserInterface.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,38 @@ internal ConsoleHostUserInterface(ConsoleHost parent)

_parent = parent;
_rawui = new ConsoleHostRawUserInterface(this);
SupportsVirtualTerminal = TryTurnOnVtMode();
SupportsVirtualTerminal = true;
_isInteractiveTestToolListening = false;

if (ExperimentalFeature.IsEnabled("PSAnsiRendering"))
{
// check if TERM env var is set
// `dumb` means explicitly don't use VT
// `xterm-mono` and `xtermm` means support VT, but emit plaintext
switch (Environment.GetEnvironmentVariable("TERM"))
{
case "dumb":
SupportsVirtualTerminal = false;
break;
case "xterm-mono":
case "xtermm":
PSStyle.Instance.OutputRendering = OutputRendering.PlainText;
break;
default:
break;
}

// widely supported by CLI tools via https://no-color.org/
if (Environment.GetEnvironmentVariable("NO_COLOR") != null)
{
PSStyle.Instance.OutputRendering = OutputRendering.PlainText;
}
}

if (SupportsVirtualTerminal)
{
SupportsVirtualTerminal = TryTurnOnVtMode();
}
}

internal bool TryTurnOnVtMode()
Expand Down
37 changes: 37 additions & 0 deletions test/powershell/Host/ConsoleHost.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1003,3 +1003,40 @@ Describe 'Console host name' -Tag CI {
(Get-Process -Id $PID).Name | Should -BeExactly 'pwsh'
}
}

Describe 'TERM env var' -Tag CI {
BeforeAll {
$oldTERM = $env:TERM
$PSDefaultParameterValues.Add('It:Skip', (-not $EnabledExperimentalFeatures.Contains('PSAnsiRendering')))
}

AfterAll {
$env:TERM = $oldTERM
$PSDefaultParameterValues.Remove('It:Skip')
}

It 'TERM = "dumb"' {
$env:TERM = 'dumb'
pwsh -noprofile -command '$Host.UI.SupportsVirtualTerminal' | Should -BeExactly 'False'
}

It 'TERM = "<term>"' -TestCases @(
@{ term = "xterm-mono" }
@{ term = "xtermm" }
) {
param ($term)

$env:TERM = $term
pwsh -noprofile -command '$PSStyle.OutputRendering' | Should -BeExactly 'PlainText'
}

It 'NO_COLOR' {
try {
$env:NO_COLOR = 1
pwsh -noprofile -command '$PSStyle.OutputRendering' | Should -BeExactly 'PlainText'
}
finally {
$env:NO_COLOR = $null
}
}
}