doc: fix desc for NO_COLOR and NODE_DISABLE_COLORS env vars in cli.md
#56486
Conversation
Improve wording for `NO_COLOR` and `NODE_DISABLE_COLORS` environment variables.
nodejs-github-bot
added
cli
veganaize
changed the title
NO_COLOR and NODE_DISABLE_COLORS environment variables in cli.mdNO_COLOR and NODE_DISABLE_COLORS env vars in cli.md
veganaize
changed the title
NO_COLOR and NODE_DISABLE_COLORS env vars in cli.mdNO_COLOR and NODE_DISABLE_COLORS env vars in cli.md
| @@ -3352,7 +3352,8 @@ propagation. | |||
|
|
|||
| ### `NO_COLOR=<any>` | |||
|
|
|||
| [`NO_COLOR`][] is an alias for `NODE_DISABLE_COLORS`. The value of the | |||
| [`NO_COLOR`][] When set, disables color only for the command-line. The REPL will | |||
| continue to output color unless `NODE_DISABLE_COLORS` is set. The value of the | |||
There was a problem hiding this comment.
I don't believe this is correct. NO_COLOR should act identical to NODE_DISABLE_COLORS
There was a problem hiding this comment.
It doesn't in the cmd.exe shell of Windows 8.1 (x64), nor in the terminal on Debian 12, from my testing.
There was a problem hiding this comment.
I'm not certain that windows 8.1 is still a supported version. Not sure about Debian 12. In either case, however, the expectation is that these are aliases with identical behavior, so any variance from that would be a bug in the implementation rather than a bug in the docs.
There was a problem hiding this comment.
Please test it for yourself, and see. This is the behavior back through v14, to my knowledge. Debian 12 is the current stable version of Debian.
There was a problem hiding this comment.
I'm not questioning whether it works or not, I'm saying that it's supposed to. So if it doesn't the bug is not in the docs but the implementation.
There was a problem hiding this comment.
I can confirm that the output is working correctly (ie. NO_COLOR acting as alias for NODE_DISABLE_COLORS) in Node.js v20.9 on Arch Linux.
So that implies the last LTS version the issue applies to is v18 (which I tested against the latest minor version of, and NO_COLOR still outputs color in the REPL.)
v18 is still under current LTS support (including "experimental" support for Windows 8.1).
There was a problem hiding this comment.
Created new issue #56509 and closed this PR.
Improve wording for
NO_COLORandNODE_DISABLE_COLORSenvironment variables incli.mdapi doc.Closes #56485