Skip to content

doc: add examples for tty.getColorDepth() env - #26248

Closed
BridgeAR wants to merge 5 commits into
nodejs:masterfrom
BridgeAR:add-color-enforcing-docs
Closed

doc: add examples for tty.getColorDepth() env#26248
BridgeAR wants to merge 5 commits into
nodejs:masterfrom
BridgeAR:add-color-enforcing-docs

Conversation

@BridgeAR

@BridgeARBridgeAR commented Feb 21, 2019

Copy link
Copy Markdown
Member

This adds some examples what values can be used to enforce a specific
color support in Node.js.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@BridgeAR
doc: add examples for tty.getColorDepth() env
462fcfb
This adds some examples what values can be used to enforce a specific
color support in Node.js.
@BridgeARBridgeAR added the tty Issues and PRs related to the tty subsystem. label Feb 21, 2019
@nodejs-github-bot

nodejs-github-bot commented Feb 21, 2019

Copy link
Copy Markdown
Collaborator

@BridgeAR build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/2695/pipeline

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Feb 21, 2019
Trott
Trott reviewed Feb 21, 2019
View reviewed changes
Comment threaddoc/api/tty.md Outdated
Trott
Trott reviewed Feb 21, 2019
View reviewed changes
Comment threaddoc/api/tty.md Outdated
Trott
Trott reviewed Feb 21, 2019
View reviewed changes
Comment threaddoc/api/tty.md Outdated
Trottand others added 3 commits February 21, 2019 21:52
@Trott@BridgeAR
fixup: add comma
6f0d65c
Co-Authored-By: BridgeAR <ruben@bridgewater.de>
@Trott@BridgeAR
fixup: add comma
049c69d
Co-Authored-By: BridgeAR <ruben@bridgewater.de>
@BridgeAR
fixup: add suggestion
5c8189e
@BridgeARBridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Feb 21, 2019
targos
targos reviewed Feb 22, 2019
View reviewed changes
Comment threaddoc/api/tty.md
This rule does not apply to Windows OS, CI environments, and some other rare
cases.

* 2 colors: `NODE_DISABLE_COLORS = 1`

@targostargosFeb 22, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This works on Windows

@BridgeARBridgeARFeb 22, 2019

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Good catch. I updated the comment again to reflect that. PTAL.

@BridgeAR

BridgeAR commented Feb 22, 2019

Copy link
Copy Markdown
MemberAuthor

Hm... Hyper doesn't support 24 bit colors anymore and I used that in here as example. Therefore I consider doing something else instead of these examples as they could change over time without the change being reflected in the docs.

@BridgeARBridgeAR added wip Issues and PRs that are still a work in progress. and removed author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels Feb 22, 2019
@BridgeARBridgeAR mentioned this pull request Mar 7, 2019
Closed
4 tasks
@BridgeAR

BridgeAR commented Mar 7, 2019

Copy link
Copy Markdown
MemberAuthor

Closed in favor of #26485

@BridgeARBridgeAR closed this Mar 7, 2019
BridgeAR added a commit to BridgeAR/node that referenced this pull request Mar 19, 2019
@BridgeAR
tty: add NO_COLOR and FORCE_COLOR support
273398a
This adds support to enforce a specific color depth by checking the
`FORCE_COLOR` environment variable similar to `chalk`.
On top of that we also add support for the `NO_COLOR` environment
variable as suggested by https://no-color.org/.
PR-URL: nodejs#26485
Refs: nodejs#26248
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
targos pushed a commit to targos/node that referenced this pull request Mar 27, 2019
@BridgeAR@targos
tty: add NO_COLOR and FORCE_COLOR support
d6bff81
This adds support to enforce a specific color depth by checking the
`FORCE_COLOR` environment variable similar to `chalk`.
On top of that we also add support for the `NO_COLOR` environment
variable as suggested by https://no-color.org/.
PR-URL: nodejs#26485
Refs: nodejs#26248
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
targos pushed a commit that referenced this pull request Mar 27, 2019
@BridgeAR@targos
tty: add NO_COLOR and FORCE_COLOR support
8cafd83
This adds support to enforce a specific color depth by checking the
`FORCE_COLOR` environment variable similar to `chalk`.
On top of that we also add support for the `NO_COLOR` environment
variable as suggested by https://no-color.org/.
PR-URL: #26485
Refs: #26248
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
@BridgeAR
BridgeAR deleted the add-color-enforcing-docs branch January 20, 2020 11:53
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@targostargostargos left review comments
@TrottTrottTrott approved these changes
+1 more reviewer
@starkwangstarkwangstarkwang approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.ttyIssues and PRs related to the tty subsystem.wipIssues and PRs that are still a work in progress.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@BridgeAR@nodejs-github-bot@Trott@targos@starkwang