Update terminal environment variables to detect colors #27609

BridgeAR · 2019-05-08T06:17:10Z

Right now we have a pretty decent list of environment variables to detect different terminals that support colors. However, it is often not exactly known from what version on these terminals actually support the colors, if that's detectable and how many colors these support.

I would like to start a list of different terminals / CIs and other things including their corresponding environment variables or other information to detect these and the information how many colors they support.

The current code can be found here: https://github.com/nodejs/node/blob/master/lib/internal/tty.js

A lot of information about terminals that support 16 million colors can be found here: https://github.com/termstandard/colors

Anyone can please check their terminal and post the name, version, corresponding env settings (not all) and the supported colors. This should be pretty straight forward and a good first contribution! The more information we gather here, the better Node.js will become in properly supporting colors.

Just enter the following in your terminal to check for true color:

printf "\x1b[38;2;255;100;0mTRUECOLOR\x1b[0m\n"

Update: Please make sure you check what environment variables are set by your terminal! That is important since not all correspond to $TERM but some also to e.g., $TERM_PROGRAM. You can check what environment variables are set by running: node -e 'console.log(process.env)'. You have to check what environment variables correspond to the terminal. Please do not post any environment variables besides those.

mscdex · 2019-05-08T08:09:34Z

VTE-based terminals should automatically export VTE_VERSION with the VTE version value (e.g. 5202 for v0.52.2).

However, other terminals like qterminal (which does support truecolor) don't set anything, not even COLORTERM currently.

Something else to keep in mind is that environment variables like these typically are not allowed to pass through on SSH connections.

rpgeeganage · 2019-05-08T19:15:14Z

@BridgeAR ,
May I give this a try? (I hope this only in Javascript code :) )

BridgeAR · 2019-05-08T19:42:10Z

@rpgeeganage please go for it. It is all JS. This is mainly meant as a tracking issue.

@mscdex it's definitely not a fool prove solution. I tried very hard to come up with anything or find something but this seemed to be the best we can do so far. If there's any reliable alternative (even only to reliable detect a few terminals), we should go for that instead.

rpgeeganage · 2019-05-08T19:46:27Z

@BridgeAR
Thank you very much. I'll start working on it probably from tomorrow onward.

3mard · 2019-05-13T14:52:02Z

Can I give this a try ? :)

rpgeeganage · 2019-05-13T15:14:48Z

@3mard ,
Please go ahead, Thanks a lot.

dlionz · 2019-05-15T22:01:55Z

Hello, Id like to give this a go as well, but I'm not entirely sure what is expected.

is it just as simple as adding my Terminal name to the TERM_ENVS object and the colors it supports?

BridgeAR · 2019-05-15T22:07:11Z

@dlionz that is pretty much exactly what's required. We could also start a list here.

dlionz · 2019-05-15T22:16:31Z

@BridgeAR, thanks for the quick response.

Ok, I'm using iTerm2, and I ran the script above printf "\x1b[38;2;255;100;0mTRUECOLOR\x1b[0m\n"
and it returns 'TURECOLOR'. Here is also a screen cap of my terminal running this function from the docs above about terminal color.

is this all that is needed?

dlionz · 2019-05-15T23:02:15Z

@BridgeAR I went ahead and created this PR tty: add color support for iterm2 #27722 please let me know if there is anything I can do if there is an issue.

thanks,
Damien

rpgeeganage · 2019-05-15T23:12:01Z

@dlionz,
Your PR seems to be not following the contributing guideline. Can you please check it?

dlionz · 2019-05-15T23:16:15Z

@rpgeeganage Yeah can do, just realized I did it wrong.

dlionz · 2019-05-15T23:37:56Z

@rpgeeganage corrected my pr
tty: add color support for iterm2 #27723

dmaynard51 · 2019-05-19T05:33:04Z

I wanted to give it a shot to see if I could contribute in some way (my first time). I added my screenshot below of my terminal screen (using AWS - cloud9).

tacoto12 · 2019-05-19T05:47:41Z

Maximus Brewer has sent you an email via Gmail confidential mode:Re: [nodejs/node] Update terminal environment variables to detect colors (#27609)This message was sent on May 18, 2019 at 10:47:36 PM PDTYou can open it by clicking the link below. This link will only work for reply@reply.github.com.View the emailGmail confidential mode gives you more control over the messages you send. Set an expiration time, disable printing or forwarding of a message and more. Learn moreGmail: Email by GoogleUse is subject to the Google Privacy PolicyGoogle LLC, 1600 Amphitheatre Parkway, Mountain View, CA 94043, USAYou have received this message because someone sent you an email via Gmail confidential mode.

BridgeAR · 2019-05-19T07:20:01Z

@dmaynard51 please check what terminal you're using and what environment variables are set that correspond with the terminal.

BridgeAR · 2019-05-20T12:14:46Z

I just updated the initial description to include some further information about the environment variables.

dmaynard51 · 2019-05-20T16:58:20Z

I just updated the initial description to include some further information about the environment variables.

Thank you, hopefully I am showing the correct information. Using the command above my term shows:
TERM: 'xterm-256color',

Also I ran a script like dlionz did above to show some color output.

karansapolia · 2019-05-29T16:02:50Z

I am using Hyper, version: 3.0.2. Some settings I think that are set by the terminal are:

COLORTERM: 'truecolor',
TERM_PROGRAM_VERSION: '3.0.2',
CHROME_DESKTOP: 'Hyper.desktop',
TERM: 'xterm-256color',
TERM_PROGRAM: 'Hyper'

It seems to support only 256 color. I would like to submit a little PR for this @BridgeAR.

EddieGriffiths · 2019-06-19T14:19:27Z

I am using mintty 2.7.7 installed with Git for Windows

JEVBR · 2019-07-02T18:26:32Z

On Ubuntu 19.04,

my process.env =
VTE_VERSION: '5602',
TERM: 'xterm-256color',
COLORTERM: 'truecolor',

joe9111 · 2019-07-09T14:03:38Z

On MacOS terminal,

TERM: 'xterm-256color'

That is the only env variable that seems to correspond to the terminal.

duncanhealy · 2019-11-13T17:34:32Z

The check for the (env.COLORTERM) should occur before the check for env.TERM
as env.TERM will allways give you a 256 colour terminal when it is a truecolor term
Should I add a pull request to fix @BridgeAR ?
it never reaches the code below as the prior if check will always?! return

    if (env.COLORTERM === 'truecolor' || env.COLORTERM === '24bit')
      return COLORS_16m;
    return COLORS_16;
  }```

sarthak0906 · 2019-11-26T14:49:31Z

Hey is this issue still open
I would like to contribute

duncanhealy · 2019-11-26T15:40:02Z

Hey is this issue still open
I would like to contribute

if you run env |grep TERM you can check if your terminal settings are covered in
test/pseudo-tty/test-tty-color-support.js

sarthak0906 · 2019-11-26T18:15:46Z

On Ubuntu 18.04.3

COLORTERM=truecolor
TERM=xterm-256color
GNOME_TERMINAL_SERVICE=:1.122

COLORTERM:truecolor is covered in test/pseudo-tty/test-tty-color-support.js but TERM: xterm-256color is not covered.
Although TERM: xterm is in the file
Please confirm if I whould edit it

BridgeAR · 2019-11-26T18:21:00Z

@sarthak0906 it is covered by TERM='xterm-256'. So there's no need to add another entry. Thanks a lot for checking your term settings!


        tty: truecolor check moved before 256 check

256 color would be return instead of 16m if both env variables were set * tty: improve color check order highest spec first * tty: add test for TERM and COLORTERM set * tty: move COLORTERM check outside TERM closure * tty: remove extra if check for COLORTERM Refs: #27609 PR-URL: #30474 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>


        tty: truecolor check moved before 256 check

256 color would be return instead of 16m if both env variables were set * tty: improve color check order highest spec first * tty: add test for TERM and COLORTERM set * tty: move COLORTERM check outside TERM closure * tty: remove extra if check for COLORTERM Refs: #27609 PR-URL: #30474 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>


        tty: truecolor check moved before 256 check

256 color would be return instead of 16m if both env variables were set * tty: improve color check order highest spec first * tty: add test for TERM and COLORTERM set * tty: move COLORTERM check outside TERM closure * tty: remove extra if check for COLORTERM Refs: #27609 PR-URL: #30474 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>


        tty: truecolor check moved before 256 check

256 color would be return instead of 16m if both env variables were set * tty: improve color check order highest spec first * tty: add test for TERM and COLORTERM set * tty: move COLORTERM check outside TERM closure * tty: remove extra if check for COLORTERM Refs: nodejs#27609 PR-URL: nodejs#30474 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>


        tty: truecolor check moved before 256 check

256 color would be return instead of 16m if both env variables were set * tty: improve color check order highest spec first * tty: add test for TERM and COLORTERM set * tty: move COLORTERM check outside TERM closure * tty: remove extra if check for COLORTERM Refs: nodejs#27609 PR-URL: nodejs#30474 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>


        tty: truecolor check moved before 256 check

256 color would be return instead of 16m if both env variables were set * tty: improve color check order highest spec first * tty: add test for TERM and COLORTERM set * tty: move COLORTERM check outside TERM closure * tty: remove extra if check for COLORTERM Refs: #27609 PR-URL: #30474 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

BridgeAR added help wanted good first issue tty labels May 8, 2019

dlionz mentioned this issue May 15, 2019

tty: add color support for iterm2 #27723

Closed

3 of 3 tasks complete

aditya1906 mentioned this issue May 23, 2019

tty: add color support for mosh #27843

Closed

trivikr added the Hacktoberfest label Oct 1, 2019

Trott removed the Hacktoberfest label Nov 3, 2019

duncanhealy mentioned this issue Nov 13, 2019

tty: truecolor check moved before 256 check #30474

Closed

3 of 4 tasks complete

nodejs / node

Join GitHub today

Update terminal environment variables to detect colors #27609

Update terminal environment variables to detect colors #27609

Comments

BridgeAR commented May 8, 2019 • edited

This comment has been minimized.

mscdex commented May 8, 2019 • edited

This comment has been minimized.

rpgeeganage commented May 8, 2019

This comment has been minimized.

BridgeAR commented May 8, 2019

This comment has been minimized.

rpgeeganage commented May 8, 2019

This comment has been minimized.

3mard commented May 13, 2019

This comment has been minimized.

rpgeeganage commented May 13, 2019

This comment has been minimized.

dlionz commented May 15, 2019

This comment has been minimized.

BridgeAR commented May 15, 2019

This comment has been minimized.

dlionz commented May 15, 2019

This comment has been minimized.

dlionz commented May 15, 2019

This comment has been minimized.

rpgeeganage commented May 15, 2019

This comment has been minimized.

dlionz commented May 15, 2019

This comment has been minimized.

dlionz commented May 15, 2019

This comment has been minimized.

dmaynard51 commented May 19, 2019

This comment was marked as off-topic.

tacoto12 commented May 19, 2019

This comment has been minimized.

BridgeAR commented May 19, 2019

This comment has been minimized.

BridgeAR commented May 20, 2019

This comment has been minimized.

dmaynard51 commented May 20, 2019

This comment has been minimized.

karansapolia commented May 29, 2019 • edited

This comment has been minimized.

EddieGriffiths commented Jun 19, 2019

This comment has been minimized.

JEVBR commented Jul 2, 2019

This comment has been minimized.

joe9111 commented Jul 9, 2019

This comment has been minimized.

duncanhealy commented Nov 13, 2019

This comment has been minimized.

sarthak0906 commented Nov 26, 2019

This comment has been minimized.

duncanhealy commented Nov 26, 2019

This comment has been minimized.

sarthak0906 commented Nov 26, 2019

This comment has been minimized.

BridgeAR commented Nov 26, 2019

BridgeAR commented May 8, 2019 •

edited

mscdex commented May 8, 2019 •

edited

karansapolia commented May 29, 2019 •

edited