2
0
Fork 0
mirror of https://github.com/nushell/nushell synced 2025-02-13 12:43:48 +00:00
nushell/tests
Eric Hodel 7071617f18
Allow plugins to receive configuration from the nushell configuration ()
# 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 

# 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)
2024-01-15 16:59:47 +08:00
..
assets/nu_json Remove old nushell/merge engine-q 2022-02-07 14:54:06 -05:00
const_ fix: closure captures can also be constants () 2024-01-07 12:51:39 +02:00
eval Exit early when encountering parsing errors () 2023-09-05 14:36:37 +02:00
fixtures Fix "Char index out of bounds" Error () 2024-01-11 15:24:49 -06:00
hooks Auto-expand table based on terminal width () 2023-08-08 05:47:23 -05:00
modules disable directory submodule auto export () 2023-12-15 12:37:55 +01:00
overlays Fix overlay_use_main_not_exported hanging when an external spam command exists () 2023-12-08 06:08:38 -06:00
parsing Forbid reserved variable names for function arguments () 2023-11-29 18:29:07 +01:00
path change canonicalize test use a more deeply rooted folder () 2023-10-11 11:27:25 -05:00
plugins Allow plugins to receive configuration from the nushell configuration () 2024-01-15 16:59:47 +08:00
scope Add a few more fields to scope commands () 2023-08-18 20:47:38 +03:00
shell Refactor tests (using cococo instead of ^echo) () 2024-01-05 11:40:56 +08:00
main.rs prevent redefining fields in a record () 2023-04-02 06:09:33 +12:00