8000 Update the map between console color to VT sequences by daxian-dbw · Pull Request #11891 · PowerShell/PowerShell · GitHub
[go: up one dir, main page]
Skip to content

Update the map between console color to VT sequences #11891

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
Merged
adityapatwardhan merged 1 commit into from
Feb 20, 2020
Merged

Update the map between console color to VT sequences #11891

adityapatwardhan merged 1 commit into from
Feb 20, 2020

Conversation

@daxian-dbw
Copy link
Member
@daxian-dbw daxian-dbw commented Feb 19, 2020 •
edited
Loading

PR Summary

Update the map between console color to VT sequences.
The ConsoleColor to VT Escape Sequences mapping in VTUtils.cs is not accurate, and thus is updated according to https://docs.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences#text-formatting

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

Lines 25 to 43 in 895d4b3

private static readonly Dictionary<ConsoleColor, string> ConsoleColors = new Dictionary<ConsoleColor, string>
{
{ ConsoleColor.Black, "\x1b[2;30m" },
{ ConsoleColor.Gray, "\x1b[2;37m" },
{ ConsoleColor.Red, "\x1b[1;31m" },
{ ConsoleColor.Green, "\x1b[1;32m" },
{ ConsoleColor.Yellow, "\x1b[1;33m" },
{ ConsoleColor.Blue, "\x1b[1;34m" },
{ ConsoleColor.Magenta, "\x1b[1;35m" },
{ ConsoleColor.Cyan, "\x1b[1;36m" },
{ ConsoleColor.White, "\x1b[1;37m" },
{ ConsoleColor.DarkRed, "\x1b[2;31m" },
{ ConsoleColor.DarkGreen, "\x1b[2;32m" },
{ ConsoleColor.DarkYellow, "\x1b[2;33m" },
{ ConsoleColor.DarkBlue, "\x1b[2;34m" },
{ ConsoleColor.DarkMagenta, "\x1b[2;35m" },
{ ConsoleColor.DarkCyan, "\x1b[2;36m" },
{ ConsoleColor.DarkGray, "\x1b[1;30m" },
};

The update is needed as "Bright foreground color" (e.g. bright red \x1b[91m) is rendered differently from bold color (e.g. \x1b[1;31m) in some front-end client, such as the Jupyter Notebook client.
See the 3rd and 4th output below as an example:
image

PR Checklist

@daxian-dbw daxian-dbw added the CL-Engine Indicates that a PR should be marked as an engine change in the Change Log label Feb 19, 2020
@daxian-dbw daxian-dbw added this to the GA-consider milestone Feb 19, 2020
SteveL-MSFT
SteveL-MSFT previously requested changes Feb 20, 2020
View reviewed changes
Copy link
Member
@SteveL-MSFT SteveL-MSFT left a comment

Choose a reason for hiding this comment

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

Did you check the color rendering on Linux and/or macOS and Windows Terminal?

@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Feb 20, 2020
@daxian-dbw
Copy link
Member Author
daxian-dbw commented Feb 20, 2020

I did check on console host and win terminal, but not Linux and macOS yet. Will do that and update here.

@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Feb 20, 2020
@daxian-dbw
Copy link
Member Author
daxian-dbw commented Feb 20, 2020 •
edited
Loading

I tested the changes on console host, windows terminal, Linux terminal and macOS terminal, and all look good:

Windows console host

image

Windows terminal

image

Linux

image

macOS

Screen Shot 2020-02-20 at 11 40 15 AM

@adityapatwardhan
Copy link
Member
adityapatwardhan commented Feb 20, 2020

@SteveL-MSFT Please update your review

@TravisEz13
Copy link
Member
TravisEz13 commented Feb 20, 2020

LGTM. Let's merge so we can start the build

@daxian-dbw
Copy link
Member Author
daxian-dbw commented Feb 20, 2020

Since I have tested it on all platforms, I'm OK to merge this PR.

@adityapatwardhan
Copy link
Member
adityapatwardhan commented Feb 20, 2020

I am OK to merge this PR.

@adityapatwardhan adityapatwardhan dismissed SteveL-MSFT’s stale review February 20, 2020 22:27

The task asked in the review is complete

@adityapatwardhan adityapatwardhan merged commit da94afa into PowerShell:master Feb 20, 2020
@daxian-dbw daxian-dbw deleted the color branch February 20, 2020 22:33
@ghost
Copy link
ghost commented Feb 21, 2020

🎉v7.0.0-rc.3 has been released which incorporates this pull request.:tada:

Handy links:

silijon pushed a commit to SkyKick/PowerShell that referenced this pull request Jul 2, 2020
@daxian-dbw @TravisEz13
Update the map between console color to VT sequences (PowerShell#11891
e0c5632 
)
@iSazonov iSazonov mentioned this pull request Aug 13, 2020
Closed
@TravisEz13 TravisEz13 mentioned this pull request Oct 12, 2022
Merged
22 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SteveL-MSFT SteveL-MSFT SteveL-MSFT left review comments

Assignees

@adityapatwardhan adityapatwardhan

Labels

CL-Engine Indicates that a PR should be marked as an engine change in the Change Log

Projects

None yet

Milestone

7.0.0-rc.3

Development

Successfully merging this pull request may close these issues.

4 participants

@daxian-dbw @adityapatwardhan @TravisEz13 @SteveL-MSFT
0