nushell/crates
Devyn Cairns f6faf73e02
Allow plugins to set environment variables in their caller's scope (#12204)
# Description

Adds the `AddEnvVar` plugin call, which allows plugins to set
environment variables in the caller's scope. This is the first engine
call that mutates the caller's stack, and opens the door to more
operations like this if needed.

This also comes with an extra benefit: in doing this, I needed to
refactor how context was handled, and I was able to avoid cloning
`EngineInterface` / `Stack` / `Call` in most cases that plugin calls are
used. They now only need to be cloned if the plugin call returns a
stream. The performance increase is welcome (5.5x faster on `inc`!):

```nushell
# Before
> timeit { 1..100 | each { |i| $"2.0.($i)" | inc -p } }
405ms 941µs 952ns
# After
> timeit { 1..100 | each { |i| $"2.0.($i)" | inc -p } }
73ms 68µs 749ns
```

# User-Facing Changes
- New engine call: `add_env_var()`
- Performance enhancement for plugin calls

# Tests + Formatting
- 🟢 `toolkit fmt`
- 🟢 `toolkit clippy`
- 🟢 `toolkit test`
- 🟢 `toolkit test stdlib`

# After Submitting
- [x] Document env manipulation in plugins guide
- [x] Document `AddEnvVar` in plugin protocol
2024-03-15 06:45:45 -05:00
..
nu_plugin_custom_values Reorganize plugin API around commands (#12170) 2024-03-14 16:40:02 -05:00
nu_plugin_example Allow plugins to set environment variables in their caller's scope (#12204) 2024-03-15 06:45:45 -05:00
nu_plugin_formats Reorganize plugin API around commands (#12170) 2024-03-14 16:40:02 -05:00
nu_plugin_gstat Reorganize plugin API around commands (#12170) 2024-03-14 16:40:02 -05:00
nu_plugin_inc Reorganize plugin API around commands (#12170) 2024-03-14 16:40:02 -05:00
nu_plugin_python Improve the error message for a plugin version mismatch (#12122) 2024-03-08 06:04:22 -06:00
nu_plugin_query Reorganize plugin API around commands (#12170) 2024-03-14 16:40:02 -05:00
nu_plugin_stream_example Reorganize plugin API around commands (#12170) 2024-03-14 16:40:02 -05:00
nu-cli IO and redirection overhaul (#11934) 2024-03-14 15:51:55 -05:00
nu-cmd-base IO and redirection overhaul (#11934) 2024-03-14 15:51:55 -05:00
nu-cmd-dataframe IO and redirection overhaul (#11934) 2024-03-14 15:51:55 -05:00
nu-cmd-extra IO and redirection overhaul (#11934) 2024-03-14 15:51:55 -05:00
nu-cmd-lang IO and redirection overhaul (#11934) 2024-03-14 15:51:55 -05:00
nu-color-config IO and redirection overhaul (#11934) 2024-03-14 15:51:55 -05:00
nu-command Adjust permissions using umask in mkdir (#12207) 2024-03-14 16:43:42 -05:00
nu-engine IO and redirection overhaul (#11934) 2024-03-14 15:51:55 -05:00
nu-explore IO and redirection overhaul (#11934) 2024-03-14 15:51:55 -05:00
nu-glob Fix ignored clippy lints (#12160) 2024-03-11 19:46:04 +01:00
nu-json remove repetitive word (#12117) 2024-03-08 15:29:20 +08:00
nu-lsp Introduce workspace dependencies (#12043) 2024-03-07 14:40:31 -08:00
nu-parser IO and redirection overhaul (#11934) 2024-03-14 15:51:55 -05:00
nu-path Use XDG_CONFIG_HOME before default config directory (#12118) 2024-03-11 06:15:46 -05:00
nu-plugin Allow plugins to set environment variables in their caller's scope (#12204) 2024-03-15 06:45:45 -05:00
nu-pretty-hex Introduce workspace dependencies (#12043) 2024-03-07 14:40:31 -08:00
nu-protocol Fix $in value for insert closure (#12209) 2024-03-14 16:43:03 -05:00
nu-std IO and redirection overhaul (#11934) 2024-03-14 15:51:55 -05:00
nu-system Bump windows from 0.52.0 to 0.54.0 (#12037) 2024-03-07 16:36:28 -08:00
nu-table Introduce workspace dependencies (#12043) 2024-03-07 14:40:31 -08:00
nu-term-grid Bump version to 0.91.1 (#12085) 2024-03-06 23:08:14 +01:00
nu-test-support Update tests Playground (#12134) 2024-03-08 20:31:21 -08:00
nu-utils Keep plugins persistently running in the background (#12064) 2024-03-09 17:10:22 -06:00
README.md Remove old nushell/merge engine-q 2022-02-07 14:54:06 -05:00

Nushell core libraries and plugins

These sub-crates form both the foundation for Nu and a set of plugins which extend Nu with additional functionality.

Foundational libraries are split into two kinds of crates:

  • Core crates - those crates that work together to build the Nushell language engine
  • Support crates - a set of crates that support the engine with additional features like JSON support, ANSI support, and more.

Plugins are likewise also split into two types:

  • Core plugins - plugins that provide part of the default experience of Nu, including access to the system properties, processes, and web-connectivity features.
  • Extra plugins - these plugins run a wide range of different capabilities like working with different file types, charting, viewing binary data, and more.