mirror of
https://github.com/nushell/nushell.git
synced 2025-02-18 03:21:05 +01: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 😄
54 lines
1.8 KiB
Rust
54 lines
1.8 KiB
Rust
use nu_plugin::EvaluatedCall;
|
|
use nu_protocol::{LabeledError, Value};
|
|
|
|
pub struct ExamplePlugin;
|
|
|
|
impl ExamplePlugin {
|
|
pub fn print_values(
|
|
&self,
|
|
index: u32,
|
|
call: &EvaluatedCall,
|
|
input: &Value,
|
|
) -> Result<(), LabeledError> {
|
|
// Note. When debugging your plugin, you may want to print something to the console
|
|
// Use the eprintln macro to print your messages. Trying to print to stdout will
|
|
// cause a decoding error for your message
|
|
eprintln!("Calling test {index} signature");
|
|
eprintln!("value received {input:?}");
|
|
|
|
// To extract the arguments from the Call object you can use the functions req, has_flag,
|
|
// opt, rest, and get_flag
|
|
//
|
|
// Note that plugin calls only accept simple arguments, this means that you can
|
|
// pass to the plug in Int and String. This should be improved when the plugin has
|
|
// the ability to call back to NuShell to extract more information
|
|
// Keep this in mind when designing your plugin signatures
|
|
let a: i64 = call.req(0)?;
|
|
let b: String = call.req(1)?;
|
|
let flag = call.has_flag("flag")?;
|
|
let opt: Option<i64> = call.opt(2)?;
|
|
let named: Option<String> = call.get_flag("named")?;
|
|
let rest: Vec<String> = call.rest(3)?;
|
|
|
|
eprintln!("Required values");
|
|
eprintln!("a: {a:}");
|
|
eprintln!("b: {b:}");
|
|
eprintln!("flag: {flag:}");
|
|
eprintln!("rest: {rest:?}");
|
|
|
|
if let Some(v) = opt {
|
|
eprintln!("Found optional value opt: {v:}")
|
|
} else {
|
|
eprintln!("No optional value found")
|
|
}
|
|
|
|
if let Some(v) = named {
|
|
eprintln!("Named value: {v:?}")
|
|
} else {
|
|
eprintln!("No named value found")
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
}
|