mirror of
https://github.com/nushell/nushell.git
synced 2024-10-17 07:42:53 +02: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)
99 lines
2.0 KiB
Rust
99 lines
2.0 KiB
Rust
use nu_test_support::nu;
|
|
|
|
#[test]
|
|
fn with_env_extends_environment() {
|
|
let actual = nu!(
|
|
cwd: "tests/fixtures/formats",
|
|
"with-env [FOO BARRRR] {echo $env} | get FOO"
|
|
);
|
|
|
|
assert_eq!(actual.out, "BARRRR");
|
|
}
|
|
|
|
#[test]
|
|
fn with_env_shorthand() {
|
|
let actual = nu!(
|
|
cwd: "tests/fixtures/formats",
|
|
"FOO=BARRRR echo $env | get FOO"
|
|
);
|
|
|
|
assert_eq!(actual.out, "BARRRR");
|
|
}
|
|
|
|
#[test]
|
|
fn shorthand_doesnt_reorder_arguments() {
|
|
let actual = nu!(
|
|
cwd: "tests/fixtures/formats",
|
|
"FOO=BARRRR nu --testbin cococo first second"
|
|
);
|
|
|
|
assert_eq!(actual.out, "first second");
|
|
}
|
|
|
|
#[test]
|
|
fn with_env_shorthand_trims_quotes() {
|
|
let actual = nu!(
|
|
cwd: "tests/fixtures/formats",
|
|
"FOO='BARRRR' echo $env | get FOO"
|
|
);
|
|
|
|
assert_eq!(actual.out, "BARRRR");
|
|
}
|
|
|
|
#[test]
|
|
fn with_env_and_shorthand_same_result() {
|
|
let actual_shorthand = nu!(
|
|
cwd: "tests/fixtures/formats",
|
|
"FOO='BARRRR' echo $env | get FOO"
|
|
);
|
|
|
|
let actual_normal = nu!(
|
|
cwd: "tests/fixtures/formats",
|
|
"with-env [FOO BARRRR] {echo $env} | get FOO"
|
|
);
|
|
|
|
assert_eq!(actual_shorthand.out, actual_normal.out);
|
|
}
|
|
|
|
#[test]
|
|
fn test_redirection2() {
|
|
let actual = nu!(
|
|
cwd: "tests/fixtures/formats",
|
|
"let x = (FOO=BAR nu --testbin cococo niceenvvar); $x | str trim | str length"
|
|
);
|
|
|
|
assert_eq!(actual.out, "10");
|
|
}
|
|
|
|
#[test]
|
|
fn with_env_hides_variables_in_parent_scope() {
|
|
let actual = nu!(
|
|
cwd: "tests/fixtures/formats",
|
|
r#"
|
|
$env.FOO = "1"
|
|
print $env.FOO
|
|
with-env [FOO null] {
|
|
echo $env.FOO
|
|
}
|
|
print $env.FOO
|
|
"#
|
|
);
|
|
|
|
assert_eq!(actual.out, "11");
|
|
}
|
|
|
|
#[test]
|
|
fn with_env_shorthand_can_not_hide_variables() {
|
|
let actual = nu!(
|
|
cwd: "tests/fixtures/formats",
|
|
r#"
|
|
$env.FOO = "1"
|
|
print $env.FOO
|
|
FOO=null print $env.FOO
|
|
print $env.FOO
|
|
"#
|
|
);
|
|
|
|
assert_eq!(actual.out, "1null1");
|
|
}
|