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
59 lines
1.5 KiB
Rust
59 lines
1.5 KiB
Rust
use nu_engine::command_prelude::*;
|
|
use nu_protocol::engine::CommandType;
|
|
|
|
#[derive(Clone)]
|
|
pub struct Alias;
|
|
|
|
impl Command for Alias {
|
|
fn name(&self) -> &str {
|
|
"alias"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Alias a command (with optional flags) to a new name."
|
|
}
|
|
|
|
fn signature(&self) -> nu_protocol::Signature {
|
|
Signature::build("alias")
|
|
.input_output_types(vec![(Type::Nothing, Type::Nothing)])
|
|
.required("name", SyntaxShape::String, "Name of the alias.")
|
|
.required(
|
|
"initial_value",
|
|
SyntaxShape::Keyword(b"=".to_vec(), Box::new(SyntaxShape::Expression)),
|
|
"Equals sign followed by value.",
|
|
)
|
|
.category(Category::Core)
|
|
}
|
|
|
|
fn extra_description(&self) -> &str {
|
|
r#"This command is a parser keyword. For details, check:
|
|
https://www.nushell.sh/book/thinking_in_nu.html"#
|
|
}
|
|
|
|
fn command_type(&self) -> CommandType {
|
|
CommandType::Keyword
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["abbr", "aka", "fn", "func", "function"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
_call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
Ok(PipelineData::empty())
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Alias ll to ls -l",
|
|
example: "alias ll = ls -l",
|
|
result: Some(Value::nothing(Span::test_data())),
|
|
}]
|
|
}
|
|
}
|