mirror of
https://github.com/nushell/nushell
synced 2024-12-28 14:03:09 +00:00
4af24363c2
# Description For years, Nushell has used `let-env` to set a single environment variable. As our work on scoping continued, we refined what it meant for a variable to be in scope using `let` but never updated how `let-env` would work. Instead, `let-env` confusingly created mutations to the command's copy of `$env`. So, to help fix the mental model and point people to the right way of thinking about what changing the environment means, this PR removes `let-env` to encourage people to think of it as updating the command's environment variable via mutation. Before: ``` let-env FOO = "BAR" ``` Now: ``` $env.FOO = "BAR" ``` It's also a good reminder that the environment owned by the command is in the `$env` variable rather than global like it is in other shells. # User-Facing Changes BREAKING CHANGE BREAKING CHANGE This completely removes `let-env FOO = "BAR"` so that we can focus on `$env.FOO = "BAR"`. # 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 -A clippy::result_large_err` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass - `cargo run -- crates/nu-std/tests/run.nu` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> # After / Before Submitting integration scripts to update: - ✔️ [starship](https://github.com/starship/starship/blob/master/src/init/starship.nu) - ✔️ [virtualenv](https://github.com/pypa/virtualenv/blob/main/src/virtualenv/activation/nushell/activate.nu) - ✔️ [atuin](https://github.com/ellie/atuin/blob/main/atuin/src/shell/atuin.nu) (PR: https://github.com/ellie/atuin/pull/1080) - ❌ [zoxide](https://github.com/ajeetdsouza/zoxide/blob/main/templates/nushell.txt) (PR: https://github.com/ajeetdsouza/zoxide/pull/587) - ✔️ [oh-my-posh](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/src/shell/scripts/omp.nu) (pr: https://github.com/JanDeDobbeleer/oh-my-posh/pull/4011)
101 lines
3.3 KiB
Rust
101 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"$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"$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#"$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\"");
|
|
}
|