mirror of
https://github.com/nushell/nushell.git
synced 2025-05-07 00:12:58 +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
53 lines
1.5 KiB
Rust
53 lines
1.5 KiB
Rust
use nu_engine::command_prelude::*;
|
|
use unicode_segmentation::UnicodeSegmentation;
|
|
|
|
#[derive(Clone)]
|
|
pub struct SubCommand;
|
|
|
|
impl Command for SubCommand {
|
|
fn name(&self) -> &str {
|
|
"commandline get-cursor"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.input_output_types(vec![(Type::Nothing, Type::Int)])
|
|
.allow_variants_without_examples(true)
|
|
.category(Category::Core)
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Get the current cursor position."
|
|
}
|
|
|
|
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 repl = engine_state.repl_state.lock().expect("repl state mutex");
|
|
let char_pos = repl
|
|
.buffer
|
|
.grapheme_indices(true)
|
|
.chain(std::iter::once((repl.buffer.len(), "")))
|
|
.position(|(i, _c)| i == repl.cursor_pos)
|
|
.expect("Cursor position isn't on a grapheme boundary");
|
|
match i64::try_from(char_pos) {
|
|
Ok(pos) => Ok(Value::int(pos, call.head).into_pipeline_data()),
|
|
Err(e) => Err(ShellError::GenericError {
|
|
error: "Failed to convert cursor position to int".to_string(),
|
|
msg: e.to_string(),
|
|
span: None,
|
|
help: None,
|
|
inner: vec![],
|
|
}),
|
|
}
|
|
}
|
|
}
|