Make Colorize.on_tty_only! the default behavior
#15881
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
src/colorize.cr
Outdated
|
|
||
| # Makes `Colorize.enabled` `true` if and only if both of `STDOUT.tty?` | ||
| # and `STDERR.tty?` are `true` and the tty is not considered a dumb terminal. | ||
| # This is determined by the environment variable called `TERM`. | ||
| # If `TERM=dumb`, color won't be enabled. | ||
| # If `NO_COLOR` contains any value color won't be enabled conforming to https://no-color.org | ||
| # | ||
| # This can be used to revert `Colorize.enabled?` to its default value after | ||
| # colorization is explicitly enabled or disabled. | ||
| def self.on_tty_only! | ||
| self.enabled = STDOUT.tty? && STDERR.tty? && ENV["TERM"]? != "dumb" && !ENV.has_key?("NO_COLOR") |
There was a problem hiding this comment.
suggestion: We could reset @@enabled to avoid duplication. This means the default block of the above class_property definition would be invoked on the next getter call.
Suggested change
| self.enabled = STDOUT.tty? && STDERR.tty? && ENV["TERM"]? != "dumb" && !ENV.has_key?("NO_COLOR") | |
| @@enabled = nil |
There was a problem hiding this comment.
This line in Shards implicitly assumes that on_tty_only! returns the new value of enabled?, so this is unfortunately a breaking change
There was a problem hiding this comment.
Maybe return enabled then? This still avoids duplicating the exact same condition.
Suggested change
| self.enabled = STDOUT.tty? && STDERR.tty? && ENV["TERM"]? != "dumb" && !ENV.has_key?("NO_COLOR") | |
| @enabled = nil | |
| enabled |
straight-shoota
approved these changes
Jun 5, 2025
Co-authored-by: Johannes Müller <[email protected]>
This reverts commit c4e333f.
straight-shoota
approved these changes
Jun 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Originally part of #7690, this seems to be the more sensible behavior compared to ignoring non-terminal streams and
$TERM. This does not deprecate.on_tty_only!because it is still useful after the default is overridden.Effectively reverts #14258.