mirror of
https://github.com/nushell/nushell.git
synced 2025-01-27 08:38:44 +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 😄
57 lines
1.3 KiB
Rust
57 lines
1.3 KiB
Rust
use crate::{query_json::QueryJson, query_web::QueryWeb, query_xml::QueryXml};
|
|
use nu_plugin::{EvaluatedCall, Plugin, PluginCommand, SimplePluginCommand};
|
|
use nu_protocol::{Category, LabeledError, Signature, Value};
|
|
|
|
#[derive(Default)]
|
|
pub struct Query;
|
|
|
|
impl Query {
|
|
pub fn new() -> Self {
|
|
Default::default()
|
|
}
|
|
|
|
pub fn usage() -> &'static str {
|
|
"Usage: query"
|
|
}
|
|
}
|
|
|
|
impl Plugin for Query {
|
|
fn commands(&self) -> Vec<Box<dyn PluginCommand<Plugin = Self>>> {
|
|
vec![
|
|
Box::new(QueryCommand),
|
|
Box::new(QueryJson),
|
|
Box::new(QueryXml),
|
|
Box::new(QueryWeb),
|
|
]
|
|
}
|
|
}
|
|
|
|
// With no subcommand
|
|
pub struct QueryCommand;
|
|
|
|
impl SimplePluginCommand for QueryCommand {
|
|
type Plugin = Query;
|
|
|
|
fn name(&self) -> &str {
|
|
"query"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Show all the query commands"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(PluginCommand::name(self)).category(Category::Filters)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &Query,
|
|
engine: &nu_plugin::EngineInterface,
|
|
call: &EvaluatedCall,
|
|
_input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
Ok(Value::string(engine.get_help()?, call.head))
|
|
}
|
|
}
|