mirror of
https://github.com/nushell/nushell.git
synced 2025-06-07 02:26:52 +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
77 lines
1.9 KiB
Rust
77 lines
1.9 KiB
Rust
use std::sync::Arc;
|
|
|
|
use nu_engine::command_prelude::*;
|
|
use reedline::{Highlighter, StyledText};
|
|
|
|
#[derive(Clone)]
|
|
pub struct NuHighlight;
|
|
|
|
impl Command for NuHighlight {
|
|
fn name(&self) -> &str {
|
|
"nu-highlight"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("nu-highlight")
|
|
.category(Category::Strings)
|
|
.input_output_types(vec![(Type::String, Type::String)])
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Syntax highlight the input string."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["syntax", "color", "convert"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
|
|
let signals = engine_state.signals();
|
|
|
|
let highlighter = crate::NuHighlighter {
|
|
engine_state: Arc::new(engine_state.clone()),
|
|
stack: Arc::new(stack.clone()),
|
|
};
|
|
|
|
input.map(
|
|
move |x| match x.coerce_into_string() {
|
|
Ok(line) => {
|
|
let highlights = highlighter.highlight(&line, line.len());
|
|
Value::string(highlights.render_simple(), head)
|
|
}
|
|
Err(err) => Value::error(err, head),
|
|
},
|
|
signals,
|
|
)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Describe the type of a string",
|
|
example: "'let x = 3' | nu-highlight",
|
|
result: None,
|
|
}]
|
|
}
|
|
}
|
|
|
|
/// A highlighter that does nothing
|
|
///
|
|
/// Used to remove highlighting from a reedline instance
|
|
/// (letting NuHighlighter structs be dropped)
|
|
#[derive(Default)]
|
|
pub struct NoOpHighlighter {}
|
|
|
|
impl Highlighter for NoOpHighlighter {
|
|
fn highlight(&self, _line: &str, _cursor: usize) -> reedline::StyledText {
|
|
StyledText::new()
|
|
}
|
|
}
|