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 😄
67 lines
1.9 KiB
Rust
67 lines
1.9 KiB
Rust
use nu_plugin::{EngineInterface, EvaluatedCall, PluginCommand};
|
|
use nu_protocol::{
|
|
Category, Example, LabeledError, ListStream, PipelineData, Signature, SyntaxShape, Type, Value,
|
|
};
|
|
|
|
use crate::ExamplePlugin;
|
|
|
|
/// `example seq <first> <last>`
|
|
pub struct Seq;
|
|
|
|
impl PluginCommand for Seq {
|
|
type Plugin = ExamplePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"example seq"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Example stream generator for a list of values"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.required("first", SyntaxShape::Int, "first number to generate")
|
|
.required("last", SyntaxShape::Int, "last number to generate")
|
|
.input_output_type(Type::Nothing, Type::List(Type::Int.into()))
|
|
.category(Category::Experimental)
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["example"]
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
example: "example seq 1 3",
|
|
description: "generate a sequence from 1 to 3",
|
|
result: Some(Value::test_list(vec![
|
|
Value::test_int(1),
|
|
Value::test_int(2),
|
|
Value::test_int(3),
|
|
])),
|
|
}]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &ExamplePlugin,
|
|
_engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, LabeledError> {
|
|
let first: i64 = call.req(0)?;
|
|
let last: i64 = call.req(1)?;
|
|
let span = call.head;
|
|
let iter = (first..=last).map(move |number| Value::int(number, span));
|
|
let list_stream = ListStream::from_stream(iter, None);
|
|
Ok(PipelineData::ListStream(list_stream, None))
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_examples() -> Result<(), nu_protocol::ShellError> {
|
|
use nu_plugin_test_support::PluginTest;
|
|
PluginTest::new("example", ExamplePlugin.into())?.test_command_examples(&Seq)
|
|
}
|