mirror of
https://github.com/nushell/nushell.git
synced 2025-08-19 03:17:05 +02:00
Allow plugins to receive configuration from the nushell configuration (#10955)
# Description When nushell calls a plugin it now sends a configuration `Value` from the nushell config under `$env.config.plugins.PLUGIN_SHORT_NAME`. This allows plugin authors to read configuration provided by plugin users. The `PLUGIN_SHORT_NAME` must match the registered filename after `nu_plugin_`. If you register `target/debug/nu_plugin_config` the `PLUGIN_NAME` will be `config` and the nushell config will loook like: $env.config = { # ... plugins: { config: [ some values ] } } Configuration may also use a closure which allows passing values from `$env` to a plugin: $env.config = { # ... plugins: { config: {|| $env.some_value } } } This is a breaking change for the plugin API as the `Plugin::run()` function now accepts a new configuration argument which is an `&Option<Value>`. If no configuration was supplied the value is `None`. Plugins compiled after this change should work with older nushell, and will behave as if the configuration was not set. Initially discussed in #10867 # User-Facing Changes * Plugins can read configuration data stored in `$env.config.plugins` * The plugin `CallInfo` now includes a `config` entry, existing plugins will require updates # Tests + Formatting - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` # After Submitting - [ ] Update [Creating a plugin (in Rust)](https://www.nushell.sh/contributor-book/plugins.html#creating-a-plugin-in-rust) [source](https://github.com/nushell/nushell.github.io/blob/main/contributor-book/plugins.md) - [ ] Add "Configuration" section to [Plugins documentation](https://www.nushell.sh/contributor-book/plugins.html)
This commit is contained in:
@@ -2,3 +2,33 @@
|
||||
|
||||
Crate with a simple example of the Plugin trait that needs to be implemented
|
||||
in order to create a binary that can be registered into nushell declaration list
|
||||
|
||||
## `example config`
|
||||
|
||||
This subcommand demonstrates sending configuration from the nushell `$env.config` to a plugin.
|
||||
|
||||
To register from after building `nushell` run:
|
||||
|
||||
```nushell
|
||||
register target/debug/nu_plugin_example
|
||||
```
|
||||
|
||||
The configuration for the plugin lives in `$env.config.plugins.example`:
|
||||
|
||||
```nushell
|
||||
$env.config = {
|
||||
plugins: {
|
||||
example: [
|
||||
some
|
||||
values
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
To list plugin values run:
|
||||
|
||||
```nushell
|
||||
nu-example-config
|
||||
```
|
||||
|
||||
|
Reference in New Issue
Block a user