Do not output unwelcome ANSI color codes#557
Merged
Merged
Conversation
928965c to
ce0cc01
Compare
Contributor
Author
|
I had a CI fail on diff --git a/simavr/sim/run_avr.c b/simavr/sim/run_avr.c
index eab651c..e4da1e4 100644
--- a/simavr/sim/run_avr.c
+++ b/simavr/sim/run_avr.c
@@ -34,12 +34,14 @@
#include "sim_core_decl.h"
+#ifndef NO_COLOR
/* ANSI escape codes to be used if color is enabled. */
static const struct text_colors font_color = {
.green = "\e[32m",
.red = "\e[31m",
.normal = "\e[0m"
};
+#endif
static void
display_usage( |
Collaborator
|
My personal view is that the first and last commits are enough. Changing the default behaviour may annoy someone. |
This will enable turning colors on and off at run time.
Refrain from coloring output if NO_COLOR is defined and has a non-empty value. This is a common convention. Link: https://no-color.org
ce0cc01 to
e763266
Compare
Contributor
Author
|
@gatk555: Thanks for reviewing this and my previous PR!
OK. I rewrote the branch keeping only the first and last commits. This required inverting the logic of the test in the last commit: instead of “if colors are welcome, enable them”, it is now “if colors are unwelcome, disable them”. |
Collaborator
|
Thanks! G. |
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
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.
ANSI color escape codes are usually a nice touch when they land on a tty, as they enhance the text readability. However, when the output is being redirected, they are most often an annoyance. Even on a tty, they are sometimes not welcome, e.g. when keeping a typescript of terminal session.
This pull request makes simavr refrain from using ANSI escape codes in the following cases:
run_avrrun_avris not a ttyNO_COLORis set to a non-empty valueThe latter is a common convention, widely adopted by many libraries and programs dealing with terminal output.
This pull request is built on top of (i.e. is a superset of) #556.
Fixes: #555.