mirror of
https://github.com/nushell/nushell.git
synced 2025-07-12 12:26:05 +02: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
55 lines
1.5 KiB
Rust
55 lines
1.5 KiB
Rust
use nu_engine::command_prelude::*;
|
|
use reedline::get_reedline_default_keybindings;
|
|
|
|
#[derive(Clone)]
|
|
pub struct KeybindingsDefault;
|
|
|
|
impl Command for KeybindingsDefault {
|
|
fn name(&self) -> &str {
|
|
"keybindings default"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.category(Category::Platform)
|
|
.input_output_types(vec![(Type::Nothing, Type::table())])
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"List default keybindings."
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Get list with default keybindings",
|
|
example: "keybindings default",
|
|
result: None,
|
|
}]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let records = get_reedline_default_keybindings()
|
|
.into_iter()
|
|
.map(|(mode, modifier, code, event)| {
|
|
Value::record(
|
|
record! {
|
|
"mode" => Value::string(mode, call.head),
|
|
"modifier" => Value::string(modifier, call.head),
|
|
"code" => Value::string(code, call.head),
|
|
"event" => Value::string(event, call.head),
|
|
},
|
|
call.head,
|
|
)
|
|
})
|
|
.collect();
|
|
|
|
Ok(Value::list(records, call.head).into_pipeline_data())
|
|
}
|
|
}
|