nushell/crates/nu_plugin_example
Devyn Cairns 2ae4408ced
Add example tests (nu-plugin-test-support) for plugins in repo (#12281)
# Description

Uses the new `nu-plugin-test-support` crate to test the examples of
commands provided by plugins in the repo.

Also fixed some of the examples to pass.

# User-Facing Changes

- Examples that are more guaranteed to work

# Tests + Formatting
- 🟢 `toolkit fmt`
- 🟢 `toolkit clippy`
- 🟢 `toolkit test`
- 🟢 `toolkit test stdlib`
2024-03-25 21:20:35 -05:00
..
src Add example tests (nu-plugin-test-support) for plugins in repo (#12281) 2024-03-25 21:20:35 -05:00
Cargo.toml Add example tests (nu-plugin-test-support) for plugins in repo (#12281) 2024-03-25 21:20:35 -05:00
README.md Merge stream_example into example plugin and clean up names (#12234) 2024-03-19 12:36:46 -05:00

Plugin Example

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:

register target/debug/nu_plugin_example

The configuration for the plugin lives in $env.config.plugins.example:

$env.config = {
  plugins: {
    example: [
      some
      values
    ]
  }
}

To list plugin values run:

example config