mirror of
https://github.com/nushell/nushell.git
synced 2024-11-25 01:43:47 +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 😄
38 lines
1006 B
Rust
38 lines
1006 B
Rust
use crate::{update::Update, CustomValuePlugin};
|
|
use nu_plugin::{EngineInterface, EvaluatedCall, SimplePluginCommand};
|
|
use nu_protocol::{Category, LabeledError, Signature, SyntaxShape, Value};
|
|
|
|
pub struct UpdateArg;
|
|
|
|
impl SimplePluginCommand for UpdateArg {
|
|
type Plugin = CustomValuePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"custom-value update-arg"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Updates a custom value as an argument"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.required(
|
|
"custom_value",
|
|
SyntaxShape::Any,
|
|
"the custom value to update",
|
|
)
|
|
.category(Category::Experimental)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
plugin: &CustomValuePlugin,
|
|
engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
_input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
SimplePluginCommand::run(&Update, plugin, engine, call, &call.req(0)?)
|
|
}
|
|
}
|