CLI: Add support for the NO_COLOR environment variable
#6976
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
There was a problem hiding this comment.
PR Summary
Added support for the NO_COLOR environment variable to disable colored output in SQLFluff's CLI, following the no-color.org standard.
- Updated
src/sqlfluff/cli/formatters.pyto check for non-emptyNO_COLORenvironment variable inshould_produce_plain_outputmethod - Added test coverage in
test/cli/commands_test.pyto verify bothNO_COLORand--nocolorflag functionality - Maintains backward compatibility with existing
--nocolorCLI flag while allowing environment variable override
2 files reviewed, 1 comment
Edit PR Review Bot Settings | Greptile
Coverage Results ✅ |
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.
Brief summary of the change made
This adds support for the no-color.org
NO_COLORenvironment variable to disable color output.Are there any other side effects of this change that we should be aware of?
None
Pull Request checklist
Please confirm you have completed any of the necessary steps below.
Included test cases to demonstrate any code changes, which may be one or more of the following:
.ymlrule test cases intest/fixtures/rules/std_rule_cases..sql/.ymlparser test cases intest/fixtures/dialects(note YML files can be auto generated withtox -e generate-fixture-yml).test/fixtures/linter/autofix.Added appropriate documentation for the change.
Created GitHub issues for any relevant followup/future enhancements if appropriate.