From b3137a2b4cfe55ca1ddb98b887911be254ead40f Mon Sep 17 00:00:00 2001 From: Devyn Cairns Date: Wed, 10 Jul 2024 01:12:26 -0700 Subject: [PATCH] Update config directly at assignment --- Cargo.lock | 2 + crates/nu-cli/src/eval_cmds.rs | 5 +- crates/nu-cli/src/menus/help_completions.rs | 32 ++++--- crates/nu-cli/src/nu_highlight.rs | 9 +- crates/nu-cli/src/reedline_config.rs | 54 ++++++----- crates/nu-cli/src/repl.rs | 3 +- crates/nu-cli/src/syntax_highlight.rs | 13 ++- .../nu-cmd-extra/src/extra/formats/to/html.rs | 2 +- .../src/extra/strings/format/command.rs | 36 ++++---- crates/nu-color-config/src/style_computer.rs | 4 +- .../nu-command/src/conversions/into/string.rs | 6 +- crates/nu-command/src/debug/debug_.rs | 2 +- crates/nu-command/src/filesystem/rm.rs | 2 +- crates/nu-command/src/filters/find.rs | 6 +- crates/nu-command/src/formats/to/md.rs | 4 +- crates/nu-command/src/formats/to/text.rs | 6 +- crates/nu-command/src/help/help_aliases.rs | 2 +- crates/nu-command/src/help/help_modules.rs | 2 +- crates/nu-command/src/network/url/parse.rs | 17 ++-- crates/nu-command/src/platform/ansi/ansi_.rs | 2 +- crates/nu-command/src/platform/ansi/strip.rs | 11 +-- crates/nu-command/src/platform/input/list.rs | 5 +- crates/nu-command/src/stor/insert.rs | 2 +- .../nu-command/src/strings/detect_columns.rs | 14 ++- crates/nu-command/src/system/nu_check.rs | 4 +- crates/nu-command/src/system/run_external.rs | 2 +- crates/nu-command/src/viewers/griddle.rs | 2 +- crates/nu-command/src/viewers/table.rs | 44 +++++++-- crates/nu-engine/src/documentation.rs | 92 ++++++++++++------- crates/nu-engine/src/env.rs | 14 +-- crates/nu-engine/src/eval.rs | 18 +++- crates/nu-explore/src/commands/expand.rs | 4 +- crates/nu-explore/src/explore.rs | 6 +- crates/nu-plugin-engine/Cargo.toml | 3 +- crates/nu-plugin-engine/src/context.rs | 8 +- crates/nu-plugin-engine/src/declaration.rs | 2 +- crates/nu-plugin-engine/src/interface/mod.rs | 3 +- crates/nu-plugin-protocol/src/lib.rs | 3 +- crates/nu-plugin/Cargo.toml | 3 +- crates/nu-plugin/src/plugin/interface/mod.rs | 5 +- crates/nu-plugin/src/plugin/mod.rs | 2 +- crates/nu-protocol/src/engine/engine_state.rs | 38 +++----- crates/nu-protocol/src/engine/stack.rs | 39 +++++++- .../src/engine/state_working_set.rs | 6 +- crates/nu-protocol/src/eval_base.rs | 4 +- crates/nu-protocol/src/eval_const.rs | 6 +- 46 files changed, 327 insertions(+), 222 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index d4f759aed0..65192f0080 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -3255,6 +3255,7 @@ dependencies = [ "nu-plugin-core", "nu-plugin-protocol", "nu-protocol", + "nu-utils", "serde", "thiserror", "typetag", @@ -3284,6 +3285,7 @@ dependencies = [ "nu-plugin-protocol", "nu-protocol", "nu-system", + "nu-utils", "serde", "typetag", "windows 0.54.0", diff --git a/crates/nu-cli/src/eval_cmds.rs b/crates/nu-cli/src/eval_cmds.rs index 13141f6174..01d71829b2 100644 --- a/crates/nu-cli/src/eval_cmds.rs +++ b/crates/nu-cli/src/eval_cmds.rs @@ -53,9 +53,8 @@ pub fn evaluate_commands( // Parse the source code let (block, delta) = { if let Some(ref t_mode) = table_mode { - let mut config = engine_state.get_config().clone(); - config.table_mode = t_mode.coerce_str()?.parse().unwrap_or_default(); - engine_state.set_config(config); + Arc::make_mut(&mut engine_state.config).table_mode = + t_mode.coerce_str()?.parse().unwrap_or_default(); } let mut working_set = StateWorkingSet::new(engine_state); diff --git a/crates/nu-cli/src/menus/help_completions.rs b/crates/nu-cli/src/menus/help_completions.rs index c9c1b7bf94..ebe3fe616b 100644 --- a/crates/nu-cli/src/menus/help_completions.rs +++ b/crates/nu-cli/src/menus/help_completions.rs @@ -1,25 +1,31 @@ use nu_engine::documentation::get_flags_section; -use nu_protocol::{engine::EngineState, levenshtein_distance}; +use nu_protocol::{engine::EngineState, levenshtein_distance, Config}; use nu_utils::IgnoreCaseExt; use reedline::{Completer, Suggestion}; use std::{fmt::Write, sync::Arc}; -pub struct NuHelpCompleter(Arc); +pub struct NuHelpCompleter { + engine_state: Arc, + config: Arc, +} impl NuHelpCompleter { - pub fn new(engine_state: Arc) -> Self { - Self(engine_state) + pub fn new(engine_state: Arc, config: Arc) -> Self { + Self { + engine_state, + config, + } } fn completion_helper(&self, line: &str, pos: usize) -> Vec { let folded_line = line.to_folded_case(); let mut commands = self - .0 + .engine_state .get_decls_sorted(false) .into_iter() .filter_map(|(_, decl_id)| { - let decl = self.0.get_decl(decl_id); + let decl = self.engine_state.get_decl(decl_id); (decl.name().to_folded_case().contains(&folded_line) || decl.usage().to_folded_case().contains(&folded_line) || decl @@ -54,9 +60,12 @@ impl NuHelpCompleter { let _ = write!(long_desc, "Usage:\r\n > {}\r\n", sig.call_signature()); if !sig.named.is_empty() { - long_desc.push_str(&get_flags_section(Some(&*self.0.clone()), &sig, |v| { - v.to_parsable_string(", ", &self.0.config) - })) + long_desc.push_str(&get_flags_section( + Some(&self.engine_state), + Some(&self.config), + &sig, + |v| v.to_parsable_string(", ", &self.config), + )) } if !sig.required_positional.is_empty() @@ -71,7 +80,7 @@ impl NuHelpCompleter { let opt_suffix = if let Some(value) = &positional.default_value { format!( " (optional, default: {})", - &value.to_parsable_string(", ", &self.0.config), + &value.to_parsable_string(", ", &self.config), ) } else { (" (optional)").to_string() @@ -138,7 +147,8 @@ mod test { ) { let engine_state = nu_command::add_shell_command_context(nu_cmd_lang::create_default_context()); - let mut completer = NuHelpCompleter::new(engine_state.into()); + let config = engine_state.get_config().clone(); + let mut completer = NuHelpCompleter::new(engine_state.into(), config); let suggestions = completer.complete(line, end); assert_eq!( diff --git a/crates/nu-cli/src/nu_highlight.rs b/crates/nu-cli/src/nu_highlight.rs index f4f38296de..0b5f211838 100644 --- a/crates/nu-cli/src/nu_highlight.rs +++ b/crates/nu-cli/src/nu_highlight.rs @@ -1,3 +1,5 @@ +use std::sync::Arc; + use nu_engine::command_prelude::*; use reedline::{Highlighter, StyledText}; @@ -33,13 +35,10 @@ impl Command for NuHighlight { let head = call.head; let signals = engine_state.signals(); - let engine_state = std::sync::Arc::new(engine_state.clone()); - let config = engine_state.get_config().clone(); let highlighter = crate::NuHighlighter { - engine_state, - stack: std::sync::Arc::new(stack.clone()), - config, + engine_state: Arc::new(engine_state.clone()), + stack: Arc::new(stack.clone()), }; input.map( diff --git a/crates/nu-cli/src/reedline_config.rs b/crates/nu-cli/src/reedline_config.rs index dd5a3199dc..d5d3272bc1 100644 --- a/crates/nu-cli/src/reedline_config.rs +++ b/crates/nu-cli/src/reedline_config.rs @@ -77,13 +77,19 @@ pub(crate) fn add_menus( mut line_editor: Reedline, engine_state_ref: Arc, stack: &Stack, - config: &Config, + config: Arc, ) -> Result { //log::trace!("add_menus: config: {:#?}", &config); line_editor = line_editor.clear_menus(); for menu in &config.menus { - line_editor = add_menu(line_editor, menu, engine_state_ref.clone(), stack, config)? + line_editor = add_menu( + line_editor, + menu, + engine_state_ref.clone(), + stack, + config.clone(), + )? } // Checking if the default menus have been added from the config file @@ -100,7 +106,7 @@ pub(crate) fn add_menus( if !config .menus .iter() - .any(|menu| menu.name.to_expanded_string("", config) == name) + .any(|menu| menu.name.to_expanded_string("", &config) == name) { let (block, delta) = { let mut working_set = StateWorkingSet::new(&engine_state); @@ -137,7 +143,7 @@ pub(crate) fn add_menus( &menu, new_engine_state_ref.clone(), stack, - config, + config.clone(), )?; } } @@ -151,27 +157,27 @@ fn add_menu( menu: &ParsedMenu, engine_state: Arc, stack: &Stack, - config: &Config, + config: Arc, ) -> Result { let span = menu.menu_type.span(); if let Value::Record { val, .. } = &menu.menu_type { - let layout = extract_value("layout", val, span)?.to_expanded_string("", config); + let layout = extract_value("layout", val, span)?.to_expanded_string("", &config); match layout.as_str() { - "columnar" => add_columnar_menu(line_editor, menu, engine_state, stack, config), + "columnar" => add_columnar_menu(line_editor, menu, engine_state, stack, &config), "list" => add_list_menu(line_editor, menu, engine_state, stack, config), "ide" => add_ide_menu(line_editor, menu, engine_state, stack, config), "description" => add_description_menu(line_editor, menu, engine_state, stack, config), _ => Err(ShellError::UnsupportedConfigValue { expected: "columnar, list, ide or description".to_string(), - value: menu.menu_type.to_abbreviated_string(config), + value: menu.menu_type.to_abbreviated_string(&config), span: menu.menu_type.span(), }), } } else { Err(ShellError::UnsupportedConfigValue { expected: "only record type".to_string(), - value: menu.menu_type.to_abbreviated_string(config), + value: menu.menu_type.to_abbreviated_string(&config), span: menu.menu_type.span(), }) } @@ -282,9 +288,9 @@ pub(crate) fn add_list_menu( menu: &ParsedMenu, engine_state: Arc, stack: &Stack, - config: &Config, + config: Arc, ) -> Result { - let name = menu.name.to_expanded_string("", config); + let name = menu.name.to_expanded_string("", &config); let mut list_menu = ListMenu::default().with_name(&name); let span = menu.menu_type.span(); @@ -311,7 +317,7 @@ pub(crate) fn add_list_menu( } } - let marker = menu.marker.to_expanded_string("", config); + let marker = menu.marker.to_expanded_string("", &config); list_menu = list_menu.with_marker(&marker); let only_buffer_difference = menu.only_buffer_difference.as_bool()?; @@ -337,7 +343,7 @@ pub(crate) fn add_list_menu( } _ => Err(ShellError::UnsupportedConfigValue { expected: "block or omitted value".to_string(), - value: menu.source.to_abbreviated_string(config), + value: menu.source.to_abbreviated_string(&config), span: menu.source.span(), }), } @@ -349,10 +355,10 @@ pub(crate) fn add_ide_menu( menu: &ParsedMenu, engine_state: Arc, stack: &Stack, - config: &Config, + config: Arc, ) -> Result { let span = menu.menu_type.span(); - let name = menu.name.to_expanded_string("", config); + let name = menu.name.to_expanded_string("", &config); let mut ide_menu = IdeMenu::default().with_name(&name); if let Value::Record { val, .. } = &menu.menu_type { @@ -417,7 +423,7 @@ pub(crate) fn add_ide_menu( } else { return Err(ShellError::UnsupportedConfigValue { expected: "bool or record".to_string(), - value: border.to_abbreviated_string(config), + value: border.to_abbreviated_string(&config), span: border.span(), }); } @@ -441,7 +447,7 @@ pub(crate) fn add_ide_menu( _ => { return Err(ShellError::UnsupportedConfigValue { expected: "\"left\", \"right\" or \"prefer_right\"".to_string(), - value: description_mode.to_abbreviated_string(config), + value: description_mode.to_abbreviated_string(&config), span: description_mode.span(), }); } @@ -509,7 +515,7 @@ pub(crate) fn add_ide_menu( } } - let marker = menu.marker.to_expanded_string("", config); + let marker = menu.marker.to_expanded_string("", &config); ide_menu = ide_menu.with_marker(&marker); let only_buffer_difference = menu.only_buffer_difference.as_bool()?; @@ -535,7 +541,7 @@ pub(crate) fn add_ide_menu( } _ => Err(ShellError::UnsupportedConfigValue { expected: "block or omitted value".to_string(), - value: menu.source.to_abbreviated_string(config), + value: menu.source.to_abbreviated_string(&config), span, }), } @@ -547,9 +553,9 @@ pub(crate) fn add_description_menu( menu: &ParsedMenu, engine_state: Arc, stack: &Stack, - config: &Config, + config: Arc, ) -> Result { - let name = menu.name.to_expanded_string("", config); + let name = menu.name.to_expanded_string("", &config); let mut description_menu = DescriptionMenu::default().with_name(&name); let span = menu.menu_type.span(); @@ -608,7 +614,7 @@ pub(crate) fn add_description_menu( } } - let marker = menu.marker.to_expanded_string("", config); + let marker = menu.marker.to_expanded_string("", &config); description_menu = description_menu.with_marker(&marker); let only_buffer_difference = menu.only_buffer_difference.as_bool()?; @@ -617,7 +623,7 @@ pub(crate) fn add_description_menu( let span = menu.source.span(); match &menu.source { Value::Nothing { .. } => { - let completer = Box::new(NuHelpCompleter::new(engine_state)); + let completer = Box::new(NuHelpCompleter::new(engine_state, config)); Ok(line_editor.with_menu(ReedlineMenu::WithCompleter { menu: Box::new(description_menu), completer, @@ -638,7 +644,7 @@ pub(crate) fn add_description_menu( } _ => Err(ShellError::UnsupportedConfigValue { expected: "closure or omitted value".to_string(), - value: menu.source.to_abbreviated_string(config), + value: menu.source.to_abbreviated_string(&config), span: menu.source.span(), }), } diff --git a/crates/nu-cli/src/repl.rs b/crates/nu-cli/src/repl.rs index 7099b70ba8..f1a7912a50 100644 --- a/crates/nu-cli/src/repl.rs +++ b/crates/nu-cli/src/repl.rs @@ -294,7 +294,7 @@ fn loop_iteration(ctx: LoopContext) -> (bool, Stack, Reedline) { perf!("env-change hook", start_time, use_color); let engine_reference = Arc::new(engine_state.clone()); - let config = engine_state.get_config(); + let config = stack.get_config(engine_state); start_time = std::time::Instant::now(); // Find the configured cursor shapes for each mode @@ -320,7 +320,6 @@ fn loop_iteration(ctx: LoopContext) -> (bool, Stack, Reedline) { engine_state: engine_reference.clone(), // STACK-REFERENCE 1 stack: stack_arc.clone(), - config: config.clone(), })) .with_validator(Box::new(NuValidator { engine_state: engine_reference.clone(), diff --git a/crates/nu-cli/src/syntax_highlight.rs b/crates/nu-cli/src/syntax_highlight.rs index 41ef168390..08dcbb1346 100644 --- a/crates/nu-cli/src/syntax_highlight.rs +++ b/crates/nu-cli/src/syntax_highlight.rs @@ -6,7 +6,7 @@ use nu_parser::{flatten_block, parse, FlatShape}; use nu_protocol::{ ast::{Block, Expr, Expression, PipelineRedirection, RecordItem}, engine::{EngineState, Stack, StateWorkingSet}, - Config, Span, + Span, }; use reedline::{Highlighter, StyledText}; use std::sync::Arc; @@ -14,15 +14,14 @@ use std::sync::Arc; pub struct NuHighlighter { pub engine_state: Arc, pub stack: Arc, - pub config: Config, } impl Highlighter for NuHighlighter { fn highlight(&self, line: &str, _cursor: usize) -> StyledText { trace!("highlighting: {}", line); - let highlight_resolved_externals = - self.engine_state.get_config().highlight_resolved_externals; + let config = self.stack.get_config(&self.engine_state); + let highlight_resolved_externals = config.highlight_resolved_externals; let mut working_set = StateWorkingSet::new(&self.engine_state); let block = parse(&mut working_set, None, line.as_bytes(), false); let (shapes, global_span_offset) = { @@ -88,7 +87,7 @@ impl Highlighter for NuHighlighter { .to_string(); let mut add_colored_token = |shape: &FlatShape, text: String| { - output.push((get_shape_color(shape.as_str(), &self.config), text)); + output.push((get_shape_color(shape.as_str(), &config), text)); }; match shape.1 { @@ -128,9 +127,9 @@ impl Highlighter for NuHighlighter { let start = part.start - span.start; let end = part.end - span.start; let text = next_token[start..end].to_string(); - let mut style = get_shape_color(shape.as_str(), &self.config); + let mut style = get_shape_color(shape.as_str(), &config); if highlight { - style = get_matching_brackets_style(style, &self.config); + style = get_matching_brackets_style(style, &config); } output.push((style, text)); } diff --git a/crates/nu-cmd-extra/src/extra/formats/to/html.rs b/crates/nu-cmd-extra/src/extra/formats/to/html.rs index 83d0b58b3f..f02f11cf84 100644 --- a/crates/nu-cmd-extra/src/extra/formats/to/html.rs +++ b/crates/nu-cmd-extra/src/extra/formats/to/html.rs @@ -239,7 +239,7 @@ fn to_html( let partial = call.has_flag(engine_state, stack, "partial")?; let list = call.has_flag(engine_state, stack, "list")?; let theme: Option> = call.get_flag(engine_state, stack, "theme")?; - let config = engine_state.get_config(); + let config = &stack.get_config(engine_state); let vec_of_values = input.into_iter().collect::>(); let headers = merge_descriptors(&vec_of_values); diff --git a/crates/nu-cmd-extra/src/extra/strings/format/command.rs b/crates/nu-cmd-extra/src/extra/strings/format/command.rs index 08df92ef40..ef9b6f2baf 100644 --- a/crates/nu-cmd-extra/src/extra/strings/format/command.rs +++ b/crates/nu-cmd-extra/src/extra/strings/format/command.rs @@ -1,5 +1,5 @@ use nu_engine::command_prelude::*; -use nu_protocol::{ast::PathMember, engine::StateWorkingSet, ListStream}; +use nu_protocol::{ast::PathMember, engine::StateWorkingSet, Config, ListStream}; #[derive(Clone)] pub struct FormatPattern; @@ -43,6 +43,8 @@ impl Command for FormatPattern { let it_id = working_set.add_variable(b"$it".to_vec(), call.head, Type::Any, false); stack.add_var(it_id, input_val.clone()); + let config = stack.get_config(engine_state); + match specified_pattern { Err(e) => Err(e), Ok(pattern) => { @@ -56,7 +58,7 @@ impl Command for FormatPattern { string_span.start + 1, )?; - format(input_val, &ops, engine_state, call.head) + format(input_val, &ops, engine_state, &config, call.head) } } } @@ -181,33 +183,30 @@ fn format( input_data: Value, format_operations: &[FormatOperation], engine_state: &EngineState, + config: &Config, head_span: Span, ) -> Result { let data_as_value = input_data; // We can only handle a Record or a List of Records match data_as_value { - Value::Record { .. } => { - match format_record(format_operations, &data_as_value, engine_state) { - Ok(value) => Ok(PipelineData::Value(Value::string(value, head_span), None)), - Err(value) => Err(value), - } - } + Value::Record { .. } => match format_record(format_operations, &data_as_value, config) { + Ok(value) => Ok(PipelineData::Value(Value::string(value, head_span), None)), + Err(value) => Err(value), + }, Value::List { vals, .. } => { let mut list = vec![]; for val in vals.iter() { match val { - Value::Record { .. } => { - match format_record(format_operations, val, engine_state) { - Ok(value) => { - list.push(Value::string(value, head_span)); - } - Err(value) => { - return Err(value); - } + Value::Record { .. } => match format_record(format_operations, val, config) { + Ok(value) => { + list.push(Value::string(value, head_span)); } - } + Err(value) => { + return Err(value); + } + }, Value::Error { error, .. } => return Err(*error.clone()), _ => { return Err(ShellError::OnlySupportsThisInputType { @@ -237,9 +236,8 @@ fn format( fn format_record( format_operations: &[FormatOperation], data_as_value: &Value, - engine_state: &EngineState, + config: &Config, ) -> Result { - let config = engine_state.get_config(); let mut output = String::new(); for op in format_operations { diff --git a/crates/nu-color-config/src/style_computer.rs b/crates/nu-color-config/src/style_computer.rs index 91907c1428..edc8786a53 100644 --- a/crates/nu-color-config/src/style_computer.rs +++ b/crates/nu-color-config/src/style_computer.rs @@ -1,6 +1,6 @@ use crate::{color_record_to_nustyle, lookup_ansi_color_style, text_style::Alignment, TextStyle}; use nu_ansi_term::{Color, Style}; -use nu_engine::{env::get_config, ClosureEvalOnce}; +use nu_engine::ClosureEvalOnce; use nu_protocol::{ cli_error::CliError, engine::{Closure, EngineState, Stack, StateWorkingSet}, @@ -114,7 +114,7 @@ impl<'a> StyleComputer<'a> { // The main constructor. pub fn from_config(engine_state: &'a EngineState, stack: &'a Stack) -> StyleComputer<'a> { - let config = get_config(engine_state, stack); + let config = stack.get_config(engine_state); // Create the hashmap #[rustfmt::skip] diff --git a/crates/nu-command/src/conversions/into/string.rs b/crates/nu-command/src/conversions/into/string.rs index c394f9fd21..2b35272b3e 100644 --- a/crates/nu-command/src/conversions/into/string.rs +++ b/crates/nu-command/src/conversions/into/string.rs @@ -1,3 +1,5 @@ +use std::sync::Arc; + use nu_cmd_base::input_handler::{operate, CmdArgument}; use nu_engine::command_prelude::*; use nu_protocol::{into_code, Config}; @@ -7,7 +9,7 @@ use num_format::ToFormattedString; struct Arguments { decimals_value: Option, cell_paths: Option>, - config: Config, + config: Arc, } impl CmdArgument for Arguments { @@ -174,7 +176,7 @@ fn string_helper( }) } } else { - let config = engine_state.get_config().clone(); + let config = stack.get_config(engine_state); let args = Arguments { decimals_value, cell_paths, diff --git a/crates/nu-command/src/debug/debug_.rs b/crates/nu-command/src/debug/debug_.rs index f4e5707491..80a9067e49 100644 --- a/crates/nu-command/src/debug/debug_.rs +++ b/crates/nu-command/src/debug/debug_.rs @@ -33,7 +33,7 @@ impl Command for Debug { input: PipelineData, ) -> Result { let head = call.head; - let config = engine_state.get_config().clone(); + let config = stack.get_config(engine_state); let raw = call.has_flag(engine_state, stack, "raw")?; // Should PipelineData::Empty result in an error here? diff --git a/crates/nu-command/src/filesystem/rm.rs b/crates/nu-command/src/filesystem/rm.rs index d67046ffe1..9eb4fabace 100644 --- a/crates/nu-command/src/filesystem/rm.rs +++ b/crates/nu-command/src/filesystem/rm.rs @@ -170,7 +170,7 @@ fn rm( } let span = call.head; - let rm_always_trash = engine_state.get_config().rm_always_trash; + let rm_always_trash = stack.get_config(engine_state).rm_always_trash; if !TRASH_SUPPORTED { if rm_always_trash { diff --git a/crates/nu-command/src/filters/find.rs b/crates/nu-command/src/filters/find.rs index 7669190f7e..9ed0c28a3c 100644 --- a/crates/nu-command/src/filters/find.rs +++ b/crates/nu-command/src/filters/find.rs @@ -213,7 +213,7 @@ fn find_with_regex( input: PipelineData, ) -> Result { let span = call.head; - let config = engine_state.get_config().clone(); + let config = stack.get_config(engine_state); let insensitive = call.has_flag(engine_state, stack, "ignore-case")?; let multiline = call.has_flag(engine_state, stack, "multiline")?; @@ -348,8 +348,8 @@ fn find_with_rest_and_highlight( input: PipelineData, ) -> Result { let span = call.head; - let config = engine_state.get_config().clone(); - let filter_config = engine_state.get_config().clone(); + let config = stack.get_config(engine_state); + let filter_config = config.clone(); let invert = call.has_flag(engine_state, stack, "invert")?; let terms = call.rest::(engine_state, stack, 0)?; let lower_terms = terms diff --git a/crates/nu-command/src/formats/to/md.rs b/crates/nu-command/src/formats/to/md.rs index e2acdd703e..737a328cd3 100644 --- a/crates/nu-command/src/formats/to/md.rs +++ b/crates/nu-command/src/formats/to/md.rs @@ -70,8 +70,8 @@ impl Command for ToMd { let head = call.head; let pretty = call.has_flag(engine_state, stack, "pretty")?; let per_element = call.has_flag(engine_state, stack, "per-element")?; - let config = engine_state.get_config(); - to_md(input, pretty, per_element, config, head) + let config = stack.get_config(engine_state); + to_md(input, pretty, per_element, &config, head) } } diff --git a/crates/nu-command/src/formats/to/text.rs b/crates/nu-command/src/formats/to/text.rs index 82b853248c..33ca19f8f2 100644 --- a/crates/nu-command/src/formats/to/text.rs +++ b/crates/nu-command/src/formats/to/text.rs @@ -31,18 +31,19 @@ impl Command for ToText { fn run( &self, engine_state: &EngineState, - _stack: &mut Stack, + stack: &mut Stack, call: &Call, input: PipelineData, ) -> Result { let span = call.head; let input = input.try_expand_range()?; + let config = stack.get_config(engine_state); match input { PipelineData::Empty => Ok(Value::string(String::new(), span) .into_pipeline_data_with_metadata(update_metadata(None))), PipelineData::Value(value, ..) => { - let str = local_into_string(value, LINE_ENDING, engine_state.get_config()); + let str = local_into_string(value, LINE_ENDING, &config); Ok( Value::string(str, span) .into_pipeline_data_with_metadata(update_metadata(None)), @@ -50,7 +51,6 @@ impl Command for ToText { } PipelineData::ListStream(stream, meta) => { let span = stream.span(); - let config = engine_state.get_config().clone(); let iter = stream.into_inner().map(move |value| { let mut str = local_into_string(value, LINE_ENDING, &config); str.push_str(LINE_ENDING); diff --git a/crates/nu-command/src/help/help_aliases.rs b/crates/nu-command/src/help/help_aliases.rs index da03fa6398..41af9da0b3 100644 --- a/crates/nu-command/src/help/help_aliases.rs +++ b/crates/nu-command/src/help/help_aliases.rs @@ -143,7 +143,7 @@ pub fn help_aliases( long_desc.push_str("\n\n"); long_desc.push_str(&format!("{G}Expansion{RESET}:\n {alias_expansion}")); - let config = engine_state.get_config(); + let config = stack.get_config(engine_state); if !config.use_ansi_coloring { long_desc = nu_utils::strip_ansi_string_likely(long_desc); } diff --git a/crates/nu-command/src/help/help_modules.rs b/crates/nu-command/src/help/help_modules.rs index 5b39133a6d..c2c00cf400 100644 --- a/crates/nu-command/src/help/help_modules.rs +++ b/crates/nu-command/src/help/help_modules.rs @@ -230,7 +230,7 @@ pub fn help_modules( )); } - let config = engine_state.get_config(); + let config = stack.get_config(engine_state); if !config.use_ansi_coloring { long_desc = nu_utils::strip_ansi_string_likely(long_desc); } diff --git a/crates/nu-command/src/network/url/parse.rs b/crates/nu-command/src/network/url/parse.rs index e71c8d472a..287c64c7b9 100644 --- a/crates/nu-command/src/network/url/parse.rs +++ b/crates/nu-command/src/network/url/parse.rs @@ -1,4 +1,5 @@ use nu_engine::command_prelude::*; +use nu_protocol::Config; use url::Url; #[derive(Clone)] @@ -38,11 +39,15 @@ impl Command for SubCommand { fn run( &self, engine_state: &EngineState, - _: &mut Stack, + stack: &mut Stack, call: &Call, input: PipelineData, ) -> Result { - parse(input.into_value(call.head)?, call.head, engine_state) + parse( + input.into_value(call.head)?, + call.head, + &stack.get_config(engine_state), + ) } fn examples(&self) -> Vec { @@ -68,12 +73,12 @@ impl Command for SubCommand { } } -fn get_url_string(value: &Value, engine_state: &EngineState) -> String { - value.to_expanded_string("", engine_state.get_config()) +fn get_url_string(value: &Value, config: &Config) -> String { + value.to_expanded_string("", config) } -fn parse(value: Value, head: Span, engine_state: &EngineState) -> Result { - let url_string = get_url_string(&value, engine_state); +fn parse(value: Value, head: Span, config: &Config) -> Result { + let url_string = get_url_string(&value, config); let result_url = Url::parse(url_string.as_str()); diff --git a/crates/nu-command/src/platform/ansi/ansi_.rs b/crates/nu-command/src/platform/ansi/ansi_.rs index 29603be9e7..62e5094872 100644 --- a/crates/nu-command/src/platform/ansi/ansi_.rs +++ b/crates/nu-command/src/platform/ansi/ansi_.rs @@ -653,7 +653,7 @@ Operating system commands: let list: bool = call.has_flag(engine_state, stack, "list")?; let escape: bool = call.has_flag(engine_state, stack, "escape")?; let osc: bool = call.has_flag(engine_state, stack, "osc")?; - let use_ansi_coloring = engine_state.get_config().use_ansi_coloring; + let use_ansi_coloring = stack.get_config(engine_state).use_ansi_coloring; if list { return Ok(generate_ansi_code_list( diff --git a/crates/nu-command/src/platform/ansi/strip.rs b/crates/nu-command/src/platform/ansi/strip.rs index 3d59da6a10..4f7f8ea596 100644 --- a/crates/nu-command/src/platform/ansi/strip.rs +++ b/crates/nu-command/src/platform/ansi/strip.rs @@ -1,10 +1,12 @@ +use std::sync::Arc; + use nu_cmd_base::input_handler::{operate, CmdArgument}; use nu_engine::command_prelude::*; use nu_protocol::Config; pub struct Arguments { cell_paths: Option>, - config: Config, + config: Arc, } impl CmdArgument for Arguments { @@ -51,11 +53,8 @@ impl Command for SubCommand { ) -> Result { let cell_paths: Vec = call.rest(engine_state, stack, 1)?; let cell_paths = (!cell_paths.is_empty()).then_some(cell_paths); - let config = engine_state.get_config(); - let args = Arguments { - cell_paths, - config: config.clone(), - }; + let config = stack.get_config(engine_state); + let args = Arguments { cell_paths, config }; operate(action, args, input, call.head, engine_state.signals()) } diff --git a/crates/nu-command/src/platform/input/list.rs b/crates/nu-command/src/platform/input/list.rs index 44b21a8da4..37f16e75d7 100644 --- a/crates/nu-command/src/platform/input/list.rs +++ b/crates/nu-command/src/platform/input/list.rs @@ -79,6 +79,7 @@ impl Command for InputList { let fuzzy = call.has_flag(engine_state, stack, "fuzzy")?; let index = call.has_flag(engine_state, stack, "index")?; let display_path: Option = call.get_flag(engine_state, stack, "display")?; + let config = stack.get_config(engine_state); let options: Vec = match input { PipelineData::Value(Value::Range { .. }, ..) @@ -89,9 +90,9 @@ impl Command for InputList { let display_value = if let Some(ref cellpath) = display_path { val.clone() .follow_cell_path(&cellpath.members, false)? - .to_expanded_string(", ", engine_state.get_config()) + .to_expanded_string(", ", &config) } else { - val.to_expanded_string(", ", engine_state.get_config()) + val.to_expanded_string(", ", &config) }; Ok(Options { name: display_value, diff --git a/crates/nu-command/src/stor/insert.rs b/crates/nu-command/src/stor/insert.rs index b6b8d50906..0e5c9ec6af 100644 --- a/crates/nu-command/src/stor/insert.rs +++ b/crates/nu-command/src/stor/insert.rs @@ -65,7 +65,7 @@ impl Command for StorInsert { let span = call.head; let table_name: Option = call.get_flag(engine_state, stack, "table-name")?; let data_record: Option = call.get_flag(engine_state, stack, "data-record")?; - // let config = engine_state.get_config(); + // let config = stack.get_config(engine_state); let db = Box::new(SQLiteDatabase::new( std::path::Path::new(MEMORY_DB), Signals::empty(), diff --git a/crates/nu-command/src/strings/detect_columns.rs b/crates/nu-command/src/strings/detect_columns.rs index 2f1f713b33..37a7cfe303 100644 --- a/crates/nu-command/src/strings/detect_columns.rs +++ b/crates/nu-command/src/strings/detect_columns.rs @@ -1,7 +1,7 @@ use itertools::Itertools; use nu_engine::command_prelude::*; -use nu_protocol::Range; -use std::{io::Cursor, iter::Peekable, str::CharIndices}; +use nu_protocol::{Config, Range}; +use std::{io::Cursor, iter::Peekable, str::CharIndices, sync::Arc}; type Input<'t> = Peekable>; @@ -110,11 +110,13 @@ none 8150224 4 8150220 1% /mnt/c' | detect columns --gue let num_rows_to_skip: Option = call.get_flag(engine_state, stack, "skip")?; let noheader = call.has_flag(engine_state, stack, "no-headers")?; let range: Option = call.get_flag(engine_state, stack, "combine-columns")?; + let config = stack.get_config(engine_state); let args = Arguments { noheader, num_rows_to_skip, range, + config, }; if call.has_flag(engine_state, stack, "guess")? { @@ -133,11 +135,13 @@ none 8150224 4 8150220 1% /mnt/c' | detect columns --gue let num_rows_to_skip: Option = call.get_flag_const(working_set, "skip")?; let noheader = call.has_flag_const(working_set, "no-headers")?; let range: Option = call.get_flag_const(working_set, "combine-columns")?; + let config = working_set.get_config().clone(); let args = Arguments { noheader, num_rows_to_skip, range, + config, }; if call.has_flag_const(working_set, "guess")? { @@ -152,6 +156,7 @@ struct Arguments { num_rows_to_skip: Option, noheader: bool, range: Option, + config: Arc, } fn guess_width( @@ -163,7 +168,7 @@ fn guess_width( use super::guess_width::GuessWidth; let input_span = input.span().unwrap_or(call.head); - let mut input = input.collect_string("", engine_state.get_config())?; + let mut input = input.collect_string("", &args.config)?; if let Some(rows) = args.num_rows_to_skip { input = input.lines().skip(rows).map(|x| x.to_string()).join("\n"); } @@ -235,8 +240,7 @@ fn detect_columns( args: Arguments, ) -> Result { let name_span = call.head; - let config = engine_state.get_config(); - let input = input.collect_string("", config)?; + let input = input.collect_string("", &args.config)?; let input: Vec<_> = input .lines() diff --git a/crates/nu-command/src/system/nu_check.rs b/crates/nu-command/src/system/nu_check.rs index f9e0879c00..8435d12d81 100644 --- a/crates/nu-command/src/system/nu_check.rs +++ b/crates/nu-command/src/system/nu_check.rs @@ -1,4 +1,4 @@ -use nu_engine::{command_prelude::*, env::get_config, find_in_dirs_env, get_dirs_var_from_call}; +use nu_engine::{command_prelude::*, find_in_dirs_env, get_dirs_var_from_call}; use nu_parser::{parse, parse_module_block, parse_module_file_or_dir, unescape_unquote_string}; use nu_protocol::engine::{FileStack, StateWorkingSet}; use std::path::Path; @@ -59,7 +59,7 @@ impl Command for NuCheck { } } PipelineData::ListStream(stream, ..) => { - let config = get_config(engine_state, stack); + let config = stack.get_config(engine_state); let list_stream = stream.into_string("\n", &config); let contents = Vec::from(list_stream); diff --git a/crates/nu-command/src/system/run_external.rs b/crates/nu-command/src/system/run_external.rs index 06bc5a69ca..c5d4153a3f 100644 --- a/crates/nu-command/src/system/run_external.rs +++ b/crates/nu-command/src/system/run_external.rs @@ -392,7 +392,7 @@ pub fn command_not_found( stack: &mut Stack, ) -> ShellError { // Run the `command_not_found` hook if there is one. - if let Some(hook) = &engine_state.config.hooks.command_not_found { + if let Some(hook) = &stack.get_config(engine_state).hooks.command_not_found { let mut stack = stack.start_capture(); // Set a special environment variable to avoid infinite loops when the // `command_not_found` hook triggers itself. diff --git a/crates/nu-command/src/viewers/griddle.rs b/crates/nu-command/src/viewers/griddle.rs index cd73c1ca71..c3e003be39 100644 --- a/crates/nu-command/src/viewers/griddle.rs +++ b/crates/nu-command/src/viewers/griddle.rs @@ -61,7 +61,7 @@ prints out the list properly."# let width_param: Option = call.get_flag(engine_state, stack, "width")?; let color_param: bool = call.has_flag(engine_state, stack, "color")?; let separator_param: Option = call.get_flag(engine_state, stack, "separator")?; - let config = engine_state.get_config(); + let config = &stack.get_config(engine_state); let env_str = match stack.get_env_var(engine_state, "LS_COLORS") { Some(v) => Some(env_to_string("LS_COLORS", &v, engine_state, stack)?), None => None, diff --git a/crates/nu-command/src/viewers/table.rs b/crates/nu-command/src/viewers/table.rs index e3738a3952..a52dbc6405 100644 --- a/crates/nu-command/src/viewers/table.rs +++ b/crates/nu-command/src/viewers/table.rs @@ -4,7 +4,7 @@ use lscolors::{LsColors, Style}; use nu_color_config::{color_from_hex, StyleComputer, TextStyle}; -use nu_engine::{command_prelude::*, env::get_config, env_to_string}; +use nu_engine::{command_prelude::*, env_to_string}; use nu_pretty_hex::HexConfig; use nu_protocol::{ ByteStream, Config, DataSource, ListStream, PipelineMetadata, Signals, TableMode, ValueIterator, @@ -258,7 +258,7 @@ fn parse_table_config( let flatten_separator: Option = call.get_flag(state, stack, "flatten-separator")?; let abbrivation: Option = call .get_flag(state, stack, "abbreviated")? - .or_else(|| get_config(state, stack).table_abbreviation_threshold); + .or_else(|| stack.get_config(state).table_abbreviation_threshold); let table_view = match (expand, collapse) { (false, false) => TableView::General, (_, true) => TableView::Collapsed, @@ -269,7 +269,7 @@ fn parse_table_config( }, }; let theme = - get_theme_flag(call, state, stack)?.unwrap_or_else(|| get_config(state, stack).table_mode); + get_theme_flag(call, state, stack)?.unwrap_or_else(|| stack.get_config(state).table_mode); let index = get_index_flag(call, state, stack)?; let term_width = get_width_param(width_param); @@ -493,7 +493,11 @@ fn handle_record( cfg: TableConfig, mut record: Record, ) -> Result { - let config = get_config(input.engine_state, input.stack); + let config = { + let state = input.engine_state; + let stack: &Stack = input.stack; + stack.get_config(state) + }; let span = input.data.span().unwrap_or(input.call.head); let styles = &StyleComputer::from_config(input.engine_state, input.stack); @@ -608,7 +612,11 @@ fn handle_row_stream( data_source: DataSource::Ls, .. }) => { - let config = get_config(input.engine_state, input.stack); + let config = { + let state = input.engine_state; + let stack: &Stack = input.stack; + stack.get_config(state) + }; let ls_colors_env_str = match input.stack.get_env_var(input.engine_state, "LS_COLORS") { Some(v) => Some(env_to_string( "LS_COLORS", @@ -758,7 +766,11 @@ impl PagingTableCreator { return Ok(None); } - let cfg = get_config(&self.engine_state, &self.stack); + let cfg = { + let state = &self.engine_state; + let stack = &self.stack; + stack.get_config(state) + }; let style_comp = StyleComputer::from_config(&self.engine_state, &self.stack); let opts = self.create_table_opts(&cfg, &style_comp); let view = TableView::Expanded { @@ -775,7 +787,11 @@ impl PagingTableCreator { return Ok(None); } - let cfg = get_config(&self.engine_state, &self.stack); + let cfg = { + let state = &self.engine_state; + let stack = &self.stack; + stack.get_config(state) + }; let style_comp = StyleComputer::from_config(&self.engine_state, &self.stack); let opts = self.create_table_opts(&cfg, &style_comp); @@ -783,7 +799,11 @@ impl PagingTableCreator { } fn build_general(&mut self, batch: Vec) -> StringResult { - let cfg = get_config(&self.engine_state, &self.stack); + let cfg = { + let state = &self.engine_state; + let stack = &self.stack; + stack.get_config(state) + }; let style_comp = StyleComputer::from_config(&self.engine_state, &self.stack); let opts = self.create_table_opts(&cfg, &style_comp); @@ -872,7 +892,11 @@ impl Iterator for PagingTableCreator { self.row_offset += batch_size; - let config = get_config(&self.engine_state, &self.stack); + let config = { + let state = &self.engine_state; + let stack = &self.stack; + stack.get_config(state) + }; convert_table_to_output( table, &config, @@ -1049,7 +1073,7 @@ fn create_empty_placeholder( engine_state: &EngineState, stack: &Stack, ) -> String { - let config = get_config(engine_state, stack); + let config = stack.get_config(engine_state); if !config.table_show_empty { return String::new(); } diff --git a/crates/nu-engine/src/documentation.rs b/crates/nu-engine/src/documentation.rs index a7d4950036..8530d08cad 100644 --- a/crates/nu-engine/src/documentation.rs +++ b/crates/nu-engine/src/documentation.rs @@ -3,8 +3,8 @@ use nu_protocol::{ ast::{Argument, Call, Expr, Expression, RecordItem}, debugger::WithoutDebug, engine::{Command, EngineState, Stack, UNKNOWN_SPAN_ID}, - record, Category, Example, IntoPipelineData, PipelineData, Signature, Span, SpanId, Spanned, - SyntaxShape, Type, Value, + record, Category, Config, Example, IntoPipelineData, PipelineData, Signature, Span, SpanId, + Spanned, SyntaxShape, Type, Value, }; use std::{collections::HashMap, fmt::Write}; @@ -13,7 +13,7 @@ pub fn get_full_help( engine_state: &EngineState, stack: &mut Stack, ) -> String { - let config = engine_state.get_config(); + let config = stack.get_config(engine_state); let doc_config = DocumentationConfig { no_subcommands: false, no_color: !config.use_ansi_coloring, @@ -68,16 +68,30 @@ fn get_documentation( config: &DocumentationConfig, is_parser_keyword: bool, ) -> String { + let nu_config = stack.get_config(engine_state); + // Create ansi colors //todo make these configurable -- pull from enginestate.config - let help_section_name: String = - get_ansi_color_for_component_or_default(engine_state, "shape_string", "\x1b[32m"); // default: green + let help_section_name: String = get_ansi_color_for_component_or_default( + engine_state, + &nu_config, + "shape_string", + "\x1b[32m", + ); // default: green - let help_subcolor_one: String = - get_ansi_color_for_component_or_default(engine_state, "shape_external", "\x1b[36m"); // default: cyan - // was const bb: &str = "\x1b[1;34m"; // bold blue - let help_subcolor_two: String = - get_ansi_color_for_component_or_default(engine_state, "shape_block", "\x1b[94m"); // default: light blue (nobold, should be bolding the *names*) + let help_subcolor_one: String = get_ansi_color_for_component_or_default( + engine_state, + &nu_config, + "shape_external", + "\x1b[36m", + ); // default: cyan + // was const bb: &str = "\x1b[1;34m"; // bold blue + let help_subcolor_two: String = get_ansi_color_for_component_or_default( + engine_state, + &nu_config, + "shape_block", + "\x1b[94m", + ); // default: light blue (nobold, should be bolding the *names*) const RESET: &str = "\x1b[0m"; // reset @@ -137,13 +151,12 @@ fn get_documentation( } if !sig.named.is_empty() { - long_desc.push_str(&get_flags_section(Some(engine_state), sig, |v| { - nu_highlight_string( - &v.to_parsable_string(", ", &engine_state.config), - engine_state, - stack, - ) - })) + long_desc.push_str(&get_flags_section( + Some(engine_state), + Some(&nu_config), + sig, + |v| nu_highlight_string(&v.to_parsable_string(", ", &nu_config), engine_state, stack), + )) } if !sig.required_positional.is_empty() @@ -187,7 +200,7 @@ fn get_documentation( format!( " (optional, default: {})", nu_highlight_string( - &value.to_parsable_string(", ", &engine_state.config), + &value.to_parsable_string(", ", &nu_config), engine_state, stack ) @@ -336,7 +349,7 @@ fn get_documentation( let _ = writeln!( long_desc, " {}", - item.to_expanded_string("", engine_state.get_config()) + item.to_expanded_string("", &nu_config) .replace('\n', "\n ") .trim() ); @@ -355,15 +368,16 @@ fn get_documentation( fn get_ansi_color_for_component_or_default( engine_state: &EngineState, + nu_config: &Config, theme_component: &str, default: &str, ) -> String { - if let Some(color) = &engine_state.get_config().color_config.get(theme_component) { + if let Some(color) = &nu_config.color_config.get(theme_component) { let caller_stack = &mut Stack::new().capture(); let span = Span::unknown(); let span_id = UNKNOWN_SPAN_ID; - let argument_opt = get_argument_for_color_value(engine_state, color, span, span_id); + let argument_opt = get_argument_for_color_value(nu_config, color, span, span_id); // Call ansi command using argument if let Some(argument) = argument_opt { @@ -391,8 +405,8 @@ fn get_ansi_color_for_component_or_default( } fn get_argument_for_color_value( - engine_state: &EngineState, - color: &&Value, + nu_config: &Config, + color: &Value, span: Span, span_id: SpanId, ) -> Option { @@ -409,9 +423,7 @@ fn get_argument_for_color_value( Type::String, ), Expression::new_existing( - Expr::String( - v.clone().to_expanded_string("", engine_state.get_config()), - ), + Expr::String(v.clone().to_expanded_string("", nu_config)), span, span_id, Type::String, @@ -453,6 +465,7 @@ pub fn document_shape(shape: SyntaxShape) -> SyntaxShape { pub fn get_flags_section( engine_state_opt: Option<&EngineState>, + nu_config_opt: Option<&Config>, signature: &Signature, mut value_formatter: F, // format default Value (because some calls cant access config or nu-highlight) ) -> String @@ -467,13 +480,26 @@ where // Sometimes we want to get the flags without engine_state // For example, in nu-plugin. In that case, we fall back on default values if let Some(engine_state) = engine_state_opt { - help_section_name = - get_ansi_color_for_component_or_default(engine_state, "shape_string", "\x1b[32m"); // default: green - help_subcolor_one = - get_ansi_color_for_component_or_default(engine_state, "shape_external", "\x1b[36m"); // default: cyan - // was const bb: &str = "\x1b[1;34m"; // bold blue - help_subcolor_two = - get_ansi_color_for_component_or_default(engine_state, "shape_block", "\x1b[94m"); + let nu_config = nu_config_opt.unwrap_or_else(|| engine_state.get_config()); + help_section_name = get_ansi_color_for_component_or_default( + engine_state, + nu_config, + "shape_string", + "\x1b[32m", + ); // default: green + help_subcolor_one = get_ansi_color_for_component_or_default( + engine_state, + nu_config, + "shape_external", + "\x1b[36m", + ); // default: cyan + // was const bb: &str = "\x1b[1;34m"; // bold blue + help_subcolor_two = get_ansi_color_for_component_or_default( + engine_state, + nu_config, + "shape_block", + "\x1b[94m", + ); // default: light blue (nobold, should be bolding the *names*) } else { help_section_name = "\x1b[32m".to_string(); diff --git a/crates/nu-engine/src/env.rs b/crates/nu-engine/src/env.rs index 048d9bfb99..31008f5f1d 100644 --- a/crates/nu-engine/src/env.rs +++ b/crates/nu-engine/src/env.rs @@ -3,7 +3,7 @@ use nu_path::canonicalize_with; use nu_protocol::{ ast::{Call, Expr}, engine::{EngineState, Stack, StateWorkingSet}, - Config, ShellError, Span, Value, VarId, + ShellError, Span, Value, VarId, }; use std::{ collections::HashMap, @@ -322,18 +322,6 @@ pub fn find_in_dirs_env( Ok(check_dir(lib_dirs).or_else(|| check_dir(lib_dirs_fallback))) } -/// Get config -/// -/// This combines config stored in permanent state and any runtime updates to the environment. This -/// is the canonical way to fetch config at runtime when you have Stack available. -pub fn get_config(engine_state: &EngineState, stack: &Stack) -> Config { - if let Some(mut config_record) = stack.get_env_var(engine_state, "config") { - config_record.parse_as_config(engine_state.get_config()).0 - } else { - engine_state.get_config().clone() - } -} - fn get_converted_value( engine_state: &EngineState, stack: &Stack, diff --git a/crates/nu-engine/src/eval.rs b/crates/nu-engine/src/eval.rs index b495589011..24246f8c8a 100644 --- a/crates/nu-engine/src/eval.rs +++ b/crates/nu-engine/src/eval.rs @@ -1,5 +1,5 @@ #[allow(deprecated)] -use crate::{current_dir, get_config, get_full_help}; +use crate::{current_dir, get_full_help}; use nu_path::{expand_path_with, AbsolutePathBuf}; use nu_protocol::{ ast::{ @@ -13,7 +13,7 @@ use nu_protocol::{ Spanned, Type, Value, VarId, ENV_VARIABLE_ID, }; use nu_utils::IgnoreCaseExt; -use std::{borrow::Cow, fs::OpenOptions, path::PathBuf}; +use std::{fs::OpenOptions, path::PathBuf, sync::Arc}; pub fn eval_call( engine_state: &EngineState, @@ -195,6 +195,9 @@ pub fn redirect_env(engine_state: &EngineState, caller_stack: &mut Stack, callee for (var, value) in callee_stack.get_stack_env_vars() { caller_stack.add_env_var(var, value); } + + // set config to callee config, to capture any updates to that + caller_stack.config = callee_stack.config.clone(); } fn eval_external( @@ -646,8 +649,8 @@ impl Eval for EvalRuntime { type MutState = Stack; - fn get_config<'a>(engine_state: Self::State<'a>, stack: &mut Stack) -> Cow<'a, Config> { - Cow::Owned(get_config(engine_state, stack)) + fn get_config(engine_state: Self::State<'_>, stack: &mut Stack) -> Arc { + stack.get_config(engine_state) } fn eval_filepath( @@ -837,7 +840,14 @@ impl Eval for EvalRuntime { }); } + let is_config = original_key == "config"; + stack.add_env_var(original_key, value); + + // Trigger the update to config, if we modified that. + if is_config { + stack.update_config(engine_state)?; + } } else { lhs.upsert_data_at_cell_path(&cell_path.tail, rhs)?; stack.add_var(*var_id, lhs); diff --git a/crates/nu-explore/src/commands/expand.rs b/crates/nu-explore/src/commands/expand.rs index b748ce2b89..38f92c0b50 100644 --- a/crates/nu-explore/src/commands/expand.rs +++ b/crates/nu-explore/src/commands/expand.rs @@ -64,8 +64,8 @@ fn convert_value_to_string( let has_no_head = cols.is_empty() || (cols.len() == 1 && cols[0].is_empty()); let has_single_value = vals.len() == 1 && vals[0].len() == 1; if !has_no_head && has_single_value { - let config = engine_state.get_config(); - Ok(vals[0][0].to_abbreviated_string(config)) + let config = stack.get_config(engine_state); + Ok(vals[0][0].to_abbreviated_string(&config)) } else { let config = engine_state.get_config(); let style_computer = StyleComputer::from_config(engine_state, stack); diff --git a/crates/nu-explore/src/explore.rs b/crates/nu-explore/src/explore.rs index 8d59591beb..28a3f04a30 100644 --- a/crates/nu-explore/src/explore.rs +++ b/crates/nu-explore/src/explore.rs @@ -63,10 +63,10 @@ impl Command for Explore { let tail: bool = call.has_flag(engine_state, stack, "tail")?; let peek_value: bool = call.has_flag(engine_state, stack, "peek")?; - let nu_config = engine_state.get_config(); + let nu_config = stack.get_config(engine_state); let style_computer = StyleComputer::from_config(engine_state, stack); - let mut explore_config = ExploreConfig::from_nu_config(nu_config); + let mut explore_config = ExploreConfig::from_nu_config(&nu_config); explore_config.table.show_header = show_head; explore_config.table.show_index = show_index; explore_config.table.separator_style = lookup_color(&style_computer, "separator"); @@ -74,7 +74,7 @@ impl Command for Explore { let lscolors = create_lscolors(engine_state, stack); let config = PagerConfig::new( - nu_config, + &nu_config, &explore_config, &style_computer, &lscolors, diff --git a/crates/nu-plugin-engine/Cargo.toml b/crates/nu-plugin-engine/Cargo.toml index f86c1ae703..a6dfa471b8 100644 --- a/crates/nu-plugin-engine/Cargo.toml +++ b/crates/nu-plugin-engine/Cargo.toml @@ -16,6 +16,7 @@ nu-protocol = { path = "../nu-protocol", version = "0.95.1" } nu-system = { path = "../nu-system", version = "0.95.1" } nu-plugin-protocol = { path = "../nu-plugin-protocol", version = "0.95.1" } nu-plugin-core = { path = "../nu-plugin-core", version = "0.95.1", default-features = false } +nu-utils = { path = "../nu-utils", version = "0.95.1" } serde = { workspace = true } log = { workspace = true } @@ -31,4 +32,4 @@ local-socket = ["nu-plugin-core/local-socket"] windows = { workspace = true, features = [ # For setting process creation flags "Win32_System_Threading", -] } \ No newline at end of file +] } diff --git a/crates/nu-plugin-engine/src/context.rs b/crates/nu-plugin-engine/src/context.rs index b026d21b23..0192fbcc3c 100644 --- a/crates/nu-plugin-engine/src/context.rs +++ b/crates/nu-plugin-engine/src/context.rs @@ -21,7 +21,7 @@ pub trait PluginExecutionContext: Send + Sync { /// The pipeline externals state, for tracking the foreground process group, if present fn pipeline_externals_state(&self) -> Option<&Arc<(AtomicU32, AtomicU32)>>; /// Get engine configuration - fn get_config(&self) -> Result; + fn get_config(&self) -> Result, ShellError>; /// Get plugin configuration fn get_plugin_config(&self) -> Result, ShellError>; /// Get an environment variable from `$env` @@ -86,8 +86,8 @@ impl<'a> PluginExecutionContext for PluginExecutionCommandContext<'a> { Some(&self.engine_state.pipeline_externals_state) } - fn get_config(&self) -> Result { - Ok(nu_engine::get_config(&self.engine_state, &self.stack)) + fn get_config(&self) -> Result, ShellError> { + Ok(self.stack.get_config(&self.engine_state)) } fn get_plugin_config(&self) -> Result, ShellError> { @@ -240,7 +240,7 @@ impl PluginExecutionContext for PluginExecutionBogusContext { None } - fn get_config(&self) -> Result { + fn get_config(&self) -> Result, ShellError> { Err(ShellError::NushellFailed { msg: "get_config not implemented on bogus".into(), }) diff --git a/crates/nu-plugin-engine/src/declaration.rs b/crates/nu-plugin-engine/src/declaration.rs index d48fa39b85..745ba9a998 100644 --- a/crates/nu-plugin-engine/src/declaration.rs +++ b/crates/nu-plugin-engine/src/declaration.rs @@ -76,7 +76,7 @@ impl Command for PluginDeclaration { EvaluatedCall::try_from_call(call, engine_state, stack, eval_expression)?; // Get the engine config - let engine_config = nu_engine::get_config(engine_state, stack); + let engine_config = stack.get_config(engine_state); // Get, or start, the plugin. let plugin = self diff --git a/crates/nu-plugin-engine/src/interface/mod.rs b/crates/nu-plugin-engine/src/interface/mod.rs index 79ab7f7720..d1b722dedf 100644 --- a/crates/nu-plugin-engine/src/interface/mod.rs +++ b/crates/nu-plugin-engine/src/interface/mod.rs @@ -14,6 +14,7 @@ use nu_protocol::{ ast::Operator, CustomValue, IntoSpanned, PipelineData, PluginMetadata, PluginSignature, ShellError, Signals, Span, Spanned, Value, }; +use nu_utils::SharedCow; use std::{ collections::{btree_map, BTreeMap}, sync::{mpsc, Arc, OnceLock}, @@ -1260,7 +1261,7 @@ pub(crate) fn handle_engine_call( match call { EngineCall::GetConfig => { - let config = Box::new(context.get_config()?); + let config = SharedCow::from(context.get_config()?); Ok(EngineCallResponse::Config(config)) } EngineCall::GetPluginConfig => { diff --git a/crates/nu-plugin-protocol/src/lib.rs b/crates/nu-plugin-protocol/src/lib.rs index 2f582c3009..739366d910 100644 --- a/crates/nu-plugin-protocol/src/lib.rs +++ b/crates/nu-plugin-protocol/src/lib.rs @@ -25,6 +25,7 @@ use nu_protocol::{ ast::Operator, engine::Closure, ByteStreamType, Config, LabeledError, PipelineData, PluginMetadata, PluginSignature, ShellError, Span, Spanned, Value, }; +use nu_utils::SharedCow; use serde::{Deserialize, Serialize}; use std::collections::HashMap; @@ -553,7 +554,7 @@ impl EngineCall { pub enum EngineCallResponse { Error(ShellError), PipelineData(D), - Config(Box), + Config(SharedCow), ValueMap(HashMap), } diff --git a/crates/nu-plugin/Cargo.toml b/crates/nu-plugin/Cargo.toml index a3b4455d15..d46a3cc9cb 100644 --- a/crates/nu-plugin/Cargo.toml +++ b/crates/nu-plugin/Cargo.toml @@ -15,6 +15,7 @@ nu-engine = { path = "../nu-engine", version = "0.95.1" } nu-protocol = { path = "../nu-protocol", version = "0.95.1" } nu-plugin-protocol = { path = "../nu-plugin-protocol", version = "0.95.1" } nu-plugin-core = { path = "../nu-plugin-core", version = "0.95.1", default-features = false } +nu-utils = { path = "../nu-utils", version = "0.95.1" } log = { workspace = true } thiserror = "1.0" @@ -29,4 +30,4 @@ local-socket = ["nu-plugin-core/local-socket"] [target.'cfg(target_family = "unix")'.dependencies] # For setting the process group ID (EnterForeground / LeaveForeground) -nix = { workspace = true, default-features = false, features = ["process"] } \ No newline at end of file +nix = { workspace = true, default-features = false, features = ["process"] } diff --git a/crates/nu-plugin/src/plugin/interface/mod.rs b/crates/nu-plugin/src/plugin/interface/mod.rs index dcb4119dba..60c5964f26 100644 --- a/crates/nu-plugin/src/plugin/interface/mod.rs +++ b/crates/nu-plugin/src/plugin/interface/mod.rs @@ -14,6 +14,7 @@ use nu_protocol::{ engine::Closure, Config, LabeledError, PipelineData, PluginMetadata, PluginSignature, ShellError, Signals, Span, Spanned, Value, }; +use nu_utils::SharedCow; use std::{ collections::{btree_map, BTreeMap, HashMap}, sync::{mpsc, Arc}, @@ -525,9 +526,9 @@ impl EngineInterface { /// # Ok(()) /// # } /// ``` - pub fn get_config(&self) -> Result, ShellError> { + pub fn get_config(&self) -> Result, ShellError> { match self.engine_call(EngineCall::GetConfig)? { - EngineCallResponse::Config(config) => Ok(config), + EngineCallResponse::Config(config) => Ok(SharedCow::into_arc(config)), EngineCallResponse::Error(err) => Err(err), _ => Err(ShellError::PluginFailedToDecode { msg: "Received unexpected response for EngineCall::GetConfig".into(), diff --git a/crates/nu-plugin/src/plugin/mod.rs b/crates/nu-plugin/src/plugin/mod.rs index 2bf7f9fc07..d809318d68 100644 --- a/crates/nu-plugin/src/plugin/mod.rs +++ b/crates/nu-plugin/src/plugin/mod.rs @@ -670,7 +670,7 @@ fn print_help(plugin: &impl Plugin, encoder: impl PluginEncoder) { } }) .and_then(|_| { - let flags = get_flags_section(None, &signature, |v| format!("{:#?}", v)); + let flags = get_flags_section(None, None, &signature, |v| format!("{:#?}", v)); write!(help, "{flags}") }) .and_then(|_| writeln!(help, "\nParameters:")) diff --git a/crates/nu-protocol/src/engine/engine_state.rs b/crates/nu-protocol/src/engine/engine_state.rs index d45fbafb88..75c63576ed 100644 --- a/crates/nu-protocol/src/engine/engine_state.rs +++ b/crates/nu-protocol/src/engine/engine_state.rs @@ -301,28 +301,11 @@ impl EngineState { stack: &mut Stack, cwd: impl AsRef, ) -> Result<(), ShellError> { - let mut config_updated = false; - for mut scope in stack.env_vars.drain(..) { for (overlay_name, mut env) in scope.drain() { if let Some(env_vars) = Arc::make_mut(&mut self.env_vars).get_mut(&overlay_name) { // Updating existing overlay - for (k, v) in env.drain() { - if k == "config" { - // Don't insert the record as the "config" env var as-is. - // Instead, mutate a clone of it with into_config(), and put THAT in env_vars. - let mut new_record = v.clone(); - let (config, error) = new_record.parse_as_config(&self.config); - self.config = Arc::new(config); - config_updated = true; - env_vars.insert(k, new_record); - if let Some(e) = error { - return Err(e); - } - } else { - env_vars.insert(k, v); - } - } + env_vars.extend(env.drain()); } else { // Pushing a new overlay Arc::make_mut(&mut self.env_vars).insert(overlay_name, env); @@ -333,7 +316,10 @@ impl EngineState { // TODO: better error std::env::set_current_dir(cwd)?; - if config_updated { + if let Some(config) = stack.config.take() { + // If config was updated in the stack, replace it. + self.config = config; + // Make plugin GC config changes take effect immediately. #[cfg(feature = "plugin")] self.update_plugin_gc_configs(&self.config.plugin_gc); @@ -738,18 +724,24 @@ impl EngineState { &[0u8; 0] } - pub fn get_config(&self) -> &Config { + /// Get the global config from the engine state. + /// + /// Use [`Stack::get_config()`] instead whenever the `Stack` is available, as it takes into + /// account local changes to `$env.config`. + pub fn get_config(&self) -> &Arc { &self.config } - pub fn set_config(&mut self, conf: Config) { + pub fn set_config(&mut self, conf: impl Into>) { + let conf = conf.into(); + #[cfg(feature = "plugin")] if conf.plugin_gc != self.config.plugin_gc { // Make plugin GC config changes take effect immediately. self.update_plugin_gc_configs(&conf.plugin_gc); } - self.config = Arc::new(conf); + self.config = conf; } /// Fetch the configuration for a plugin @@ -1137,7 +1129,7 @@ mod engine_state_tests { let mut plugins = HashMap::new(); plugins.insert("example".into(), Value::string("value", Span::test_data())); - let mut config = engine_state.get_config().clone(); + let mut config = Config::clone(engine_state.get_config()); config.plugins = plugins; engine_state.set_config(config); diff --git a/crates/nu-protocol/src/engine/stack.rs b/crates/nu-protocol/src/engine/stack.rs index 19726db9c0..e0013c0158 100644 --- a/crates/nu-protocol/src/engine/stack.rs +++ b/crates/nu-protocol/src/engine/stack.rs @@ -3,7 +3,7 @@ use crate::{ EngineState, Redirection, StackCallArgGuard, StackCaptureGuard, StackIoGuard, StackOutDest, DEFAULT_OVERLAY_NAME, }, - OutDest, ShellError, Span, Value, VarId, ENV_VARIABLE_ID, NU_VARIABLE_ID, + Config, OutDest, ShellError, Span, Value, VarId, ENV_VARIABLE_ID, NU_VARIABLE_ID, }; use std::{ collections::{HashMap, HashSet}, @@ -45,6 +45,8 @@ pub struct Stack { pub parent_stack: Option>, /// Variables that have been deleted (this is used to hide values from parent stack lookups) pub parent_deletions: Vec, + /// Locally updated config. Use [`.get_config()`] to access correctly. + pub config: Option>, pub(crate) out_dest: StackOutDest, } @@ -71,6 +73,7 @@ impl Stack { recursion_count: 0, parent_stack: None, parent_deletions: vec![], + config: None, out_dest: StackOutDest::new(), } } @@ -88,6 +91,7 @@ impl Stack { recursion_count: parent.recursion_count, vars: vec![], parent_deletions: vec![], + config: parent.config.clone(), out_dest: parent.out_dest.clone(), parent_stack: Some(parent), } @@ -114,6 +118,7 @@ impl Stack { unique_stack.env_vars = child.env_vars; unique_stack.env_hidden = child.env_hidden; unique_stack.active_overlays = child.active_overlays; + unique_stack.config = child.config; unique_stack } @@ -180,6 +185,36 @@ impl Stack { } } + /// Get the local config if set, otherwise the config from the engine state. + /// + /// This is the canonical way to get [`Config`] when [`Stack`] is available. + pub fn get_config(&self, engine_state: &EngineState) -> Arc { + self.config + .clone() + .unwrap_or_else(|| engine_state.config.clone()) + } + + /// Update the local config with the config stored in the `config` environment variable. Run + /// this after assigning to `$env.config`. + /// + /// The config will be updated with successfully parsed values even if an error occurs. + pub fn update_config(&mut self, engine_state: &EngineState) -> Result<(), ShellError> { + if let Some(mut config) = self.get_env_var(engine_state, "config") { + let existing_config = self.get_config(engine_state); + let (new_config, error) = config.parse_as_config(&existing_config); + self.config = Some(new_config.into()); + // The config value is modified by the update, so we should add it again + self.add_env_var("config".into(), config); + match error { + None => Ok(()), + Some(err) => Err(err), + } + } else { + self.config = None; + Ok(()) + } + } + pub fn add_var(&mut self, var_id: VarId, value: Value) { //self.vars.insert(var_id, value); for (id, val) in &mut self.vars { @@ -257,6 +292,7 @@ impl Stack { recursion_count: self.recursion_count, parent_stack: None, parent_deletions: vec![], + config: self.config.clone(), out_dest: self.out_dest.clone(), } } @@ -287,6 +323,7 @@ impl Stack { recursion_count: self.recursion_count, parent_stack: None, parent_deletions: vec![], + config: self.config.clone(), out_dest: self.out_dest.clone(), } } diff --git a/crates/nu-protocol/src/engine/state_working_set.rs b/crates/nu-protocol/src/engine/state_working_set.rs index af950b8321..e20c501e14 100644 --- a/crates/nu-protocol/src/engine/state_working_set.rs +++ b/crates/nu-protocol/src/engine/state_working_set.rs @@ -619,9 +619,9 @@ impl<'a> StateWorkingSet<'a> { /// Returns a reference to the config stored at permanent state /// - /// At runtime, you most likely want to call nu_engine::env::get_config because this method - /// does not capture environment updates during runtime. - pub fn get_config(&self) -> &Config { + /// At runtime, you most likely want to call [`Stack::get_config()`][super::Stack::get_config()] + /// because this method does not capture environment updates during runtime. + pub fn get_config(&self) -> &Arc { &self.permanent_state.config } diff --git a/crates/nu-protocol/src/eval_base.rs b/crates/nu-protocol/src/eval_base.rs index 7e1e2b0a7c..84316107a8 100644 --- a/crates/nu-protocol/src/eval_base.rs +++ b/crates/nu-protocol/src/eval_base.rs @@ -6,7 +6,7 @@ use crate::{ debugger::DebugContext, Config, GetSpan, Range, Record, ShellError, Span, Value, VarId, ENV_VARIABLE_ID, }; -use std::{borrow::Cow, collections::HashMap}; +use std::{collections::HashMap, sync::Arc}; /// To share implementations for regular eval and const eval pub trait Eval { @@ -315,7 +315,7 @@ pub trait Eval { } } - fn get_config<'a>(state: Self::State<'a>, mut_state: &mut Self::MutState) -> Cow<'a, Config>; + fn get_config(state: Self::State<'_>, mut_state: &mut Self::MutState) -> Arc; fn eval_filepath( state: Self::State<'_>, diff --git a/crates/nu-protocol/src/eval_const.rs b/crates/nu-protocol/src/eval_const.rs index 87913e4ee3..1b5346dc8e 100644 --- a/crates/nu-protocol/src/eval_const.rs +++ b/crates/nu-protocol/src/eval_const.rs @@ -7,8 +7,8 @@ use crate::{ }; use nu_system::os_info::{get_kernel_version, get_os_arch, get_os_family, get_os_name}; use std::{ - borrow::Cow, path::{Path, PathBuf}, + sync::Arc, }; /// Create a Value for `$nu`. @@ -360,8 +360,8 @@ impl Eval for EvalConst { type MutState = (); - fn get_config<'a>(state: Self::State<'a>, _: &mut ()) -> Cow<'a, Config> { - Cow::Borrowed(state.get_config()) + fn get_config(state: Self::State<'_>, _: &mut ()) -> Arc { + state.get_config().clone() } fn eval_filepath(