Respect RSpec color mode when applicable#261
Merged
Uh oh!
There was an error while loading. Please reload this page.
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
It's hard to keep Csi.color_enabled and SuperDiff::Configuration.color_enabled in sync. But Csi.color_enabled is only serving Csi.colorize, which in turn only exists for Csi.inspect_colors_in, which is apparently unused elsewhere in this project. Since Csi is a library private to this project, we can remove them.
When `color_enabled` has not been explicitly set and `super_diff/rspec` has been loaded (i.e. whoever is using this gem has indicated they want to load the RSpec extensions, not just that RSpec is available), use the RSpec color mode if one hasn't been explicitly set already.
📖 A new version of the docsite has been published at: https://splitwise.github.io/super_diff/branches/261/merge/e5f93d4edad4fe00762f823d6bbc4838a9d83ad6 |
📖 A new version of the docsite has been published at: https://splitwise.github.io/super_diff/branches/respect-rspec-color/e5ba527f9a6c1779be1ebb40b5e9b32af7a09e6f |
dgmstuart commented Sep 24, 2024
Thanks so much for addressing this so quickly! |
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
Problem
As described in #260, it's surprising and undesirable for RSpec to emit colorized output when that's been explicitly turned off (either via
--no-coloron the CLI, or by settingRSpec.configuration.color_mode = :offprogrammatically).Solution
With RSpec extensions on
When this gem's RSpec extensions are loaded, and:
ENV["CI"]isn't set totrue, andSuperDiff.configuration.color_enabledwasn't explicitly set or was set tonil,we'll use RSpec's color mode by default.
SuperDiff.configuration.color_enabled = nilturned colors off. As of this PR, it indicates that SuperDiff should decide based on the environment.With RSpec extensions off
When this gem's RSpec extensions are not loaded, we won't use the RSpec color configuration, even if RSpec is loaded in the environment. This prevents a different weird scenario where: