mirror of
https://github.com/nushell/nushell.git
synced 2025-05-17 16:30:47 +02:00
2873e943b3
* Add search terms to command * Rename Signature desc to usage To be named uniformly with extra_usage * Throw in foldl search term for reduce * Add missing usage to post * Add search terms to signature * Try to add capnp Signature serialization
60 lines
2.9 KiB
Rust
60 lines
2.9 KiB
Rust
use crate::Example;
|
|
use nu_plugin::{EvaluatedCall, LabeledError, Plugin};
|
|
use nu_protocol::{Category, Signature, SyntaxShape, Value};
|
|
|
|
impl Plugin for Example {
|
|
fn signature(&self) -> Vec<Signature> {
|
|
// It is possible to declare multiple signature in a plugin
|
|
// Each signature will be converted to a command declaration once the
|
|
// plugin is registered to nushell
|
|
vec![
|
|
Signature::build("nu-example-1")
|
|
.usage("Signature test 1 for plugin. Returns Value::Nothing")
|
|
.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),
|
|
Signature::build("nu-example-2")
|
|
.usage("Signature test 2 for plugin. Returns list of records")
|
|
.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),
|
|
Signature::build("nu-example-3")
|
|
.usage("Signature test 3 for plugin. Returns labeled error")
|
|
.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(
|
|
&mut self,
|
|
name: &str,
|
|
call: &EvaluatedCall,
|
|
input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
// You can use the name to identify what plugin signature was called
|
|
match name {
|
|
"nu-example-1" => self.test1(call, input),
|
|
"nu-example-2" => self.test2(call, input),
|
|
"nu-example-3" => self.test3(call, input),
|
|
_ => Err(LabeledError {
|
|
label: "Plugin call with wrong name signature".into(),
|
|
msg: "the signature used to call the plugin does not match any name in the plugin signature vector".into(),
|
|
span: Some(call.head),
|
|
}),
|
|
}
|
|
}
|
|
}
|