mirror of
https://github.com/nushell/nushell.git
synced 2025-04-29 15:44:28 +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)
85 lines
2.3 KiB
Rust
85 lines
2.3 KiB
Rust
use nu_engine::{eval_block, redirect_env, CallExt};
|
|
use nu_protocol::{
|
|
ast::Call,
|
|
engine::{Closure, Command, EngineState, Stack},
|
|
Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value,
|
|
};
|
|
|
|
#[derive(Clone)]
|
|
pub struct ExportEnv;
|
|
|
|
impl Command for ExportEnv {
|
|
fn name(&self) -> &str {
|
|
"export-env"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("export-env")
|
|
.input_output_types(vec![(Type::Nothing, Type::Nothing)])
|
|
.required(
|
|
"block",
|
|
SyntaxShape::Block,
|
|
"the block to run to set the environment",
|
|
)
|
|
.category(Category::Env)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Run a block and preserve its environment in a current scope."
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
caller_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let capture_block: Closure = call.req(engine_state, caller_stack, 0)?;
|
|
let block = engine_state.get_block(capture_block.block_id);
|
|
let mut callee_stack = caller_stack.captures_to_stack(&capture_block.captures);
|
|
|
|
let _ = eval_block(
|
|
engine_state,
|
|
&mut callee_stack,
|
|
block,
|
|
input,
|
|
call.redirect_stdout,
|
|
call.redirect_stderr,
|
|
);
|
|
|
|
redirect_env(engine_state, caller_stack, &callee_stack);
|
|
|
|
Ok(PipelineData::empty())
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Set an environment variable",
|
|
example: r#"export-env { $env.SPAM = 'eggs' }"#,
|
|
result: Some(Value::Nothing {
|
|
span: Span::test_data(),
|
|
}),
|
|
},
|
|
Example {
|
|
description: "Set an environment variable and examine its value",
|
|
example: r#"export-env { $env.SPAM = 'eggs' }; $env.SPAM"#,
|
|
result: Some(Value::test_string("eggs")),
|
|
},
|
|
]
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(ExportEnv {})
|
|
}
|
|
}
|