mirror of
https://github.com/nushell/nushell
synced 2025-01-28 21:05:48 +00:00
95b78eee25
# Description
The meaning of the word usage is specific to describing how a command
function is *used* and not a synonym for general description. Usage can
be used to describe the SYNOPSIS or EXAMPLES sections of a man page
where the permitted argument combinations are shown or example *uses*
are given.
Let's not confuse people and call it what it is a description.
Our `help` command already creates its own *Usage* section based on the
available arguments and doesn't refer to the description with usage.
# User-Facing Changes
`help commands` and `scope commands` will now use `description` or
`extra_description`
`usage`-> `description`
`extra_usage` -> `extra_description`
Breaking change in the plugin protocol:
In the signature record communicated with the engine.
`usage`-> `description`
`extra_usage` -> `extra_description`
The same rename also takes place for the methods on
`SimplePluginCommand` and `PluginCommand`
# Tests + Formatting
- Updated plugin protocol specific changes
# After Submitting
- [ ] update plugin protocol doc
60 lines
1.4 KiB
Rust
60 lines
1.4 KiB
Rust
use crate::{
|
|
query_json::QueryJson, query_web::QueryWeb, query_webpage_info::QueryWebpageInfo,
|
|
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()
|
|
}
|
|
}
|
|
|
|
impl Plugin for Query {
|
|
fn version(&self) -> String {
|
|
env!("CARGO_PKG_VERSION").into()
|
|
}
|
|
|
|
fn commands(&self) -> Vec<Box<dyn PluginCommand<Plugin = Self>>> {
|
|
vec![
|
|
Box::new(QueryCommand),
|
|
Box::new(QueryJson),
|
|
Box::new(QueryXml),
|
|
Box::new(QueryWeb),
|
|
Box::new(QueryWebpageInfo),
|
|
]
|
|
}
|
|
}
|
|
|
|
// With no subcommand
|
|
pub struct QueryCommand;
|
|
|
|
impl SimplePluginCommand for QueryCommand {
|
|
type Plugin = Query;
|
|
|
|
fn name(&self) -> &str {
|
|
"query"
|
|
}
|
|
|
|
fn description(&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))
|
|
}
|
|
}
|