respect use_ansi_coloring configuration (#7912)

# Description

Use the `use_ansi_coloring` configuration point to decide whether the
output will have colors, where possible.

Related: https://github.com/nushell/nushell/issues/7676


![image](https://user-images.githubusercontent.com/749306/215435128-cbf5f4b8-aafa-4718-bf23-3f0fd19b63ba.png)

- [x] `grid -c`
- [x] `perf()`

# User-Facing Changes

_(List of all changes that impact the user experience here. This helps
us keep track of breaking changes.)_

# Tests + Formatting

Don't forget to add tests that cover your changes.

Make sure you've run and fixed any issues with these commands:

- `cargo fmt --all -- --check` to check standard code formatting (`cargo
fmt --all` applies these changes)
- `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A
clippy::needless_collect` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass

# After Submitting

If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
This commit is contained in:
Kornél Csernai
2023-02-01 15:03:05 -08:00
committed by GitHub
parent 24d7227e27
commit 31e1410191
6 changed files with 286 additions and 44 deletions

View File

@ -52,6 +52,7 @@ pub fn read_plugin_file(
file!(),
line!(),
column!(),
engine_state.get_config().use_ansi_coloring,
);
}

View File

@ -45,6 +45,7 @@ pub fn evaluate_repl(
entire_start_time: Instant,
) -> Result<()> {
use reedline::{FileBackedHistory, Reedline, Signal};
let use_color = engine_state.get_config().use_ansi_coloring;
// Guard against invocation without a connected terminal.
// reedline / crossterm event polling will fail without a connected tty
@ -72,6 +73,7 @@ pub fn evaluate_repl(
file!(),
line!(),
column!(),
use_color,
);
// seed env vars
@ -91,7 +93,14 @@ pub fn evaluate_repl(
.map(i64::from)
.unwrap_or(0);
engine_state.history_session_id = hist_sesh;
perf("setup reedline", start_time, file!(), line!(), column!());
perf(
"setup reedline",
start_time,
file!(),
line!(),
column!(),
use_color,
);
let config = engine_state.get_config();
@ -115,7 +124,14 @@ pub fn evaluate_repl(
};
line_editor = line_editor.with_history(history);
};
perf("setup history", start_time, file!(), line!(), column!());
perf(
"setup history",
start_time,
file!(),
line!(),
column!(),
use_color,
);
start_time = std::time::Instant::now();
let sys = sysinfo::System::new();
@ -136,6 +152,7 @@ pub fn evaluate_repl(
file!(),
line!(),
column!(),
use_color,
);
if let Some(s) = prerun_command {
@ -161,21 +178,42 @@ pub fn evaluate_repl(
if let Err(err) = engine_state.merge_env(stack, cwd) {
report_error_new(engine_state, &err);
}
perf("merge env", start_time, file!(), line!(), column!());
perf(
"merge env",
start_time,
file!(),
line!(),
column!(),
use_color,
);
start_time = std::time::Instant::now();
//Reset the ctrl-c handler
if let Some(ctrlc) = &mut engine_state.ctrlc {
ctrlc.store(false, Ordering::SeqCst);
}
perf("reset ctrlc", start_time, file!(), line!(), column!());
perf(
"reset ctrlc",
start_time,
file!(),
line!(),
column!(),
use_color,
);
start_time = std::time::Instant::now();
// Reset the SIGQUIT handler
if let Some(sig_quit) = engine_state.get_sig_quit() {
sig_quit.store(false, Ordering::SeqCst);
}
perf("reset sig_quit", start_time, file!(), line!(), column!());
perf(
"reset sig_quit",
start_time,
file!(),
line!(),
column!(),
use_color,
);
start_time = std::time::Instant::now();
let config = engine_state.get_config();
@ -198,6 +236,7 @@ pub fn evaluate_repl(
file!(),
line!(),
column!(),
use_color,
);
start_time = std::time::Instant::now();
@ -218,7 +257,14 @@ pub fn evaluate_repl(
.with_partial_completions(config.partial_completions)
.with_ansi_colors(config.use_ansi_coloring)
.with_cursor_config(cursor_config);
perf("reedline builder", start_time, file!(), line!(), column!());
perf(
"reedline builder",
start_time,
file!(),
line!(),
column!(),
use_color,
);
let style_computer = StyleComputer::from_config(engine_state, stack);
@ -238,6 +284,7 @@ pub fn evaluate_repl(
file!(),
line!(),
column!(),
use_color,
);
start_time = std::time::Instant::now();
@ -246,7 +293,14 @@ pub fn evaluate_repl(
report_error(&working_set, &e);
Reedline::create()
});
perf("reedline menus", start_time, file!(), line!(), column!());
perf(
"reedline menus",
start_time,
file!(),
line!(),
column!(),
use_color,
);
start_time = std::time::Instant::now();
let buffer_editor = if !config.buffer_editor.is_empty() {
@ -275,6 +329,7 @@ pub fn evaluate_repl(
file!(),
line!(),
column!(),
use_color,
);
start_time = std::time::Instant::now();
@ -283,7 +338,14 @@ pub fn evaluate_repl(
warn!("Failed to sync history: {}", e);
}
}
perf("sync_history", start_time, file!(), line!(), column!());
perf(
"sync_history",
start_time,
file!(),
line!(),
column!(),
use_color,
);
start_time = std::time::Instant::now();
// Changing the line editor based on the found keybindings
@ -307,7 +369,14 @@ pub fn evaluate_repl(
line_editor
}
};
perf("keybindings", start_time, file!(), line!(), column!());
perf(
"keybindings",
start_time,
file!(),
line!(),
column!(),
use_color,
);
start_time = std::time::Instant::now();
// Right before we start our prompt and take input from the user,
@ -317,7 +386,14 @@ pub fn evaluate_repl(
report_error_new(engine_state, &err);
}
}
perf("pre-prompt hook", start_time, file!(), line!(), column!());
perf(
"pre-prompt hook",
start_time,
file!(),
line!(),
column!(),
use_color,
);
start_time = std::time::Instant::now();
// Next, check all the environment variables they ask for
@ -328,12 +404,26 @@ pub fn evaluate_repl(
{
report_error_new(engine_state, &error)
}
perf("env-change hook", start_time, file!(), line!(), column!());
perf(
"env-change hook",
start_time,
file!(),
line!(),
column!(),
use_color,
);
start_time = std::time::Instant::now();
let config = engine_state.get_config();
let prompt = prompt_update::update_prompt(config, engine_state, stack, &mut nu_prompt);
perf("update_prompt", start_time, file!(), line!(), column!());
perf(
"update_prompt",
start_time,
file!(),
line!(),
column!(),
use_color,
);
entry_num += 1;
@ -587,6 +677,7 @@ pub fn evaluate_repl(
file!(),
line!(),
column!(),
use_color,
);
perf(
@ -595,6 +686,7 @@ pub fn evaluate_repl(
file!(),
line!(),
column!(),
use_color,
);
}

View File

@ -297,6 +297,7 @@ pub fn eval_source(
file!(),
line!(),
column!(),
engine_state.get_config().use_ansi_coloring,
);
true

View File

@ -72,6 +72,7 @@ prints out the list properly."#
None => None,
};
let use_grid_icons = config.use_grid_icons;
let use_color: bool = color_param && config.use_ansi_coloring;
match input {
PipelineData::Value(Value::List { vals, .. }, ..) => {
@ -82,7 +83,7 @@ prints out the list properly."#
items,
call,
width_param,
color_param,
use_color,
separator_param,
env_str,
use_grid_icons,
@ -99,7 +100,7 @@ prints out the list properly."#
items,
call,
width_param,
color_param,
use_color,
separator_param,
env_str,
use_grid_icons,
@ -121,7 +122,7 @@ prints out the list properly."#
items,
call,
width_param,
color_param,
use_color,
separator_param,
env_str,
use_grid_icons,
@ -170,7 +171,7 @@ fn create_grid_output(
items: Vec<(usize, String, String)>,
call: &Call,
width_param: Option<i64>,
color_param: bool,
use_color: bool,
separator_param: Option<String>,
env_str: Option<String>,
use_grid_icons: bool,
@ -198,7 +199,7 @@ fn create_grid_output(
for (_row_index, header, value) in items {
// only output value if the header name is 'name'
if header == "name" {
if color_param {
if use_color {
if use_grid_icons {
let no_ansi = nu_utils::strip_ansi_unlikely(&value);
let path = std::path::Path::new(no_ansi.as_ref());

View File

@ -65,13 +65,31 @@ pub fn get_ls_colors(lscolors_env_string: Option<String>) -> LsColors {
}
// Log some performance metrics (green text with yellow timings)
pub fn perf(msg: &str, dur: std::time::Instant, file: &str, line: u32, column: u32) {
info!(
"perf: {}:{}:{} \x1b[32m{}\x1b[0m took \x1b[33m{:?}\x1b[0m",
file,
line,
column,
msg,
dur.elapsed(),
);
pub fn perf(
msg: &str,
dur: std::time::Instant,
file: &str,
line: u32,
column: u32,
use_color: bool,
) {
if use_color {
info!(
"perf: {}:{}:{} \x1b[32m{}\x1b[0m took \x1b[33m{:?}\x1b[0m",
file,
line,
column,
msg,
dur.elapsed(),
);
} else {
info!(
"perf: {}:{}:{} {} took {:?}",
file,
line,
column,
msg,
dur.elapsed(),
);
}
}