mirror of
https://github.com/nushell/nushell
synced 2025-01-28 04:45:18 +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
64 lines
1.6 KiB
Rust
64 lines
1.6 KiB
Rust
use crate::{
|
|
ast::Expression,
|
|
engine::{Call, Command, CommandType, EngineState, Stack},
|
|
PipelineData, ShellError, Signature,
|
|
};
|
|
|
|
/// Command wrapper of an alias.
|
|
///
|
|
/// Our current aliases are implemented as wrapping commands
|
|
/// This has some limitations compared to text-substitution macro aliases but can reliably use more
|
|
/// of our machinery
|
|
#[derive(Clone)]
|
|
pub struct Alias {
|
|
pub name: String,
|
|
/// Wrapped inner [`Command`]. `None` if alias of external call
|
|
pub command: Option<Box<dyn Command>>,
|
|
pub wrapped_call: Expression,
|
|
pub description: String,
|
|
pub extra_description: String,
|
|
}
|
|
|
|
impl Command for Alias {
|
|
fn name(&self) -> &str {
|
|
&self.name
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
if let Some(cmd) = &self.command {
|
|
cmd.signature()
|
|
} else {
|
|
Signature::new(&self.name).allows_unknown_args()
|
|
}
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
&self.description
|
|
}
|
|
|
|
fn extra_description(&self) -> &str {
|
|
&self.extra_description
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
Err(ShellError::NushellFailedSpanned {
|
|
msg: "Can't run alias directly. Unwrap it first".to_string(),
|
|
label: "originates from here".to_string(),
|
|
span: call.head,
|
|
})
|
|
}
|
|
|
|
fn command_type(&self) -> CommandType {
|
|
CommandType::Alias
|
|
}
|
|
|
|
fn as_alias(&self) -> Option<&Alias> {
|
|
Some(self)
|
|
}
|
|
}
|