nushell/crates/nu-plugin-test-support
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
tests Change PluginCommand API to be more like Command (#12279) 2024-03-27 11:59:57 +01:00
Cargo.toml Fix #12280: replace difference crate with similar (#12282) 2024-03-25 21:13:12 -05:00
LICENSE Add test support crate for plugin developers (#12259) 2024-03-23 13:29:54 -05:00
README.md Add test support crate for plugin developers (#12259) 2024-03-23 13:29:54 -05:00

nu-plugin-test-support

This crate provides helpers for running tests on plugin commands, and is intended to be included in the dev-dependencies of plugin crates for testing.