extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2024-11-25 09:53:43 +01:00
Code Issues Packages Projects Releases Wiki Activity
7071617f18
nushell/crates/nu_plugin_formats
History
Eric Hodel 7071617f18
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)
2024-01-15 16:59:47 +08:00
..
src Allow plugins to receive configuration from the nushell configuration (#10955) 2024-01-15 16:59:47 +08:00
Cargo.toml Bump to dev version 0.89.1 (#11513) 2024-01-11 00:19:21 +13:00
README.md Move some from xxx commands to plugin (#7942) 2023-02-13 12:42:08 +00:00

README.md

nu_plugin_formats

A nushell plugin to convert data to nushell tables.

support commands:

  1. from eml - original ported from nushell core.
  2. from ics - original ported from nushell core.
  3. from ini - original ported from nushell core.
  4. from vcf - original ported from nushell core.

Prerequisite

nushell, It's a nushell plugin, so you need it.

Usage

  1. compile the binary: cargo build
  2. register plugin(assume it's compiled in ./target/debug/):
register ./target/debug/nu_plugin_formats