lib: support `FORCE_COLOR` for non TTY streams by MoLow · Pull Request #48034 · nodejs/node

MoLow · 2023-05-16T12:33:47Z

The current behavior of FORCE_COLOR is to take effect when stdout/stderr are TTY's

The FORCE_COLOR environment variable is used to enable ANSI colorized output.

this PR moves the check for the value of FORCE_COLOR before testing isTTY - and extracts the logic to a central utility.

Refs: #31409 (comment)

nodejs-github-bot · 2023-05-16T12:33:51Z

Review requested:

@nodejs/test_runner

MoLow · 2023-05-16T12:37:42Z

test/parallel/test-repl-envvars.js

 }

-tests.forEach(run);
+tests.forEach((testCase) => test(inspect(testCase.env), () => run(testCase)));


tests did not play well when running in parallel. used node:test to run them sequentially

MoLow · 2023-05-16T12:44:49Z

/CC @nodejs/util @nodejs/console

lib/internal/util/colors.js

lib/repl.js

nodejs-github-bot · 2023-05-17T20:24:35Z

CI: https://ci.nodejs.org/job/node-test-pull-request/51852/

test/fixtures/errors/force_colors.js

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>

nodejs-github-bot · 2023-05-17T22:07:27Z

CI: https://ci.nodejs.org/job/node-test-pull-request/51856/

PR-URL: #48034 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>

danielleadams · 2023-07-05T23:46:15Z

This broke tests when pulling into v18, so it needs a backport.

MoLow · 2023-07-06T05:06:58Z

@danielleadams It seems v18.x-staging is missing some other commits this PR depends on (b6738c1, 03db049) is that delibirate?
anyway I will create a backport PR for all the three

MoLow · 2023-07-06T05:39:41Z

@danielleadams cherry-picking this sequence of commits lands clearly with no conflicts and all tests pass, so I assume the staging branch is missing many many more parts

334bb17
d51541b
d1eaded
2e8f8eb
6d06586
102540a
af8ed02
7ec93fb
57508fb
b6738c1
46a3cff
d3b0a2a
9e5e2f1
03db049
05693ac

danielleadams · 2023-07-06T20:14:18Z

Talked to @MoLow offline, but staging branch is ready for backport now.

PR-URL: nodejs#48034 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>

PR-URL: #48034 Backport-PR-URL: #48684 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>

addaleax · 2024-01-22T19:58:37Z

@MoLow Small heads up, this seems to have broken NO_COLOR support for the REPL (i.e. NO_COLOR=1 node now uses color mode when previously it didn't)

MoLow · 2024-01-23T20:40:43Z

@addaleax I am not able to reproduce this:

what specifically are you running inside the repl?

addaleax · 2024-01-23T21:49:04Z

@MoLow Yeah, console.log() works perfectly (its doesn't inherit colorization from the REPL), but if you enter e.g. just 111 as the input instead of console.log(111) you'll see that the output is colorized in both cases with 20.10.0, as opposed to e.g. 20.2.0

This was historically done to make `console.log()` have colors. However, this makes any other code that checks `process.stdout.isTTY` incorrectly assume real TTY support. Node18 and Node20 now respect `FORCE_COLOR=1` in console, so our default behavior of forcing colors in the worker process just works out of the box. See nodejs/node#48034.

nodejs-github-bot added lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels May 16, 2023

MoLow commented May 16, 2023

View reviewed changes

MoLow force-pushed the force-colors branch from 847a6d9 to 25bab5c Compare May 16, 2023 12:43

anonrig reviewed May 16, 2023

View reviewed changes

lib/internal/util/colors.js Outdated Show resolved Hide resolved

lib/internal/util/colors.js Outdated Show resolved Hide resolved

lib/internal/util/colors.js Show resolved Hide resolved

lib/internal/util/colors.js Outdated Show resolved Hide resolved

MoLow force-pushed the force-colors branch from 25bab5c to 2ceb670 Compare May 16, 2023 14:44

ljharb approved these changes May 16, 2023

View reviewed changes

lib/repl.js Outdated Show resolved Hide resolved

lib: support FORCE_COLOR for non TTY streams

cb4fc99

MoLow force-pushed the force-colors branch from 2ceb670 to cb4fc99 Compare May 16, 2023 19:37

MoLow requested a review from anonrig May 17, 2023 05:31

anonrig approved these changes May 17, 2023

View reviewed changes

MoLow requested review from aduh95, anonrig, benjamingr and cjihrig May 17, 2023 14:43

benjamingr approved these changes May 17, 2023

View reviewed changes

MoLow added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. labels May 17, 2023

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label May 17, 2023

aduh95 reviewed May 17, 2023

View reviewed changes

test/fixtures/errors/force_colors.js Outdated Show resolved Hide resolved

Update test/fixtures/errors/force_colors.js

4c6d273

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>

MoLow added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label May 17, 2023

fix

cbef320

MoLow added the request-ci Add this label to start a Jenkins CI on a PR. label May 17, 2023

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label May 17, 2023

fix

1deee84

This was referenced May 23, 2023

CI Reliability 2023-05-23 nodejs/reliability#574

Open

CI Reliability 2023-05-24 nodejs/reliability#575

Open

targos pushed a commit that referenced this pull request May 30, 2023

lib: support FORCE_COLOR for non TTY streams

a90010a

PR-URL: #48034 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>

targos mentioned this pull request Jun 4, 2023

v20.3.0 release proposal #48332

Merged

danielleadams added the backport-requested-v18.x label Jul 5, 2023

MoLow added a commit to MoLow/node that referenced this pull request Jul 6, 2023

lib: support FORCE_COLOR for non TTY streams

d7d3c0a

PR-URL: nodejs#48034 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>

MoLow mentioned this pull request Jul 6, 2023

[v18.x backport] lib: support FORCE_COLOR for non TTY streams #48682

Closed

MoLow added backport-open-v18.x and removed backport-requested-v18.x labels Jul 6, 2023

MoLow added a commit to MoLow/node that referenced this pull request Jul 9, 2023

lib: support FORCE_COLOR for non TTY streams

277e5be

PR-URL: nodejs#48034 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>

MoLow added a commit to MoLow/node that referenced this pull request Jul 9, 2023

lib: support FORCE_COLOR for non TTY streams

69f5fad

PR-URL: nodejs#48034 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>

MoLow mentioned this pull request Jul 9, 2023

[v18.x backport] test_runner: align stdout and std error with and without --test #48684

Closed

MoLow added a commit to MoLow/node that referenced this pull request Jul 9, 2023

lib: support FORCE_COLOR for non TTY streams

b23dcb9

PR-URL: nodejs#48034 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>

danielleadams pushed a commit that referenced this pull request Jul 12, 2023

lib: support FORCE_COLOR for non TTY streams

c46b31f

PR-URL: #48034 Backport-PR-URL: #48684 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>

danielleadams added backported-to-v18.x and removed backport-open-v18.x labels Jul 12, 2023

danielleadams mentioned this pull request Jul 12, 2023

v18.17.0 release proposal #48694

Merged

aweebit mentioned this pull request Aug 7, 2023

[Bug]: FORCE_COLOR set internally leaks through to tests on Windows after upgrade to Node.js v18.17.0 jestjs/jest#14391

Closed

trentm mentioned this pull request Nov 3, 2023

chore: use npm workspaces and a package-lock.json open-telemetry/opentelemetry-js-contrib#1771

Merged

MoLow mentioned this pull request Jan 26, 2024

repl: fix NO_COLORS env var is ignored #51568

Merged

dgozman mentioned this pull request Mar 25, 2024

feat(test runner): do not mock tty in the worker process microsoft/playwright#30107

Merged

richardlau mentioned this pull request Jan 7, 2025

NO_COLOR not an alias for NODE_DISABLE_COLORS in v18 #56509

Closed

Uh oh!

Conversation

MoLow commented May 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nodejs-github-bot commented May 16, 2023

Uh oh!

MoLow May 16, 2023

Choose a reason for hiding this comment

Uh oh!

MoLow commented May 16, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nodejs-github-bot commented May 17, 2023

Uh oh!

Uh oh!

nodejs-github-bot commented May 17, 2023

Uh oh!

danielleadams commented Jul 5, 2023

Uh oh!

MoLow commented Jul 6, 2023

Uh oh!

MoLow commented Jul 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

danielleadams commented Jul 6, 2023

Uh oh!

addaleax commented Jan 22, 2024

Uh oh!

MoLow commented Jan 23, 2024

Uh oh!

addaleax commented Jan 23, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

MoLow commented May 16, 2023 •

edited

Loading

MoLow commented Jul 6, 2023 •

edited

Loading