nushell/crates/nu-protocol/src/alias.rs
Ian Manske cc9f41e553
Use CommandType in more places (#12832)
# Description
Kind of a vague title, but this PR does two main things:
1. Rather than overriding functions like `Command::is_parser_keyword`,
this PR instead changes commands to override `Command::command_type`.
The `CommandType` returned by `Command::command_type` is then used to
automatically determine whether `Command::is_parser_keyword` and the
other `is_{type}` functions should return true. These changes allow us
to remove the `CommandType::Other` case and should also guarantee than
only one of the `is_{type}` functions on `Command` will return true.
2. Uses the new, reworked `Command::command_type` function in the `scope
commands` and `which` commands.


# User-Facing Changes
- Breaking change for `scope commands`: multiple columns (`is_builtin`,
`is_keyword`, `is_plugin`, etc.) have been merged into the `type`
column.
- Breaking change: the `which` command can now report `plugin` or
`keyword` instead of `built-in` in the `type` column. It may also now
report `external` instead of `custom` in the `type` column for known
`extern`s.
2024-05-18 23:37:31 +00:00

59 lines
1.3 KiB
Rust

use crate::{
ast::{Call, Expression},
engine::{Command, CommandType, EngineState, Stack},
PipelineData, ShellError, Signature,
};
#[derive(Clone)]
pub struct Alias {
pub name: String,
pub command: Option<Box<dyn Command>>, // None if external call
pub wrapped_call: Expression,
pub usage: String,
pub extra_usage: 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 usage(&self) -> &str {
&self.usage
}
fn extra_usage(&self) -> &str {
&self.extra_usage
}
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)
}
}