mirror of
https://github.com/nushell/nushell.git
synced 2025-08-09 09:35:44 +02:00
Change PluginCommand API to be more like Command (#12279)
# 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 😄
This commit is contained in:
@ -3,8 +3,7 @@ use std::cmp::Ordering;
|
||||
use nu_plugin::{EngineInterface, EvaluatedCall, Plugin, SimplePluginCommand};
|
||||
use nu_plugin_test_support::PluginTest;
|
||||
use nu_protocol::{
|
||||
CustomValue, LabeledError, PipelineData, PluginExample, PluginSignature, ShellError, Span,
|
||||
Type, Value,
|
||||
CustomValue, Example, LabeledError, PipelineData, ShellError, Signature, Span, Type, Value,
|
||||
};
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
@ -58,14 +57,24 @@ impl Plugin for CustomU32Plugin {
|
||||
impl SimplePluginCommand for IntoU32 {
|
||||
type Plugin = CustomU32Plugin;
|
||||
|
||||
fn signature(&self) -> PluginSignature {
|
||||
PluginSignature::build("into u32")
|
||||
.input_output_type(Type::Int, Type::Custom("CustomU32".into()))
|
||||
.plugin_examples(vec![PluginExample {
|
||||
example: "340 | into u32".into(),
|
||||
description: "Make a u32".into(),
|
||||
result: Some(CustomU32(340).into_value(Span::test_data())),
|
||||
}])
|
||||
fn name(&self) -> &str {
|
||||
"into u32"
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
"Convert a number to a 32-bit unsigned integer"
|
||||
}
|
||||
|
||||
fn signature(&self) -> Signature {
|
||||
Signature::build(self.name()).input_output_type(Type::Int, Type::Custom("CustomU32".into()))
|
||||
}
|
||||
|
||||
fn examples(&self) -> Vec<Example> {
|
||||
vec![Example {
|
||||
example: "340 | into u32",
|
||||
description: "Make a u32",
|
||||
result: Some(CustomU32(340).into_value(Span::test_data())),
|
||||
}]
|
||||
}
|
||||
|
||||
fn run(
|
||||
@ -87,9 +96,16 @@ impl SimplePluginCommand for IntoU32 {
|
||||
impl SimplePluginCommand for IntoIntFromU32 {
|
||||
type Plugin = CustomU32Plugin;
|
||||
|
||||
fn signature(&self) -> PluginSignature {
|
||||
PluginSignature::build("into int from u32")
|
||||
.input_output_type(Type::Custom("CustomU32".into()), Type::Int)
|
||||
fn name(&self) -> &str {
|
||||
"into int from u32"
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
"Turn a u32 back into a number"
|
||||
}
|
||||
|
||||
fn signature(&self) -> Signature {
|
||||
Signature::build(self.name()).input_output_type(Type::Custom("CustomU32".into()), Type::Int)
|
||||
}
|
||||
|
||||
fn run(
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
use nu_plugin::*;
|
||||
use nu_plugin_test_support::PluginTest;
|
||||
use nu_protocol::{LabeledError, PluginExample, PluginSignature, ShellError, Type, Value};
|
||||
use nu_protocol::{Example, LabeledError, ShellError, Signature, Type, Value};
|
||||
|
||||
struct HelloPlugin;
|
||||
struct Hello;
|
||||
@ -16,14 +16,24 @@ impl Plugin for HelloPlugin {
|
||||
impl SimplePluginCommand for Hello {
|
||||
type Plugin = HelloPlugin;
|
||||
|
||||
fn signature(&self) -> PluginSignature {
|
||||
PluginSignature::build("hello")
|
||||
.input_output_type(Type::Nothing, Type::String)
|
||||
.plugin_examples(vec![PluginExample {
|
||||
example: "hello".into(),
|
||||
description: "Print a friendly greeting".into(),
|
||||
result: Some(Value::test_string("Hello, World!")),
|
||||
}])
|
||||
fn name(&self) -> &str {
|
||||
"hello"
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
"Print a friendly greeting"
|
||||
}
|
||||
|
||||
fn signature(&self) -> Signature {
|
||||
Signature::build(PluginCommand::name(self)).input_output_type(Type::Nothing, Type::String)
|
||||
}
|
||||
|
||||
fn examples(&self) -> Vec<Example> {
|
||||
vec![Example {
|
||||
example: "hello",
|
||||
description: "Print a friendly greeting",
|
||||
result: Some(Value::test_string("Hello, World!")),
|
||||
}]
|
||||
}
|
||||
|
||||
fn run(
|
||||
@ -44,9 +54,9 @@ fn test_specified_examples() -> Result<(), ShellError> {
|
||||
|
||||
#[test]
|
||||
fn test_an_error_causing_example() -> Result<(), ShellError> {
|
||||
let result = PluginTest::new("hello", HelloPlugin.into())?.test_examples(&[PluginExample {
|
||||
example: "hello --unknown-flag".into(),
|
||||
description: "Run hello with an unknown flag".into(),
|
||||
let result = PluginTest::new("hello", HelloPlugin.into())?.test_examples(&[Example {
|
||||
example: "hello --unknown-flag",
|
||||
description: "Run hello with an unknown flag",
|
||||
result: Some(Value::test_string("Hello, World!")),
|
||||
}]);
|
||||
assert!(result.is_err());
|
||||
@ -55,9 +65,9 @@ fn test_an_error_causing_example() -> Result<(), ShellError> {
|
||||
|
||||
#[test]
|
||||
fn test_an_example_with_the_wrong_result() -> Result<(), ShellError> {
|
||||
let result = PluginTest::new("hello", HelloPlugin.into())?.test_examples(&[PluginExample {
|
||||
example: "hello".into(),
|
||||
description: "Run hello but the example result is wrong".into(),
|
||||
let result = PluginTest::new("hello", HelloPlugin.into())?.test_examples(&[Example {
|
||||
example: "hello",
|
||||
description: "Run hello but the example result is wrong",
|
||||
result: Some(Value::test_string("Goodbye, World!")),
|
||||
}]);
|
||||
assert!(result.is_err());
|
||||
|
@ -1,8 +1,8 @@
|
||||
use nu_plugin::*;
|
||||
use nu_plugin_test_support::PluginTest;
|
||||
use nu_protocol::{
|
||||
IntoInterruptiblePipelineData, LabeledError, PipelineData, PluginExample, PluginSignature,
|
||||
ShellError, Span, Type, Value,
|
||||
Example, IntoInterruptiblePipelineData, LabeledError, PipelineData, ShellError, Signature,
|
||||
Span, Type, Value,
|
||||
};
|
||||
|
||||
struct LowercasePlugin;
|
||||
@ -11,21 +11,30 @@ struct Lowercase;
|
||||
impl PluginCommand for Lowercase {
|
||||
type Plugin = LowercasePlugin;
|
||||
|
||||
fn signature(&self) -> PluginSignature {
|
||||
PluginSignature::build("lowercase")
|
||||
.usage("Convert each string in a stream to lowercase")
|
||||
.input_output_type(
|
||||
Type::List(Type::String.into()),
|
||||
Type::List(Type::String.into()),
|
||||
)
|
||||
.plugin_examples(vec![PluginExample {
|
||||
example: r#"[Hello wORLD] | lowercase"#.into(),
|
||||
description: "Lowercase a list of strings".into(),
|
||||
result: Some(Value::test_list(vec![
|
||||
Value::test_string("hello"),
|
||||
Value::test_string("world"),
|
||||
])),
|
||||
}])
|
||||
fn name(&self) -> &str {
|
||||
"lowercase"
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
"Convert each string in a stream to lowercase"
|
||||
}
|
||||
|
||||
fn signature(&self) -> Signature {
|
||||
Signature::build(self.name()).input_output_type(
|
||||
Type::List(Type::String.into()),
|
||||
Type::List(Type::String.into()),
|
||||
)
|
||||
}
|
||||
|
||||
fn examples(&self) -> Vec<Example> {
|
||||
vec![Example {
|
||||
example: r#"[Hello wORLD] | lowercase"#,
|
||||
description: "Lowercase a list of strings",
|
||||
result: Some(Value::test_list(vec![
|
||||
Value::test_string("hello"),
|
||||
Value::test_string("world"),
|
||||
])),
|
||||
}]
|
||||
}
|
||||
|
||||
fn run(
|
||||
|
Reference in New Issue
Block a user