extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-08-16 16:41:41 +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

2
crates/nu-cmd-lang/src/core_commands/def_env.rs
View File

@ -48,7 +48,7 @@ impl Command for DefEnv {
fn examples(&self) -> Vec<Example> {
vec![Example {
description: "Set environment variable by call a custom command",
example: r#"def-env foo [] { let-env BAR = "BAZ" }; foo; $env.BAR"#,
example: r#"def-env foo [] { $env.BAR = "BAZ" }; foo; $env.BAR"#,
result: Some(Value::test_string("BAZ")),
}]
}

2
crates/nu-cmd-lang/src/core_commands/export_def_env.rs
View File

@ -73,7 +73,7 @@ export def-env cd_with_fallback [arg = ""] {
fn examples(&self) -> Vec<Example> {
vec![Example {
description: "Define a custom command that participates in the environment in a module and call it",
example: r#"module foo { export def-env bar [] { let-env FOO_BAR = "BAZ" } }; use foo bar; bar; $env.FOO_BAR"#,
example: r#"module foo { export def-env bar [] { $env.FOO_BAR = "BAZ" } }; use foo bar; bar; $env.FOO_BAR"#,
result: Some(Value::test_string("BAZ")),
}]
}

2
crates/nu-cmd-lang/src/core_commands/hide_env.rs
View File

@ -72,7 +72,7 @@ impl Command for HideEnv {
fn examples(&self) -> Vec<Example> {
vec![Example {
description: "Hide an environment variable",
example: r#"let-env HZ_ENV_ABC = 1; hide-env HZ_ENV_ABC; 'HZ_ENV_ABC' in (env).name"#,
example: r#"$env.HZ_ENV_ABC = 1; hide-env HZ_ENV_ABC; 'HZ_ENV_ABC' in (env).name"#,
result: Some(Value::test_bool(false)),
}]
}

4
crates/nu-cmd-lang/src/core_commands/module.rs
View File

@ -57,12 +57,12 @@ impl Command for Module {
},
Example {
description: "Define an environment variable in a module",
example: r#"module foo { export-env { let-env FOO = "BAZ" } }; use foo; $env.FOO"#,
example: r#"module foo { export-env { $env.FOO = "BAZ" } }; use foo; $env.FOO"#,
result: Some(Value::test_string("BAZ")),
},
Example {
description: "Define a custom command that participates in the environment in a module and call it",
example: r#"module foo { export def-env bar [] { let-env FOO_BAR = "BAZ" } }; use foo bar; bar; $env.FOO_BAR"#,
example: r#"module foo { export def-env bar [] { $env.FOO_BAR = "BAZ" } }; use foo bar; bar; $env.FOO_BAR"#,
result: Some(Value::test_string("BAZ")),
},
]

2
crates/nu-cmd-lang/src/core_commands/overlay/hide.rs
View File

@ -120,7 +120,7 @@ impl Command for OverlayHide {
},
Example {
description: "Hide the last activated overlay",
example: r#"module spam { export-env { let-env FOO = "foo" } }
example: r#"module spam { export-env { $env.FOO = "foo" } }
overlay use spam
overlay hide"#,
result: None,

2
crates/nu-cmd-lang/src/core_commands/overlay/use_.rs
View File

@ -188,7 +188,7 @@ impl Command for OverlayUse {
},
Example {
description: "Create an overlay from a file",
example: r#"'export-env { let-env FOO = "foo" }' | save spam.nu
example: r#"'export-env { $env.FOO = "foo" }' | save spam.nu
overlay use spam.nu
$env.FOO"#,
result: None,

4
crates/nu-color-config/src/style_computer.rs
View File

@ -238,7 +238,7 @@ fn test_computable_style_closure_basic() {
use nu_test_support::{nu, nu_repl_code, playground::Playground};
Playground::setup("computable_style_closure_basic", |dirs, _| {
let inp = [
r#"let-env config = {
r#"$env.config = {
color_config: {
string: {|e| touch ($e + '.obj'); 'red' }
}
@ -256,7 +256,7 @@ fn test_computable_style_closure_basic() {
fn test_computable_style_closure_errors() {
use nu_test_support::{nu, nu_repl_code};
let inp = [
r#"let-env config = {
r#"$env.config = {
color_config: {
string: {|e| $e + 2 }
}

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

86
crates/nu-engine/src/eval.rs
View File

@ -489,51 +489,63 @@ pub fn eval_expression(
Err(ShellError::AssignmentRequiresMutableVar { lhs_span: lhs.span })
}
}
Expr::FullCellPath(cell_path) => match &cell_path.head.expr {
Expr::Var(var_id) | Expr::VarDecl(var_id) => {
// The $env variable is considered "mutable" in Nushell.
// As such, give it special treatment here.
let is_env = var_id == &ENV_VARIABLE_ID;
if is_env || engine_state.get_var(*var_id).mutable {
let mut lhs =
eval_expression(engine_state, stack, &cell_path.head)?;
Expr::FullCellPath(cell_path) => {
match &cell_path.head.expr {
Expr::Var(var_id) | Expr::VarDecl(var_id) => {
// The $env variable is considered "mutable" in Nushell.
// As such, give it special treatment here.
let is_env = var_id == &ENV_VARIABLE_ID;
if is_env || engine_state.get_var(*var_id).mutable {
let mut lhs =
eval_expression(engine_state, stack, &cell_path.head)?;
lhs.upsert_data_at_cell_path(&cell_path.tail, rhs)?;
if is_env {
if cell_path.tail.is_empty() {
return Err(ShellError::CannotReplaceEnv {
span: cell_path.head.span,
});
}
lhs.upsert_data_at_cell_path(&cell_path.tail, rhs)?;
if is_env {
if cell_path.tail.is_empty() {
return Err(ShellError::CannotReplaceEnv {
span: cell_path.head.span,
});
}
// The special $env treatment: for something like $env.config.history.max_size = 2000,
// get $env.config (or whichever one it is) AFTER the above mutation, and set it
// as the "config" environment variable.
let vardata = lhs.follow_cell_path(
&[cell_path.tail[0].clone()],
false,
)?;
match &cell_path.tail[0] {
PathMember::String { val, .. } => {
stack.add_env_var(val.to_string(), vardata);
}
// In case someone really wants an integer env-var
PathMember::Int { val, .. } => {
stack.add_env_var(val.to_string(), vardata);
// The special $env treatment: for something like $env.config.history.max_size = 2000,
// get $env.config (or whichever one it is) AFTER the above mutation, and set it
// as the "config" environment variable.
let vardata = lhs.follow_cell_path(
&[cell_path.tail[0].clone()],
false,
)?;
match &cell_path.tail[0] {
PathMember::String { val, span, .. } => {
if val == "FILE_PWD"
|| val == "CURRENT_FILE"
|| val == "PWD"
{
return Err(ShellError::AutomaticEnvVarSetManually {
envvar_name: val.to_string(),
span: *span,
});
} else {
stack.add_env_var(val.to_string(), vardata);
}
}
// In case someone really wants an integer env-var
PathMember::Int { val, .. } => {
stack.add_env_var(val.to_string(), vardata);
}
}
} else {
stack.add_var(*var_id, lhs);
}
Ok(Value::nothing(cell_path.head.span))
} else {
stack.add_var(*var_id, lhs);
Err(ShellError::AssignmentRequiresMutableVar {
lhs_span: lhs.span,
})
}
Ok(Value::nothing(cell_path.head.span))
} else {
Err(ShellError::AssignmentRequiresMutableVar {
lhs_span: lhs.span,
})
}
_ => Err(ShellError::AssignmentRequiresVar { lhs_span: lhs.span }),
}
_ => Err(ShellError::AssignmentRequiresVar { lhs_span: lhs.span }),
},
}
_ => Err(ShellError::AssignmentRequiresVar { lhs_span: lhs.span }),
}
}

54
crates/nu-parser/src/parser.rs
View File

@ -5343,46 +5343,38 @@ pub fn parse_block(
if idx == 0 {
if let Some(let_decl_id) = working_set.find_decl(b"let", &Type::Nothing) {
if let Some(let_env_decl_id) =
working_set.find_decl(b"let-env", &Type::Nothing)
{
for element in pipeline.elements.iter_mut() {
if let PipelineElement::Expression(
_,
Expression {
expr: Expr::Call(call),
for element in pipeline.elements.iter_mut() {
if let PipelineElement::Expression(
_,
Expression {
expr: Expr::Call(call),
..
},
) = element
{
if call.decl_id == let_decl_id {
// Do an expansion
if let Some(Expression {
expr: Expr::Keyword(_, _, expr),
..
},
) = element
{
if call.decl_id == let_decl_id
|| call.decl_id == let_env_decl_id
}) = call.positional_iter_mut().nth(1)
{
// Do an expansion
if let Some(Expression {
expr: Expr::Keyword(_, _, expr),
..
}) = call.positional_iter_mut().nth(1)
{
if expr.has_in_variable(working_set) {
*expr = Box::new(wrap_expr_with_collect(
working_set,
expr,
));
}
if expr.has_in_variable(working_set) {
*expr = Box::new(wrap_expr_with_collect(
working_set,
expr,
));
}
continue;
} else if element.has_in_variable(working_set)
&& !is_subexpression
{
*element =
wrap_element_with_collect(working_set, element);
}
continue;
} else if element.has_in_variable(working_set)
&& !is_subexpression
{
*element = wrap_element_with_collect(working_set, element);
}
} else if element.has_in_variable(working_set) && !is_subexpression
{
*element = wrap_element_with_collect(working_set, element);
}
}
}

6
crates/nu-protocol/tests/into_config.rs
View File

@ -2,7 +2,7 @@ use nu_test_support::{nu, nu_repl_code};
#[test]
fn config_is_mutable() {
let actual = nu!(cwd: ".", nu_repl_code(&[r"let-env config = { ls: { clickable_links: true } }",
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"]));
@ -11,7 +11,7 @@ fn config_is_mutable() {
#[test]
fn config_preserved_after_do() {
let actual = nu!(cwd: ".", nu_repl_code(&[r"let-env config = { ls: { clickable_links: true } }",
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"]));
@ -20,7 +20,7 @@ fn config_preserved_after_do() {
#[test]
fn config_affected_when_mutated() {
let actual = nu!(cwd: ".", nu_repl_code(&[r#"let-env config = { filesize: { metric: false, format:"auto" } }"#,
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"]));

10
crates/nu-protocol/tests/test_config.rs
View File

@ -3,7 +3,7 @@ use nu_test_support::{nu, nu_repl_code};
#[test]
fn filesize_metric_true() {
let code = &[
r#"let-env config = { filesize: { metric: true, format:"mb" } }"#,
r#"$env.config = { filesize: { metric: true, format:"mb" } }"#,
r#"20mib | into string"#,
];
let actual = nu!(cwd: ".", nu_repl_code( code ));
@ -13,7 +13,7 @@ fn filesize_metric_true() {
#[test]
fn filesize_metric_false() {
let code = &[
r#"let-env config = { filesize: { metric: false, format:"mib" } }"#,
r#"$env.config = { filesize: { metric: false, format:"mib" } }"#,
r#"20mib | into string"#,
];
let actual = nu!(cwd: ".", nu_repl_code( code ));
@ -23,7 +23,7 @@ fn filesize_metric_false() {
#[test]
fn filesize_metric_overrides_format() {
let code = &[
r#"let-env config = { filesize: { metric: false, format:"mb" } }"#,
r#"$env.config = { filesize: { metric: false, format:"mb" } }"#,
r#"20mib | into string"#,
];
let actual = nu!(cwd: ".", nu_repl_code( code ));
@ -33,7 +33,7 @@ fn filesize_metric_overrides_format() {
#[test]
fn filesize_format_auto_metric_true() {
let code = &[
r#"let-env config = { filesize: { metric: true, format:"auto" } }"#,
r#"$env.config = { filesize: { metric: true, format:"auto" } }"#,
r#"[2mb 2gb 2tb] | into string | to nuon"#,
];
let actual = nu!(cwd: ".", nu_repl_code( code ));
@ -43,7 +43,7 @@ fn filesize_format_auto_metric_true() {
#[test]
fn filesize_format_auto_metric_false() {
let code = &[
r#"let-env config = { filesize: { metric: false, format:"auto" } }"#,
r#"$env.config = { filesize: { metric: false, format:"auto" } }"#,
r#"[2mb 2gb 2tb] | into string | to nuon"#,
];
let actual = nu!(cwd: ".", nu_repl_code( code ));

10
crates/nu-std/std/dirs.nu
View File

@ -17,8 +17,8 @@
# This situation could arise if we started with [/a, /b, /c], then
# we changed directories from /b to /var/tmp.
export-env {
let-env DIRS_POSITION = 0
let-env DIRS_LIST = [($env.PWD | path expand)]
$env.DIRS_POSITION = 0
$env.DIRS_LIST = [($env.PWD | path expand)]
}
# Add one or more directories to the list.
@ -36,7 +36,7 @@ export def-env add [
$abspaths = ($abspaths | append $exp)
}
let-env DIRS_LIST = ($env.DIRS_LIST | insert ($env.DIRS_POSITION + 1) $abspaths | flatten)
$env.DIRS_LIST = ($env.DIRS_LIST | insert ($env.DIRS_POSITION + 1) $abspaths | flatten)
_fetch 1
@ -66,7 +66,7 @@ export alias p = prev
# PWD becomes the next working directory
export def-env drop [] {
if ($env.DIRS_LIST | length) > 1 {
let-env DIRS_LIST = ($env.DIRS_LIST | reject $env.DIRS_POSITION)
$env.DIRS_LIST = ($env.DIRS_LIST | reject $env.DIRS_POSITION)
if ($env.DIRS_POSITION >= ($env.DIRS_LIST | length)) {$env.DIRS_POSITION = 0}
}
@ -111,7 +111,7 @@ export def-env goto [shell?: int] {
}
}
}
let-env DIRS_POSITION = $shell
$env.DIRS_POSITION = $shell
cd ($env.DIRS_LIST | get $env.DIRS_POSITION)
}

8
crates/nu-std/std/help.nu
View File

@ -164,7 +164,7 @@ def build-module-page [module: record] {
# > export def baz [] { "foo::baz" }
# >
# > export-env {
# > let-env FOO = "foo::FOO"
# > $env.FOO = "foo::FOO"
# > }
# > }
# >
@ -174,7 +174,7 @@ def build-module-page [module: record] {
# > export def baz [] { "bar::baz" }
# >
# > export-env {
# > let-env BAR = "bar::BAR"
# > $env.BAR = "bar::BAR"
# > }
# > }
# >
@ -184,7 +184,7 @@ def build-module-page [module: record] {
# > export def bar [] { "baz::bar" }
# >
# > export-env {
# > let-env BAZ = "baz::BAZ"
# > $env.BAZ = "baz::BAZ"
# > }
# > }
# > ```
@ -223,7 +223,7 @@ def build-module-page [module: record] {
#
# This module exports environment.
# {
# let-env FOO = "foo::FOO"
# $env.FOO = "foo::FOO"
# }
#
# search for a module that does not exist

10
crates/nu-std/std/log.nu
View File

@ -1,5 +1,5 @@
export-env {
let-env LOG_ANSI = {
$env.LOG_ANSI = {
"CRITICAL": (ansi red_bold),
"ERROR": (ansi red),
"WARNING": (ansi yellow),
@ -7,7 +7,7 @@ export-env {
"DEBUG": (ansi default_dimmed)
}
let-env LOG_LEVEL = {
$env.LOG_LEVEL = {
"CRITICAL": 50,
"ERROR": 40,
"WARNING": 30,
@ -15,7 +15,7 @@ export-env {
"DEBUG": 10
}
let-env LOG_PREFIX = {
$env.LOG_PREFIX = {
"CRITICAL": "CRT",
"ERROR": "ERR",
"WARNING": "WRN",
@ -23,7 +23,7 @@ export-env {
"DEBUG": "DBG"
}
let-env LOG_SHORT_PREFIX = {
$env.LOG_SHORT_PREFIX = {
"CRITICAL": "C",
"ERROR": "E",
"WARNING": "W",
@ -31,7 +31,7 @@ export-env {
"DEBUG": "D"
}
let-env LOG_FORMAT = $"%ANSI_START%%DATE%|%LEVEL%|(ansi u)%MSG%%ANSI_STOP%"
$env.LOG_FORMAT = $"%ANSI_START%%DATE%|%LEVEL%|(ansi u)%MSG%%ANSI_STOP%"
}
def log-types [] {

12
crates/nu-std/std/mod.nu
View File

@ -68,12 +68,12 @@ export def-env "path add" [
}}
}
let-env $path_name = (
$env
| get $path_name
| if $append { append $paths }
else { prepend $paths }
)
load-env {$path_name: (
$env
| get $path_name
| if $append { append $paths }
else { prepend $paths }
)}
if $ret {
$env | get $path_name

6
crates/nu-std/tests/test_std.nu
View File

@ -16,7 +16,7 @@ def test_path_add [] {
std path add "/bar/" "/baz/"
assert equal (get_path) ["/bar/", "/baz/", "/foo/"]
let-env $path_name = []
load-env {$path_name: []}
std path add "foo"
std path add "bar" "baz" --append
@ -25,13 +25,11 @@ def test_path_add [] {
assert equal (std path add "fooooo" --ret) ["fooooo", "foo", "bar", "baz"]
assert equal (get_path) ["fooooo", "foo", "bar", "baz"]
let-env $path_name = []
load-env {$path_name: []}
let target_paths = {linux: "foo", windows: "bar", macos: "baz"}
std path add $target_paths
assert equal (get_path) [($target_paths | get $nu.os-info.name)]
}
}

2
crates/nu-utils/src/sample_config/default_config.nu
View File

@ -183,7 +183,7 @@ let light_theme = {
# The default config record. This is where much of your global configuration is setup.
let-env config = {
$env.config = {
# true or false to enable or disable the welcome banner at startup
show_banner: true
ls: {

20
crates/nu-utils/src/sample_config/default_env.nu
View File

@ -44,21 +44,21 @@ def create_right_prompt [] {
}
# Use nushell functions to define your right and left prompt
let-env PROMPT_COMMAND = {|| create_left_prompt }
let-env PROMPT_COMMAND_RIGHT = {|| create_right_prompt }
$env.PROMPT_COMMAND = {|| create_left_prompt }
$env.PROMPT_COMMAND_RIGHT = {|| create_right_prompt }
# The prompt indicators are environmental variables that represent
# the state of the prompt
let-env PROMPT_INDICATOR = {|| "> " }
let-env PROMPT_INDICATOR_VI_INSERT = {|| ": " }
let-env PROMPT_INDICATOR_VI_NORMAL = {|| "> " }
let-env PROMPT_MULTILINE_INDICATOR = {|| "::: " }
$env.PROMPT_INDICATOR = {|| "> " }
$env.PROMPT_INDICATOR_VI_INSERT = {|| ": " }
$env.PROMPT_INDICATOR_VI_NORMAL = {|| "> " }
$env.PROMPT_MULTILINE_INDICATOR = {|| "::: " }
# Specifies how environment variables are:
# - converted from a string to a value on Nushell startup (from_string)
# - converted from a value back to a string when running external commands (to_string)
# Note: The conversions happen *after* config.nu is loaded
let-env ENV_CONVERSIONS = {
$env.ENV_CONVERSIONS = {
"PATH": {
from_string: { |s| $s | split row (char esep) | path expand --no-symlink }
to_string: { |v| $v | path expand --no-symlink | str join (char esep) }
@ -72,16 +72,16 @@ let-env ENV_CONVERSIONS = {
# Directories to search for scripts when calling source or use
#
# By default, <nushell-config-dir>/scripts is added
let-env NU_LIB_DIRS = [
$env.NU_LIB_DIRS = [
($nu.default-config-dir | path join 'scripts')
]
# Directories to search for plugin binaries when calling register
#
# By default, <nushell-config-dir>/plugins is added
let-env NU_PLUGIN_DIRS = [
$env.NU_PLUGIN_DIRS = [
($nu.default-config-dir | path join 'plugins')
]
# To add entries to PATH (on Windows you might use Path), you can use the following pattern:
# let-env PATH = ($env.PATH | split row (char esep) | prepend '/some/path')
# $env.PATH = ($env.PATH | split row (char esep) | prepend '/some/path')

2
crates/nu-utils/src/sample_config/sample_login.nu
View File

@ -3,7 +3,7 @@
# - will be sourced after config.nu and env.nu in case of nushell started as login shell
# just as an example for overwriting of an environment variable of env.nu
let-env PROMPT_INDICATOR = {|| "(LS)> " }
$env.PROMPT_INDICATOR = {|| "(LS)> " }
# Similar to env-path and config-path there is a variable containing the path to login.nu
echo $nu.loginshell-path