Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cli: add ui.color = "debug" #3631

Merged
merged 1 commit into from
May 11, 2024
Merged

cli: add ui.color = "debug" #3631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
* Conflict markers now include an explanation of what each part of the conflict
represents.

* `ui.color = "debug"` prints active labels alongside the regular colored output.

### Fixed bugs

## [0.17.0] - 2024-05-01
Expand Down
2 changes: 1 addition & 1 deletion cli/src/cli_util.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2407,7 +2407,7 @@ pub struct GlobalArgs {

#[derive(clap::Args, Clone, Debug)]
pub struct EarlyArgs {
/// When to colorize output (always, never, auto)
/// When to colorize output (always, never, debug, auto)
#[arg(long, value_name = "WHEN", global = true)]
pub color: Option<ColorChoice>,
/// Silence non-primary command output
Expand Down
1 change: 1 addition & 0 deletions cli/src/config-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@
"enum": [
"always",
"never",
"debug",
"auto"
],
"default": "auto"
Expand Down
109 changes: 81 additions & 28 deletions cli/src/formatter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,18 +132,19 @@ pub struct FormatterFactory {
enum FormatterFactoryKind {
PlainText,
Sanitized,
Color { rules: Arc<Rules> },
Color { rules: Arc<Rules>, debug: bool },
}

impl FormatterFactory {
pub fn prepare(
config: &config::Config,
debug: bool,
color: bool,
sanitized: bool,
) -> Result<Self, config::ConfigError> {
let kind = if color {
let rules = Arc::new(rules_from_config(config)?);
FormatterFactoryKind::Color { rules }
FormatterFactoryKind::Color { rules, debug }
} else if sanitized {
FormatterFactoryKind::Sanitized
} else {
Expand All @@ -159,8 +160,8 @@ impl FormatterFactory {
match &self.kind {
FormatterFactoryKind::PlainText => Box::new(PlainTextFormatter::new(output)),
FormatterFactoryKind::Sanitized => Box::new(SanitizingFormatter::new(output)),
FormatterFactoryKind::Color { rules } => {
Box::new(ColorFormatter::new(output, rules.clone()))
FormatterFactoryKind::Color { rules, debug } => {
Box::new(ColorFormatter::new(output, rules.clone(), *debug))
}
}
}
Expand Down Expand Up @@ -255,6 +256,7 @@ impl Style {
#[derive(Clone, Debug)]
pub struct ColorFormatter<W: Write> {
output: W,
debug: bool,
rules: Arc<Rules>,
/// The stack of currently applied labels. These determine the desired
/// style.
Expand All @@ -265,19 +267,24 @@ pub struct ColorFormatter<W: Write> {
}

impl<W: Write> ColorFormatter<W> {
pub fn new(output: W, rules: Arc<Rules>) -> ColorFormatter<W> {
pub fn new(output: W, rules: Arc<Rules>, debug: bool) -> ColorFormatter<W> {
ColorFormatter {
output,
rules,
debug,
labels: vec![],
cached_styles: HashMap::new(),
current_style: Style::default(),
}
}

pub fn for_config(output: W, config: &config::Config) -> Result<Self, config::ConfigError> {
pub fn for_config(
output: W,
config: &config::Config,
debug: bool,
) -> Result<Self, config::ConfigError> {
let rules = rules_from_config(config)?;
Ok(Self::new(output, Arc::new(rules)))
Ok(Self::new(output, Arc::new(rules), debug))
}

fn requested_style(&mut self) -> Style {
Expand Down Expand Up @@ -473,19 +480,43 @@ impl<W: Write> Write for ColorFormatter<W> {
* Some tools (like `less -R`) get confused and lose coloring of lines
after a newline.
*/

for line in data.split_inclusive(|b| *b == b'\n') {
if line.ends_with(b"\n") {
self.write_new_style()?;
write_sanitized(&mut self.output, &line[..line.len() - 1])?;
write_line_exclusive(
&mut self.output,
&line[..line.len() - 1],
&self.labels,
self.debug,
)?;
let labels = mem::take(&mut self.labels);
self.write_new_style()?;
self.output.write_all(b"\n")?;
self.labels = labels;
} else {
self.write_new_style()?;
write_sanitized(&mut self.output, line)?;
write_line_exclusive(&mut self.output, line, &self.labels, self.debug)?;
}
}

fn write_line_exclusive<W: Write>(
output: &mut W,
buf: &[u8],
labels: &[String],
debug: bool,
) -> io::Result<()> {
tingerrr marked this conversation as resolved.
Show resolved Hide resolved
if debug {
write!(output, "<<{}::", labels.join(" "))?;
write_sanitized(output, buf)?;
write!(output, ">>")?;
} else {
write_sanitized(output, buf)?;
}

Ok(())
}

Ok(data.len())
}

Expand Down Expand Up @@ -699,7 +730,8 @@ mod tests {
}
let mut output: Vec<u8> = vec![];
let mut formatter =
ColorFormatter::for_config(&mut output, &config_builder.build().unwrap()).unwrap();
ColorFormatter::for_config(&mut output, &config_builder.build().unwrap(), false)
.unwrap();
for color in colors {
formatter.push_label(&color.replace(' ', "-")).unwrap();
write!(formatter, " {color} ").unwrap();
Expand Down Expand Up @@ -744,7 +776,8 @@ mod tests {
}
let mut output: Vec<u8> = vec![];
let mut formatter =
ColorFormatter::for_config(&mut output, &config_builder.build().unwrap()).unwrap();
ColorFormatter::for_config(&mut output, &config_builder.build().unwrap(), false)
.unwrap();
for [label, _] in labels_and_colors {
formatter.push_label(&label.replace(' ', "-")).unwrap();
write!(formatter, " {label} ").unwrap();
Expand All @@ -769,7 +802,7 @@ mod tests {
"#,
);
let mut output: Vec<u8> = vec![];
let mut formatter = ColorFormatter::for_config(&mut output, &config).unwrap();
let mut formatter = ColorFormatter::for_config(&mut output, &config, false).unwrap();
write!(formatter, " before ").unwrap();
formatter.push_label("inside").unwrap();
write!(formatter, " inside ").unwrap();
Expand All @@ -793,7 +826,7 @@ mod tests {
"#,
);
let mut output: Vec<u8> = vec![];
let mut formatter = ColorFormatter::for_config(&mut output, &config).unwrap();
let mut formatter = ColorFormatter::for_config(&mut output, &config, false).unwrap();
formatter.push_label("red_fg").unwrap();
write!(formatter, " fg only ").unwrap();
formatter.pop_label().unwrap();
Expand Down Expand Up @@ -841,7 +874,7 @@ mod tests {
"#,
);
let mut output: Vec<u8> = vec![];
let mut formatter = ColorFormatter::for_config(&mut output, &config).unwrap();
let mut formatter = ColorFormatter::for_config(&mut output, &config, false).unwrap();
formatter.push_label("not_bold").unwrap();
write!(formatter, " not bold ").unwrap();
formatter.push_label("bold_font").unwrap();
Expand All @@ -863,7 +896,7 @@ mod tests {
"#,
);
let mut output: Vec<u8> = vec![];
let mut formatter = ColorFormatter::for_config(&mut output, &config).unwrap();
let mut formatter = ColorFormatter::for_config(&mut output, &config, false).unwrap();
write!(formatter, "before").unwrap();
formatter.push_label("red").unwrap();
write!(formatter, "first").unwrap();
Expand All @@ -885,7 +918,7 @@ mod tests {
"#,
);
let mut output: Vec<u8> = vec![];
let mut formatter = ColorFormatter::for_config(&mut output, &config).unwrap();
let mut formatter = ColorFormatter::for_config(&mut output, &config, false).unwrap();
formatter.push_label("red").unwrap();
write!(formatter, "\x1b[1mnot actually bold\x1b[0m").unwrap();
formatter.pop_label().unwrap();
Expand All @@ -906,7 +939,7 @@ mod tests {
"#,
);
let mut output: Vec<u8> = vec![];
let mut formatter = ColorFormatter::for_config(&mut output, &config).unwrap();
let mut formatter = ColorFormatter::for_config(&mut output, &config, false).unwrap();
write!(formatter, " before outer ").unwrap();
formatter.push_label("outer").unwrap();
write!(formatter, " before inner ").unwrap();
Expand All @@ -930,7 +963,7 @@ mod tests {
"#,
);
let mut output: Vec<u8> = vec![];
let mut formatter = ColorFormatter::for_config(&mut output, &config).unwrap();
let mut formatter = ColorFormatter::for_config(&mut output, &config, false).unwrap();
formatter.push_label("outer").unwrap();
write!(formatter, " not colored ").unwrap();
formatter.push_label("inner").unwrap();
Expand All @@ -953,7 +986,7 @@ mod tests {
"#,
);
let mut output: Vec<u8> = vec![];
let err = ColorFormatter::for_config(&mut output, &config)
let err = ColorFormatter::for_config(&mut output, &config, false)
.unwrap_err()
.to_string();
insta::assert_snapshot!(err,
Expand All @@ -970,7 +1003,7 @@ mod tests {
"##,
);
let mut output: Vec<u8> = vec![];
let err = ColorFormatter::for_config(&mut output, &config)
let err = ColorFormatter::for_config(&mut output, &config, false)
.unwrap_err()
.to_string();
insta::assert_snapshot!(err,
Expand All @@ -989,7 +1022,7 @@ mod tests {
"#,
);
let mut output: Vec<u8> = vec![];
let mut formatter = ColorFormatter::for_config(&mut output, &config).unwrap();
let mut formatter = ColorFormatter::for_config(&mut output, &config, false).unwrap();
formatter.push_label("outer").unwrap();
write!(formatter, "Blue on yellow, ").unwrap();
formatter.push_label("default_fg").unwrap();
Expand Down Expand Up @@ -1018,7 +1051,7 @@ mod tests {
"#,
);
let mut output: Vec<u8> = vec![];
let mut formatter = ColorFormatter::for_config(&mut output, &config).unwrap();
let mut formatter = ColorFormatter::for_config(&mut output, &config, false).unwrap();
formatter.push_label("outer1").unwrap();
formatter.push_label("inner2").unwrap();
write!(formatter, " hello ").unwrap();
Expand All @@ -1038,7 +1071,7 @@ mod tests {
"#,
);
let mut output: Vec<u8> = vec![];
let mut formatter = ColorFormatter::for_config(&mut output, &config).unwrap();
let mut formatter = ColorFormatter::for_config(&mut output, &config, false).unwrap();
formatter.push_label("outer").unwrap();
formatter.push_label("inner").unwrap();
write!(formatter, " hello ").unwrap();
Expand All @@ -1060,7 +1093,7 @@ mod tests {
"#,
);
let mut output: Vec<u8> = vec![];
let mut formatter = ColorFormatter::for_config(&mut output, &config).unwrap();
let mut formatter = ColorFormatter::for_config(&mut output, &config, false).unwrap();
formatter.push_label("a").unwrap();
write!(formatter, " a1 ").unwrap();
formatter.push_label("b").unwrap();
Expand All @@ -1087,14 +1120,34 @@ mod tests {
"#,
);
let mut output: Vec<u8> = vec![];
let mut formatter = ColorFormatter::for_config(&mut output, &config).unwrap();
let mut formatter = ColorFormatter::for_config(&mut output, &config, false).unwrap();
formatter.push_label("outer").unwrap();
formatter.push_label("inner").unwrap();
write!(formatter, " inside ").unwrap();
drop(formatter);
insta::assert_snapshot!(String::from_utf8(output).unwrap(), @" inside ");
}

#[test]
fn test_color_formatter_debug() {
// Behaves like the color formatter, but surrounds each write with <<...>>,
// adding the active labels before the actual content separated by a ::.
let config = config_from_string(
r#"
colors.outer = "green"
"#,
);
let mut output: Vec<u8> = vec![];
let mut formatter = ColorFormatter::for_config(&mut output, &config, true).unwrap();
formatter.push_label("outer").unwrap();
formatter.push_label("inner").unwrap();
write!(formatter, " inside ").unwrap();
formatter.pop_label().unwrap();
formatter.pop_label().unwrap();
drop(formatter);
insta::assert_snapshot!(String::from_utf8(output).unwrap(), @"<<outer inner:: inside >>");
}

#[test]
fn test_heading_labeled_writer() {
let config = config_from_string(
Expand All @@ -1105,7 +1158,7 @@ mod tests {
);
let mut output: Vec<u8> = vec![];
let mut formatter: Box<dyn Formatter> =
Box::new(ColorFormatter::for_config(&mut output, &config).unwrap());
Box::new(ColorFormatter::for_config(&mut output, &config, false).unwrap());
HeadingLabeledWriter::new(formatter.as_mut(), "inner", "Should be noop: ");
let mut writer = HeadingLabeledWriter::new(formatter.as_mut(), "inner", "Heading: ");
write!(writer, "Message").unwrap();
Expand Down Expand Up @@ -1146,7 +1199,7 @@ mod tests {
// Replayed output should be labeled.
let config = config_from_string(r#" colors.inner = "red" "#);
let mut output: Vec<u8> = vec![];
let mut formatter = ColorFormatter::for_config(&mut output, &config).unwrap();
let mut formatter = ColorFormatter::for_config(&mut output, &config, false).unwrap();
recorder.replay(&mut formatter).unwrap();
drop(formatter);
insta::assert_snapshot!(
Expand All @@ -1155,7 +1208,7 @@ mod tests {

// Replayed output should be split at push/pop_label() call.
let mut output: Vec<u8> = vec![];
let mut formatter = ColorFormatter::for_config(&mut output, &config).unwrap();
let mut formatter = ColorFormatter::for_config(&mut output, &config, false).unwrap();
recorder
.replay_with(&mut formatter, |formatter, range| {
let data = &recorder.data()[range];
Expand Down
3 changes: 2 additions & 1 deletion cli/src/template_builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1224,7 +1224,8 @@ mod tests {
fn render_ok(&self, template: &str) -> String {
let template = self.parse(template).unwrap();
let mut output = Vec::new();
let mut formatter = ColorFormatter::new(&mut output, self.color_rules.clone().into());
let mut formatter =
ColorFormatter::new(&mut output, self.color_rules.clone().into(), false);
template.format(&(), &mut formatter).unwrap();
drop(formatter);
String::from_utf8(output).unwrap()
Expand Down
2 changes: 1 addition & 1 deletion cli/src/text_util.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ mod tests {
.build()
.unwrap();
let mut output = Vec::new();
let mut formatter = ColorFormatter::for_config(&mut output, &config).unwrap();
let mut formatter = ColorFormatter::for_config(&mut output, &config, false).unwrap();
write(&mut formatter).unwrap();
drop(formatter);
String::from_utf8(output).unwrap()
Expand Down
Loading