extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-08-09 20:17:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

remove let-env, focus on mutating $env (#9574)

Browse Source 
# 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)
This commit is contained in:
JT
2023-07-01 07:57:51 +12:00
committed by GitHub
parent 11132f7353
commit 4af24363c2
51 changed files with 371 additions and 402 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
crates/nu-command/src/debug/view_source.rs
View File

@ -163,8 +163,8 @@ impl Command for ViewSource {
},
Example {
description: "View the source of a custom command, which participates in the caller environment",
example: r#"def-env foo [] { let-env BAR = 'BAZ' }; view source foo"#,
result: Some(Value::test_string("def foo [] { let-env BAR = 'BAZ' }")),
example: r#"def-env foo [] { $env.BAR = 'BAZ' }; view source foo"#,
result: Some(Value::test_string("def foo [] { $env.BAR = 'BAZ' }")),
},
Example {
description: "View the source of a custom command with flags and arguments",
@ -173,8 +173,8 @@ impl Command for ViewSource {
},
Example {
description: "View the source of a module",
example: r#"module mod-foo { export-env { let-env FOO_ENV = 'BAZ' } }; view source mod-foo"#,
result: Some(Value::test_string(" export-env { let-env FOO_ENV = 'BAZ' }")),
example: r#"module mod-foo { export-env { $env.FOO_ENV = 'BAZ' } }; view source mod-foo"#,
result: Some(Value::test_string(" export-env { $env.FOO_ENV = 'BAZ' }")),
},
Example {
description: "View the source of an alias",

2
crates/nu-command/src/default_context.rs
View File

@ -315,8 +315,8 @@ pub fn add_shell_command_context(mut engine_state: EngineState) -> EngineState {
// Env
bind_command! {
LetEnvDeprecated,
ExportEnv,
LetEnv,
LoadEnv,
SourceEnv,
WithEnv,

43
crates/nu-command/src/deprecated/let_env.rs Normal file
View File

@ -0,0 +1,43 @@
use nu_protocol::ast::Call;
use nu_protocol::engine::{Command, EngineState, Stack};
use nu_protocol::{Category, PipelineData, ShellError, Signature, SyntaxShape, Type};
#[derive(Clone)]
pub struct LetEnvDeprecated;
impl Command for LetEnvDeprecated {
fn name(&self) -> &str {
"let-env"
}
fn signature(&self) -> Signature {
Signature::build(self.name())
.input_output_types(vec![(Type::Nothing, Type::Nothing)])
.allow_variants_without_examples(true)
.required("var_name", SyntaxShape::String, "variable name")
.required(
"initial_value",
SyntaxShape::Keyword(b"=".to_vec(), Box::new(SyntaxShape::MathExpression)),
"equals sign followed by value",
)
.category(Category::Deprecated)
}
fn usage(&self) -> &str {
"`let-env FOO = ...` is deprecated, use `$env.FOO = ...` instead."
}
fn run(
&self,
_: &EngineState,
_: &mut Stack,
call: &Call,
_: PipelineData,
) -> Result<PipelineData, ShellError> {
Err(nu_protocol::ShellError::DeprecatedCommand(
self.name().to_string(),
"$nu.<environment variable> = ...".to_owned(),
call.head,
))
}
}

2
crates/nu-command/src/deprecated/mod.rs
View File

@ -1,6 +1,7 @@
mod collect;
mod deprecated_commands;
mod hash_base64;
mod let_env;
mod lpad;
mod math_eval;
mod rpad;
@ -12,6 +13,7 @@ mod str_int;
pub use collect::StrCollectDeprecated;
pub use deprecated_commands::*;
pub use hash_base64::HashBase64;
pub use let_env::LetEnvDeprecated;
pub use lpad::LPadDeprecated;
pub use math_eval::SubCommand as MathEvalDeprecated;
pub use rpad::RPadDeprecated;

4
crates/nu-command/src/env/export_env.rs vendored
View File

@ -57,14 +57,14 @@ impl Command for ExportEnv {
vec![
Example {
description: "Set an environment variable",
example: r#"export-env { let-env SPAM = 'eggs' }"#,
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 { let-env SPAM = 'eggs' }; $env.SPAM"#,
example: r#"export-env { $env.SPAM = 'eggs' }; $env.SPAM"#,
result: Some(Value::test_string("eggs")),
},
]

72
crates/nu-command/src/env/let_env.rs vendored
View File

@ -1,72 +0,0 @@
use nu_engine::{eval_expression_with_input, CallExt};
use nu_protocol::ast::Call;
use nu_protocol::engine::{Command, EngineState, Stack};
use nu_protocol::{
Category, Example, PipelineData, ShellError, Signature, Spanned, SyntaxShape, Type, Value,
};
#[derive(Clone)]
pub struct LetEnv;
impl Command for LetEnv {
fn name(&self) -> &str {
"let-env"
}
fn usage(&self) -> &str {
"Create an environment variable and give it a value."
}
fn signature(&self) -> nu_protocol::Signature {
Signature::build("let-env")
.input_output_types(vec![(Type::Nothing, Type::Nothing)])
.allow_variants_without_examples(true)
.required("var_name", SyntaxShape::String, "variable name")
.required(
"initial_value",
SyntaxShape::Keyword(b"=".to_vec(), Box::new(SyntaxShape::MathExpression)),
"equals sign followed by value",
)
.category(Category::Env)
}
fn run(
&self,
engine_state: &EngineState,
stack: &mut Stack,
call: &Call,
input: PipelineData,
) -> Result<PipelineData, ShellError> {
// TODO: find and require the crossplatform restrictions on environment names
let env_var: Spanned<String> = call.req(engine_state, stack, 0)?;
let keyword_expr = call
.positional_nth(1)
.expect("checked through parser")
.as_keyword()
.expect("internal error: missing keyword");
let rhs =
eval_expression_with_input(engine_state, stack, keyword_expr, input, false, true)?
.0
.into_value(call.head);
if env_var.item == "FILE_PWD" || env_var.item == "CURRENT_FILE" || env_var.item == "PWD" {
return Err(ShellError::AutomaticEnvVarSetManually {
envvar_name: env_var.item,
span: env_var.span,
});
} else {
stack.add_env_var(env_var.item, rhs);
}
Ok(PipelineData::empty())
}
fn examples(&self) -> Vec<Example> {
vec![Example {
description: "Create an environment variable and display it",
example: "let-env MY_ENV_VAR = 1; $env.MY_ENV_VAR",
result: Some(Value::test_int(1)),
}]
}
}

2
crates/nu-command/src/env/mod.rs vendored
View File

@ -1,6 +1,5 @@
mod config;
mod export_env;
mod let_env;
mod load_env;
mod source_env;
mod with_env;
@ -10,7 +9,6 @@ pub use config::ConfigMeta;
pub use config::ConfigNu;
pub use config::ConfigReset;
pub use export_env::ExportEnv;
pub use let_env::LetEnv;
pub use load_env::LoadEnv;
pub use source_env::SourceEnv;
pub use with_env::WithEnv;

7
crates/nu-command/src/example_test.rs
View File

@ -9,9 +9,9 @@ pub fn test_examples(cmd: impl Command + 'static) {
#[cfg(test)]
mod test_examples {
use super::super::{
Ansi, Date, Enumerate, Flatten, From, Get, Into, IntoString, LetEnv, Math, MathEuler,
MathPi, MathRound, ParEach, Path, PathParse, Random, Sort, SortBy, Split, SplitColumn,
SplitRow, Str, StrJoin, StrLength, StrReplace, Update, Url, Values, Wrap,
Ansi, Date, Enumerate, Flatten, From, Get, Into, IntoString, Math, MathEuler, MathPi,
MathRound, ParEach, Path, PathParse, Random, Sort, SortBy, Split, SplitColumn, SplitRow,
Str, StrJoin, StrLength, StrReplace, Update, Url, Values, Wrap,
};
use crate::{Each, To};
use nu_cmd_lang::example_support::{
@ -78,7 +78,6 @@ mod test_examples {
working_set.add_decl(Box::new(Into));
working_set.add_decl(Box::new(IntoString));
working_set.add_decl(Box::new(Let));
working_set.add_decl(Box::new(LetEnv));
working_set.add_decl(Box::new(Math));
working_set.add_decl(Box::new(MathEuler));
working_set.add_decl(Box::new(MathPi));

6
crates/nu-command/tests/commands/nu_check.rs
View File

@ -230,7 +230,7 @@ fn parse_module_success_2() {
r#"
# foo.nu
export-env { let-env MYNAME = "Arthur, King of the Britons" }
export-env { $env.MYNAME = "Arthur, King of the Britons" }
"#,
)]);
@ -749,7 +749,7 @@ fn parse_script_with_nested_scripts_success() {
.with_files(vec![FileWithContentToBeTrimmed(
"foo.nu",
r#"
let-env FOO = 'foo'
$env.FOO = 'foo'
"#,
)]);
@ -772,7 +772,7 @@ fn nu_check_respects_file_pwd() {
.with_files(vec![FileWithContentToBeTrimmed(
"lol/lol.nu",
r#"
let-env RETURN = (nu-check ../foo.nu)
$env.RETURN = (nu-check ../foo.nu)
"#,
)])
.with_files(vec![FileWithContentToBeTrimmed(

2
crates/nu-command/tests/commands/redirection.rs
View File

@ -143,7 +143,7 @@ fn same_target_redirection_with_too_much_stderr_not_hang_nushell() {
nu!(
cwd: dirs.test(), pipeline(
r#"
let-env LARGE = (open --raw a_large_file.txt);
$env.LARGE = (open --raw a_large_file.txt);
nu --testbin echo_env_stderr LARGE out+err> another_large_file.txt
"#
),

2
crates/nu-command/tests/commands/rm.rs
View File

@ -142,7 +142,7 @@ fn errors_if_attempting_to_delete_home() {
Playground::setup("rm_test_8", |dirs, _| {
let actual = nu!(
cwd: dirs.root(),
"let-env HOME = myhome ; rm -rf ~"
"$env.HOME = myhome ; rm -rf ~"
);
assert!(actual.err.contains("please use -I or -i"));

20
crates/nu-command/tests/commands/save.rs
View File

@ -91,8 +91,8 @@ fn save_stderr_and_stdout_to_afame_file() {
let actual = nu!(
cwd: dirs.root(),
r#"
let-env FOO = "bar";
let-env BAZ = "ZZZ";
$env.FOO = "bar";
$env.BAZ = "ZZZ";
do -c {nu -c 'nu --testbin echo_env FOO; nu --testbin echo_env_stderr BAZ'} | save -r save_test_5/new-file.txt --stderr save_test_5/new-file.txt
"#,
);
@ -113,8 +113,8 @@ fn save_stderr_and_stdout_to_diff_file() {
nu!(
cwd: dirs.root(),
r#"
let-env FOO = "bar";
let-env BAZ = "ZZZ";
$env.FOO = "bar";
$env.BAZ = "ZZZ";
do -c {nu -c 'nu --testbin echo_env FOO; nu --testbin echo_env_stderr BAZ'} | save -r save_test_6/log.txt --stderr save_test_6/err.txt
"#,
);
@ -206,8 +206,8 @@ fn save_append_works_on_stderr() {
nu!(
cwd: dirs.root(),
r#"
let-env FOO = " New";
let-env BAZ = " New Err";
$env.FOO = " New";
$env.BAZ = " New Err";
do -i {nu -c 'nu --testbin echo_env FOO; nu --testbin echo_env_stderr BAZ'} | save -a -r save_test_11/log.txt --stderr save_test_11/err.txt"#,
);
@ -227,8 +227,8 @@ fn save_not_overrides_err_by_default() {
let actual = nu!(
cwd: dirs.root(),
r#"
let-env FOO = " New";
let-env BAZ = " New Err";
$env.FOO = " New";
$env.BAZ = " New Err";
do -i {nu -c 'nu --testbin echo_env FOO; nu --testbin echo_env_stderr BAZ'} | save -r save_test_12/log.txt --stderr save_test_12/err.txt"#,
);
@ -250,8 +250,8 @@ fn save_override_works_stderr() {
nu!(
cwd: dirs.root(),
r#"
let-env FOO = "New";
let-env BAZ = "New Err";
$env.FOO = "New";
$env.BAZ = "New Err";
do -i {nu -c 'nu --testbin echo_env FOO; nu --testbin echo_env_stderr BAZ'} | save -f -r save_test_13/log.txt --stderr save_test_13/err.txt"#,
);

8
crates/nu-command/tests/commands/source_env.rs
View File

@ -31,7 +31,7 @@ fn sources_also_files_under_custom_lib_dirs_path() {
nu.within("lib/my_library").with_files(vec![FileWithContent(
"main.nu",
r#"
let-env hello = "hello nu"
$env.hello = "hello nu"
"#,
)]);
@ -163,7 +163,7 @@ fn source_env_eval_export_env() {
sandbox.with_files(vec![FileWithContentToBeTrimmed(
"spam.nu",
r#"
export-env { let-env FOO = 'foo' }
export-env { $env.FOO = 'foo' }
"#,
)]);
@ -186,7 +186,7 @@ fn source_env_eval_export_env_hide() {
)]);
let inp = &[
r#"let-env FOO = 'foo'"#,
r#"$env.FOO = 'foo'"#,
r#"source-env spam.nu"#,
r#"$env.FOO"#,
];
@ -299,7 +299,7 @@ fn source_env_const_file() {
sandbox.with_files(vec![FileWithContentToBeTrimmed(
"spam.nu",
r#"
let-env FOO = 'foo'
$env.FOO = 'foo'
"#,
)]);

18
crates/nu-command/tests/commands/table.rs
View File

@ -38,7 +38,7 @@ fn table_collapse_0() {
#[test]
fn table_collapse_basic() {
let actual = nu!(nu_repl_code(&[
"let-env config = { table: { mode: basic }};",
"$env.config = { table: { mode: basic }};",
"[[a b, c]; [1 2 3] [4 5 [1 2 3]]] | table --collapse"
]));
assert_eq!(
@ -60,7 +60,7 @@ fn table_collapse_basic() {
#[test]
fn table_collapse_heavy() {
let actual = nu!(nu_repl_code(&[
"let-env config = { table: { mode: heavy }};",
"$env.config = { table: { mode: heavy }};",
"[[a b, c]; [1 2 3] [4 5 [1 2 3]]] | table --collapse"
]));
assert_eq!(
@ -82,7 +82,7 @@ fn table_collapse_heavy() {
#[test]
fn table_collapse_compact() {
let actual = nu!(nu_repl_code(&[
"let-env config = { table: { mode: compact }};",
"$env.config = { table: { mode: compact }};",
"[[a b, c]; [1 2 3] [4 5 [1 2 3]]] | table --collapse"
]));
assert_eq!(
@ -104,7 +104,7 @@ fn table_collapse_compact() {
#[test]
fn table_collapse_compact_double() {
let actual = nu!(nu_repl_code(&[
"let-env config = { table: { mode: compact_double }};",
"$env.config = { table: { mode: compact_double }};",
"[[a b, c]; [1 2 3] [4 5 [1 2 3]]] | table --collapse"
]));
assert_eq!(
@ -126,7 +126,7 @@ fn table_collapse_compact_double() {
#[test]
fn table_collapse_compact_light() {
let actual = nu!(nu_repl_code(&[
"let-env config = { table: { mode: light }};",
"$env.config = { table: { mode: light }};",
"[[a b, c]; [1 2 3] [4 5 [1 2 3]]] | table --collapse"
]));
assert_eq!(
@ -148,7 +148,7 @@ fn table_collapse_compact_light() {
#[test]
fn table_collapse_none() {
let actual = nu!(nu_repl_code(&[
"let-env config = { table: { mode: none }};",
"$env.config = { table: { mode: none }};",
"[[a b, c]; [1 2 3] [4 5 [1 2 3]]] | table --collapse"
]));
assert_eq!(
@ -166,7 +166,7 @@ fn table_collapse_none() {
#[test]
fn table_collapse_compact_reinforced() {
let actual = nu!(nu_repl_code(&[
"let-env config = { table: { mode: reinforced }};",
"$env.config = { table: { mode: reinforced }};",
"[[a b, c]; [1 2 3] [4 5 [1 2 3]]] | table --collapse"
]));
assert_eq!(
@ -188,7 +188,7 @@ fn table_collapse_compact_reinforced() {
#[test]
fn table_collapse_compact_thin() {
let actual = nu!(nu_repl_code(&[
"let-env config = { table: { mode: thin }};",
"$env.config = { table: { mode: thin }};",
"[[a b, c]; [1 2 3] [4 5 [1 2 3]]] | table --collapse"
]));
assert_eq!(
@ -210,7 +210,7 @@ fn table_collapse_compact_thin() {
#[test]
fn table_collapse_hearts() {
let actual = nu!(nu_repl_code(&[
"let-env config = { table: { mode: with_love }};",
"$env.config = { table: { mode: with_love }};",
"[[a b, c]; [1 2 3] [4 5 [1 2 3]]] | table --collapse"
]));
assert_eq!(

8
crates/nu-command/tests/commands/use_.rs
View File

@ -71,7 +71,7 @@ fn use_eval_export_env() {
sandbox.with_files(vec![FileWithContentToBeTrimmed(
"spam.nu",
r#"
export-env { let-env FOO = 'foo' }
export-env { $env.FOO = 'foo' }
"#,
)]);
@ -93,7 +93,7 @@ fn use_eval_export_env_hide() {
"#,
)]);
let inp = &[r#"let-env FOO = 'foo'"#, r#"use spam.nu"#, r#"$env.FOO"#];
let inp = &[r#"$env.FOO = 'foo'"#, r#"use spam.nu"#, r#"$env.FOO"#];
let actual = nu!(cwd: dirs.test(), pipeline(&inp.join("; ")));
@ -173,7 +173,7 @@ fn use_export_env_combined() {
r#"
def foo [] { 'foo' }
alias bar = foo
export-env { let-env FOO = (bar) }
export-env { $env.FOO = (bar) }
"#,
)]);
@ -267,7 +267,7 @@ fn use_main_4() {
#[test]
fn use_main_def_env() {
let inp = &[
r#"module spam { export def-env main [] { let-env SPAM = "spam" } }"#,
r#"module spam { export def-env main [] { $env.SPAM = "spam" } }"#,
r#"use spam"#,
r#"spam"#,
r#"$env.SPAM"#,

4
crates/nu-command/tests/commands/with_env.rs
View File

@ -70,7 +70,7 @@ fn with_env_hides_variables_in_parent_scope() {
let actual = nu!(
cwd: "tests/fixtures/formats",
r#"
let-env FOO = "1"
$env.FOO = "1"
print $env.FOO
with-env [FOO null] {
echo $env.FOO
@ -87,7 +87,7 @@ fn with_env_shorthand_can_not_hide_variables() {
let actual = nu!(
cwd: "tests/fixtures/formats",
r#"
let-env FOO = "1"
$env.FOO = "1"
print $env.FOO
FOO=null print $env.FOO
print $env.FOO