nushell/crates/nu_plugin_query
Devyn Cairns 01d30a416b
Change PluginCommand API to be more like Command (#12279)
# Description

This is something that was discussed in the core team meeting last
Wednesday. @ayax79 is building `nu-plugin-polars` with all of the
dataframe commands into a plugin, and there are a lot of them, so it
would help to make the API more similar. At the same time, I think the
`Command` API is just better anyway. I don't think the difference is
justified, and the types for core commands have the benefit of requiring
less `.into()` because they often don't own their data

- Broke `signature()` up into `name()`, `usage()`, `extra_usage()`,
`search_terms()`, `examples()`
- `signature()` returns `nu_protocol::Signature`
- `examples()` returns `Vec<nu_protocol::Example>`
- `PluginSignature` and `PluginExample` no longer need to be used by
plugin developers

# User-Facing Changes
Breaking API for plugins yet again 😄
2024-03-27 11:59:57 +01:00
..
src Change PluginCommand API to be more like Command (#12279) 2024-03-27 11:59:57 +01:00
Cargo.toml Support for getting help text from a plugin command (#12243) 2024-03-24 07:30:38 +08:00
README.md remove the --encoding option from register in the examples (#8038) 2023-02-11 13:13:40 +00:00

Query plugin for Nushell

Note: this requires Nushell 0.60 or later

To install:

> cargo install --path .

To register (from inside Nushell):

> register <path to installed plugin>