extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2024-11-07 17:14:23 +01:00
Code Issues Packages Projects Releases Wiki Activity
bf5bd3ff10
nushell/scripts
History
JT 4af24363c2
remove let-env, focus on mutating $env (#9574) 
# 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)
2023-07-01 07:57:51 +12:00
..
build-all-maclin.sh REFACTOR: clean the root of the repo (#9231) 2023-05-20 07:57:51 -05:00
build-all-windows.cmd REFACTOR: clean the root of the repo (#9231) 2023-05-20 07:57:51 -05:00
build-all.nu add a new toolkit install command with --features support (#9288) 2023-05-26 11:22:34 +02:00
build.rs REFACTOR: clean the root of the repo (#9231) 2023-05-20 07:57:51 -05:00
coverage-local.nu remove let-env, focus on mutating $env (#9574) 2023-07-01 07:57:51 +12:00
coverage-local.sh REFACTOR: clean the root of the repo (#9231) 2023-05-20 07:57:51 -05:00
install-all.ps1 REFACTOR: clean the root of the repo (#9231) 2023-05-20 07:57:51 -05:00
install-all.sh REFACTOR: clean the root of the repo (#9231) 2023-05-20 07:57:51 -05:00
README.md REFACTOR: clean the root of the repo (#9231) 2023-05-20 07:57:51 -05:00
register-plugins.nu add a new toolkit install command with --features support (#9288) 2023-05-26 11:22:34 +02:00
uninstall-all.sh REFACTOR: clean the root of the repo (#9231) 2023-05-20 07:57:51 -05:00

README.md

run the scripts

Note


the following table must be read as follows:

  • an x means it works
  • a ? means no data available

.nu scripts must be run as nu .../foo.nu
.sh scripts must be run as ./.../foo.sh
.ps1 scripts must be run as powershell .../foo.ps1

let's say a script is called foo

  • an x in the ./scripts column means foo can be run from ./scripts
  • an x in the root column means foo can be run from the root of nushell
  • an x in the anywhere column means foo can be run from anywhere!
script ./scripts/ root anywhere
build-all-maclin.sh x x x
build-all-windows.cmd ? x ?
build-all.nu x x x
coverage-local.nu x x x
coverage-local.sh x x x
install-all.ps1 ? x ?
install-all.sh x x x
register-plugins.nu x x x
uninstall-all.sh x x x