mirror of
https://github.com/nushell/nushell.git
synced 2025-04-09 13:28:50 +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
67 lines
1.9 KiB
Rust
67 lines
1.9 KiB
Rust
use nu_engine::command_prelude::*;
|
|
|
|
#[derive(Clone)]
|
|
pub struct SubCommand;
|
|
|
|
impl Command for SubCommand {
|
|
fn name(&self) -> &str {
|
|
"commandline edit"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.input_output_types(vec![(Type::Nothing, Type::Nothing)])
|
|
.switch(
|
|
"append",
|
|
"appends the string to the end of the buffer",
|
|
Some('a'),
|
|
)
|
|
.switch(
|
|
"insert",
|
|
"inserts the string into the buffer at the cursor position",
|
|
Some('i'),
|
|
)
|
|
.switch(
|
|
"replace",
|
|
"replaces the current contents of the buffer (default)",
|
|
Some('r'),
|
|
)
|
|
.required(
|
|
"str",
|
|
SyntaxShape::String,
|
|
"the string to perform the operation with",
|
|
)
|
|
.category(Category::Core)
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Modify the current command line input buffer."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["repl", "interactive"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let str: String = call.req(engine_state, stack, 0)?;
|
|
let mut repl = engine_state.repl_state.lock().expect("repl state mutex");
|
|
if call.has_flag(engine_state, stack, "append")? {
|
|
repl.buffer.push_str(&str);
|
|
} else if call.has_flag(engine_state, stack, "insert")? {
|
|
let cursor_pos = repl.cursor_pos;
|
|
repl.buffer.insert_str(cursor_pos, &str);
|
|
repl.cursor_pos += str.len();
|
|
} else {
|
|
repl.buffer = str;
|
|
repl.cursor_pos = repl.buffer.len();
|
|
}
|
|
Ok(Value::nothing(call.head).into_pipeline_data())
|
|
}
|
|
}
|