forked from extern/nushell
2ae4408ced
# Description Uses the new `nu-plugin-test-support` crate to test the examples of commands provided by plugins in the repo. Also fixed some of the examples to pass. # User-Facing Changes - Examples that are more guaranteed to work # Tests + Formatting - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib`
55 lines
1.9 KiB
Rust
55 lines
1.9 KiB
Rust
use nu_plugin::{EngineInterface, EvaluatedCall, PluginCommand};
|
|
use nu_protocol::{
|
|
Category, LabeledError, ListStream, PipelineData, PluginExample, PluginSignature, SyntaxShape,
|
|
Type, Value,
|
|
};
|
|
|
|
use crate::Example;
|
|
|
|
/// `example seq <first> <last>`
|
|
pub struct Seq;
|
|
|
|
impl PluginCommand for Seq {
|
|
type Plugin = Example;
|
|
|
|
fn signature(&self) -> PluginSignature {
|
|
PluginSignature::build("example seq")
|
|
.usage("Example stream generator for a list of values")
|
|
.search_terms(vec!["example".into()])
|
|
.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()))
|
|
.plugin_examples(vec![PluginExample {
|
|
example: "example seq 1 3".into(),
|
|
description: "generate a sequence from 1 to 3".into(),
|
|
result: Some(Value::test_list(vec![
|
|
Value::test_int(1),
|
|
Value::test_int(2),
|
|
Value::test_int(3),
|
|
])),
|
|
}])
|
|
.category(Category::Experimental)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &Example,
|
|
_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", Example.into())?.test_command_examples(&Seq)
|
|
}
|