mirror of https://github.com/nushell/nushell synced 2024-12-29 06:23:11 +00:00

History

Ian Manske e879d4ecaf `ListStream` touchup (#12524 ) # Description Does some misc changes to `ListStream`: - Moves it into its own module/file separate from `RawStream`. - `ListStream`s now have an associated `Span`. - This required changes to `ListStreamInfo` in `nu-plugin`. Note sure if this is a breaking change for the plugin protocol. - Hides the internals of `ListStream` but also adds a few more methods. - This includes two functions to more easily alter a stream (these take a `ListStream` and return a `ListStream` instead of having to go through the whole `into_pipeline_data(..)` route). - `map`: takes a `FnMut(Value) -> Value` - `modify`: takes a function to modify the inner stream.		2024-05-05 16:00:59 +00:00
..
src	`ListStream` touchup (#12524 )	2024-05-05 16:00:59 +00:00
Cargo.toml	Bump version to `0.93.1` (#12710 )	2024-05-01 17:19:20 -05:00
README.md	Merge stream_example into example plugin and clean up names (#12234 )	2024-03-19 12:36:46 -05:00

README.md

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