mirror of
https://github.com/nushell/nushell
synced 2024-12-28 05:53: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)
250 lines
5.9 KiB
Rust
250 lines
5.9 KiB
Rust
use nu_test_support::fs::Stub::FileWithContentToBeTrimmed;
|
|
use nu_test_support::playground::Playground;
|
|
use nu_test_support::{nu, pipeline};
|
|
use pretty_assertions::assert_eq;
|
|
|
|
#[test]
|
|
fn source_file_relative_to_file() {
|
|
let actual = nu!(cwd: "tests/parsing/samples", r#"
|
|
nu source_file_relative.nu
|
|
"#);
|
|
|
|
assert_eq!(actual.out, "5");
|
|
}
|
|
|
|
#[test]
|
|
fn source_const_file() {
|
|
let actual = nu!(cwd: "tests/parsing/samples",
|
|
r#"
|
|
const file = 'single_line.nu'
|
|
source $file
|
|
"#);
|
|
|
|
assert_eq!(actual.out, "5");
|
|
}
|
|
|
|
#[test]
|
|
fn run_nu_script_single_line() {
|
|
let actual = nu!(cwd: "tests/parsing/samples", r#"
|
|
nu single_line.nu
|
|
"#);
|
|
|
|
assert_eq!(actual.out, "5");
|
|
}
|
|
|
|
#[test]
|
|
fn run_nu_script_multiline_start_pipe() {
|
|
let actual = nu!(cwd: "tests/parsing/samples", r#"
|
|
nu multiline_start_pipe.nu
|
|
"#);
|
|
|
|
assert_eq!(actual.out, "4");
|
|
}
|
|
|
|
#[test]
|
|
fn run_nu_script_multiline_start_pipe_win() {
|
|
let actual = nu!(cwd: "tests/parsing/samples", r#"
|
|
nu multiline_start_pipe_win.nu
|
|
"#);
|
|
|
|
assert_eq!(actual.out, "3");
|
|
}
|
|
|
|
#[test]
|
|
fn run_nu_script_multiline_end_pipe() {
|
|
let actual = nu!(cwd: "tests/parsing/samples", r#"
|
|
nu multiline_end_pipe.nu
|
|
"#);
|
|
|
|
assert_eq!(actual.out, "2");
|
|
}
|
|
|
|
#[test]
|
|
fn run_nu_script_multiline_end_pipe_win() {
|
|
let actual = nu!(cwd: "tests/parsing/samples", r#"
|
|
nu multiline_end_pipe_win.nu
|
|
"#);
|
|
|
|
assert_eq!(actual.out, "3");
|
|
}
|
|
|
|
#[test]
|
|
fn parse_file_relative_to_parsed_file_simple() {
|
|
Playground::setup("relative_files_simple", |dirs, sandbox| {
|
|
sandbox
|
|
.mkdir("lol")
|
|
.mkdir("lol/lol")
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"lol/lol/lol.nu",
|
|
r#"
|
|
use ../lol_shell.nu
|
|
|
|
$env.LOL = (lol_shell ls)
|
|
"#,
|
|
)])
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"lol/lol_shell.nu",
|
|
r#"
|
|
export def ls [] { "lol" }
|
|
"#,
|
|
)]);
|
|
|
|
let actual = nu!(
|
|
cwd: dirs.test(), pipeline(
|
|
r#"
|
|
source-env lol/lol/lol.nu;
|
|
$env.LOL
|
|
"#
|
|
));
|
|
|
|
assert_eq!(actual.out, "lol");
|
|
})
|
|
}
|
|
|
|
#[ignore]
|
|
#[test]
|
|
fn parse_file_relative_to_parsed_file() {
|
|
Playground::setup("relative_files", |dirs, sandbox| {
|
|
sandbox
|
|
.mkdir("lol")
|
|
.mkdir("lol/lol")
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"lol/lol/lol.nu",
|
|
r#"
|
|
source-env ../../foo.nu
|
|
use ../lol_shell.nu
|
|
overlay use ../../lol/lol_shell.nu
|
|
|
|
$env.LOL = $'($env.FOO) (lol_shell ls) (ls)'
|
|
"#,
|
|
)])
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"lol/lol_shell.nu",
|
|
r#"
|
|
export def ls [] { "lol" }
|
|
"#,
|
|
)])
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"foo.nu",
|
|
r#"
|
|
$env.FOO = 'foo'
|
|
"#,
|
|
)]);
|
|
|
|
let actual = nu!(
|
|
cwd: dirs.test(), pipeline(
|
|
r#"
|
|
source-env lol/lol/lol.nu;
|
|
$env.LOL
|
|
"#
|
|
));
|
|
|
|
assert_eq!(actual.out, "foo lol lol");
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn parse_file_relative_to_parsed_file_dont_use_cwd_1() {
|
|
Playground::setup("relative_files", |dirs, sandbox| {
|
|
sandbox
|
|
.mkdir("lol")
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"lol/lol.nu",
|
|
r#"
|
|
source-env foo.nu
|
|
"#,
|
|
)])
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"lol/foo.nu",
|
|
r#"
|
|
$env.FOO = 'good'
|
|
"#,
|
|
)])
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"foo.nu",
|
|
r#"
|
|
$env.FOO = 'bad'
|
|
"#,
|
|
)]);
|
|
|
|
let actual = nu!(
|
|
cwd: dirs.test(), pipeline(
|
|
r#"
|
|
source-env lol/lol.nu;
|
|
$env.FOO
|
|
"#
|
|
));
|
|
|
|
assert_eq!(actual.out, "good");
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn parse_file_relative_to_parsed_file_dont_use_cwd_2() {
|
|
Playground::setup("relative_files", |dirs, sandbox| {
|
|
sandbox
|
|
.mkdir("lol")
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"lol/lol.nu",
|
|
r#"
|
|
source-env foo.nu
|
|
"#,
|
|
)])
|
|
.with_files(vec![FileWithContentToBeTrimmed(
|
|
"foo.nu",
|
|
r#"
|
|
$env.FOO = 'bad'
|
|
"#,
|
|
)]);
|
|
|
|
let actual = nu!(
|
|
cwd: dirs.test(), pipeline(
|
|
r#"
|
|
source-env lol/lol.nu
|
|
"#
|
|
));
|
|
|
|
assert!(actual.err.contains("File not found"));
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn parse_export_env_in_module() {
|
|
let actual = nu!(cwd: "tests/parsing/samples",
|
|
r#"
|
|
module spam { export-env { } }
|
|
"#);
|
|
|
|
assert!(actual.err.is_empty());
|
|
}
|
|
|
|
#[test]
|
|
fn parse_export_env_missing_block() {
|
|
let actual = nu!(cwd: "tests/parsing/samples",
|
|
r#"
|
|
module spam { export-env }
|
|
"#);
|
|
|
|
assert!(actual.err.contains("missing block"));
|
|
}
|
|
|
|
#[test]
|
|
fn call_command_with_non_ascii_argument() {
|
|
let actual = nu!(cwd: "tests/parsing/samples",
|
|
r#"
|
|
def nu-arg [--umlaut(-ö): int] {}
|
|
nu-arg -ö 42
|
|
"#);
|
|
|
|
assert_eq!(actual.err.len(), 0);
|
|
}
|
|
|
|
#[test]
|
|
fn parse_long_duration() {
|
|
let actual = nu!(cwd: "tests/parsing/samples",
|
|
r#"
|
|
"78.797877879789789sec" | into duration
|
|
"#);
|
|
|
|
assert_eq!(actual.out, "1min 18sec 797ms");
|
|
}
|