mirror of
https://github.com/nushell/nushell.git
synced 2024-11-22 16:33:37 +01:00
ce78817f41
# Description Closes #7059. Rather than generate a new Record each time $env.config is accessed (as described in that issue), instead `$env.config = ` now A) parses the input record, then B) un-parses it into a clean Record with only the valid values, and stores that as an env-var. The reasoning for this is that I believe `config_to_nu_record()` (the method that performs step B) will be useful in later PRs. (See below) As a result, this also "fixes" the following "bug": ``` 〉$env.config = 'butts' $env.config is not a record 〉$env.config butts ``` ~~Instead, `$env.config = 'butts'` now turns `$env.config` into the default (not the default config.nu, but `Config::default()`, which notably has empty keybindings, color_config, menus and hooks vecs).~~ This doesn't attempt to fix #7110. cc @Kangaxx-0 # Example of new behaviour OLD: ``` 〉$env.config = ($env.config | merge { foo: 1 }) $env.config.foo is an unknown config setting 〉$env.config.foo 1 ``` NEW: ``` 〉$env.config = ($env.config | merge { foo: 1 }) Error: × Config record contains invalid values or unknown settings Error: × Error while applying config changes ╭─[entry #1:1:1] 1 │ $env.config = ($env.config | merge { foo: 1 }) · ┬ · ╰── $env.config.foo is an unknown config setting ╰──── help: This value has been removed from your $env.config record. 〉$env.config.foo Error: nu:🐚:column_not_found (link) × Cannot find column ╭─[entry #1:1:1] 1 │ $env.config = ($env.config | merge { foo: 1 }) · ──┬── · ╰── value originates here ╰──── ╭─[entry #2:1:1] 1 │ $env.config.foo · ─┬─ · ╰── cannot find column 'foo' ╰──── ``` # Example of new errors OLD: ``` $env.config.cd.baz is an unknown config setting $env.config.foo is an unknown config setting $env.config.bar is an unknown config setting $env.config.table.qux is an unknown config setting $env.config.history.qux is an unknown config setting ``` NEW: ``` Error: × Config record contains invalid values or unknown settings Error: × Error while applying config changes ╭─[C:\Users\Leon\AppData\Roaming\nushell\config.nu:267:1] 267 │ abbreviations: true # allows `cd s/o/f` to expand to `cd some/other/folder` 268 │ baz: 3, · ┬ · ╰── $env.config.cd.baz is an unknown config setting 269 │ } ╰──── help: This value has been removed from your $env.config record. Error: × Error while applying config changes ╭─[C:\Users\Leon\AppData\Roaming\nushell\config.nu:269:1] 269 │ } 270 │ foo: 1, · ┬ · ╰── $env.config.foo is an unknown config setting 271 │ bar: 2, ╰──── help: This value has been removed from your $env.config record. Error: × Error while applying config changes ╭─[C:\Users\Leon\AppData\Roaming\nushell\config.nu:270:1] 270 │ foo: 1, 271 │ bar: 2, · ┬ · ╰── $env.config.bar is an unknown config setting ╰──── help: This value has been removed from your $env.config record. Error: × Error while applying config changes ╭─[C:\Users\Leon\AppData\Roaming\nushell\config.nu:279:1] 279 │ } 280 │ qux: 4, · ┬ · ╰── $env.config.table.qux is an unknown config setting 281 │ } ╰──── help: This value has been removed from your $env.config record. Error: × Error while applying config changes ╭─[C:\Users\Leon\AppData\Roaming\nushell\config.nu:285:1] 285 │ file_format: "plaintext" # "sqlite" or "plaintext" 286 │ qux: 2 · ┬ · ╰── $env.config.history.qux is an unknown config setting 287 │ } ╰──── help: This value has been removed from your $env.config record. ``` # User-Facing Changes See above. # 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.
102 lines
3.3 KiB
Rust
102 lines
3.3 KiB
Rust
use nu_test_support::{nu, nu_repl_code};
|
|
|
|
#[test]
|
|
fn config_is_mutable() {
|
|
let actual = nu!(cwd: ".", nu_repl_code(&[r"let-env config = { ls: { clickable_links: true } }",
|
|
"$env.config.ls.clickable_links = false;",
|
|
"$env.config.ls.clickable_links"]));
|
|
|
|
assert_eq!(actual.out, "false");
|
|
}
|
|
|
|
#[test]
|
|
fn config_preserved_after_do() {
|
|
let actual = nu!(cwd: ".", nu_repl_code(&[r"let-env config = { ls: { clickable_links: true } }",
|
|
"do -i { $env.config.ls.clickable_links = false }",
|
|
"$env.config.ls.clickable_links"]));
|
|
|
|
assert_eq!(actual.out, "true");
|
|
}
|
|
|
|
#[test]
|
|
fn config_affected_when_mutated() {
|
|
let actual = nu!(cwd: ".", nu_repl_code(&[r#"let-env config = { filesize: { metric: false, format:"auto" } }"#,
|
|
r#"$env.config = { filesize: { metric: true, format:"auto" } }"#,
|
|
"20mib | into string"]));
|
|
|
|
assert_eq!(actual.out, "21.0 MB");
|
|
}
|
|
|
|
#[test]
|
|
fn config_affected_when_deep_mutated() {
|
|
let actual = nu!(cwd: "crates/nu-utils/src/sample_config", nu_repl_code(&[
|
|
r#"source default_config.nu"#,
|
|
r#"$env.config.filesize.metric = true"#,
|
|
r#"20mib | into string"#]));
|
|
|
|
assert_eq!(actual.out, "21.0 MB");
|
|
}
|
|
|
|
#[test]
|
|
fn config_add_unsupported_key() {
|
|
let actual = nu!(cwd: "crates/nu-utils/src/sample_config", nu_repl_code(&[
|
|
r#"source default_config.nu"#,
|
|
r#"$env.config.foo = 2"#,
|
|
r#";"#]));
|
|
|
|
assert!(actual
|
|
.err
|
|
.contains("$env.config.foo is an unknown config setting"));
|
|
}
|
|
|
|
#[test]
|
|
fn config_add_unsupported_type() {
|
|
let actual = nu!(cwd: "crates/nu-utils/src/sample_config", nu_repl_code(&[r#"source default_config.nu"#,
|
|
r#"$env.config.ls = '' "#,
|
|
r#";"#]));
|
|
|
|
assert!(actual.err.contains("should be a record"));
|
|
}
|
|
|
|
#[test]
|
|
fn config_add_unsupported_value() {
|
|
let actual = nu!(cwd: "crates/nu-utils/src/sample_config", nu_repl_code(&[r#"source default_config.nu"#,
|
|
r#"$env.config.history.file_format = ''"#,
|
|
r#";"#]));
|
|
|
|
assert!(actual.err.contains(
|
|
"unrecognized $env.config.history.file_format ''; expected either 'sqlite' or 'plaintext'"
|
|
));
|
|
}
|
|
|
|
#[test]
|
|
#[ignore = "Figure out how to make test_bins::nu_repl() continue execution after shell errors"]
|
|
fn config_unsupported_key_reverted() {
|
|
let actual = nu!(cwd: "crates/nu-utils/src/sample_config", nu_repl_code(&[r#"source default_config.nu"#,
|
|
r#"$env.config.foo = 1"#,
|
|
r#"'foo' in $env.config"#]));
|
|
|
|
assert_eq!(actual.out, "false");
|
|
}
|
|
|
|
#[test]
|
|
#[ignore = "Figure out how to make test_bins::nu_repl() continue execution after shell errors"]
|
|
fn config_unsupported_type_reverted() {
|
|
let actual = nu!(cwd: "crates/nu-utils/src/sample_config", nu_repl_code(&[r#" source default_config.nu"#,
|
|
r#"$env.config.ls = ''"#,
|
|
r#"$env.config.ls | describe"#]));
|
|
|
|
assert_eq!(actual.out, "record");
|
|
}
|
|
|
|
#[test]
|
|
#[ignore = "Figure out how to make test_bins::nu_repl() continue execution after errors"]
|
|
fn config_unsupported_value_reverted() {
|
|
let actual = nu!(cwd: "crates/nu-utils/src/sample_config", nu_repl_code(&[r#" source default_config.nu"#,
|
|
r#"$env.config.history.file_format = 'plaintext'"#,
|
|
r#"$env.config.history.file_format = ''"#,
|
|
r#"$env.config.history.file_format | to json"#]));
|
|
|
|
assert_eq!(actual.out, "\"plaintext\"");
|
|
}
|