Skip to content
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.

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

NO_COLOR and NODE_DISABLE_COLORS described incorrectly in CLI api doc #56485

Closed
veganaize opened this issue Jan 5, 2025 · 1 comment
Closed
Labels
doc Issues and PRs related to the documentations.

Comments

@veganaize
Copy link

Affected URL(s)

https://nodejs.org/docs/latest/api/cli.html

Description of the problem

The NODE_DISABLE_COLORS=1 documentation states:

When set, colors will not be used in the REPL.

However, that is only half of the story because it also disables color output at the command-line.


Additionally, NO_COLOR=<any> states:

NO_COLOR is an alias for NODE_DISABLE_COLORS.

However, it only disables color at the command-line, not in the REPL. So it isn't exactly an alias for NODE_DISABLE_COLORS.


The wording should be improved, for these two environment variables, to state that NO_COLOR disables color only at the command-line, while NODE_DISABLE_COLORS disables color at both the command-line & in the REPL.

@veganaize veganaize added the doc Issues and PRs related to the documentations. label Jan 5, 2025
@veganaize veganaize changed the title 'NO_COLOR and NODE_DISABLE_COLORS` described incorrectly in CLI api doc NO_COLOR and NODE_DISABLE_COLORS described incorrectly in CLI api doc Jan 5, 2025
@veganaize
Copy link
Author

Revised into new issue #56509

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant