mirror of
https://github.com/nushell/nushell
synced 2025-01-08 03:09:00 +00:00
01d30a416b
# 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 😄
75 lines
2 KiB
Rust
75 lines
2 KiB
Rust
//! Extended from `nu-plugin` examples.
|
|
|
|
use nu_plugin::*;
|
|
use nu_plugin_test_support::PluginTest;
|
|
use nu_protocol::{Example, LabeledError, ShellError, Signature, Type, Value};
|
|
|
|
struct HelloPlugin;
|
|
struct Hello;
|
|
|
|
impl Plugin for HelloPlugin {
|
|
fn commands(&self) -> Vec<Box<dyn PluginCommand<Plugin = Self>>> {
|
|
vec![Box::new(Hello)]
|
|
}
|
|
}
|
|
|
|
impl SimplePluginCommand for Hello {
|
|
type Plugin = HelloPlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"hello"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Print a friendly greeting"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(PluginCommand::name(self)).input_output_type(Type::Nothing, Type::String)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
example: "hello",
|
|
description: "Print a friendly greeting",
|
|
result: Some(Value::test_string("Hello, World!")),
|
|
}]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &HelloPlugin,
|
|
_engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
_input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
Ok(Value::string("Hello, World!".to_owned(), call.head))
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_specified_examples() -> Result<(), ShellError> {
|
|
PluginTest::new("hello", HelloPlugin.into())?.test_command_examples(&Hello)
|
|
}
|
|
|
|
#[test]
|
|
fn test_an_error_causing_example() -> Result<(), ShellError> {
|
|
let result = PluginTest::new("hello", HelloPlugin.into())?.test_examples(&[Example {
|
|
example: "hello --unknown-flag",
|
|
description: "Run hello with an unknown flag",
|
|
result: Some(Value::test_string("Hello, World!")),
|
|
}]);
|
|
assert!(result.is_err());
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn test_an_example_with_the_wrong_result() -> Result<(), ShellError> {
|
|
let result = PluginTest::new("hello", HelloPlugin.into())?.test_examples(&[Example {
|
|
example: "hello",
|
|
description: "Run hello but the example result is wrong",
|
|
result: Some(Value::test_string("Goodbye, World!")),
|
|
}]);
|
|
assert!(result.is_err());
|
|
Ok(())
|
|
}
|