forked from extern/nushell
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 😄
45 lines
1.4 KiB
Rust
45 lines
1.4 KiB
Rust
use nu_plugin::{EngineInterface, EvaluatedCall, SimplePluginCommand};
|
|
use nu_protocol::{Category, LabeledError, Signature, SyntaxShape, Value};
|
|
|
|
use crate::ExamplePlugin;
|
|
|
|
pub struct Three;
|
|
|
|
impl SimplePluginCommand for Three {
|
|
type Plugin = ExamplePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"example three"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Plugin test example 3. Returns labeled error"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
// The signature defines the usage of the command inside Nu, and also automatically
|
|
// generates its help page.
|
|
Signature::build(self.name())
|
|
.required("a", SyntaxShape::Int, "required integer value")
|
|
.required("b", SyntaxShape::String, "required string value")
|
|
.switch("flag", "a flag for the signature", Some('f'))
|
|
.optional("opt", SyntaxShape::Int, "Optional number")
|
|
.named("named", SyntaxShape::String, "named string", Some('n'))
|
|
.rest("rest", SyntaxShape::String, "rest value string")
|
|
.category(Category::Experimental)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
plugin: &ExamplePlugin,
|
|
_engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
plugin.print_values(3, call, input)?;
|
|
|
|
Err(LabeledError::new("ERROR from plugin")
|
|
.with_label("error message pointing to call head span", call.head))
|
|
}
|
|
}
|