forked from extern/nushell
a5c604c283
# Description Working on uniformizing the ending messages regarding methods usage() and extra_usage(). This is related to the issue https://github.com/nushell/nushell/issues/5066 after discussing it with @jntrnr # User-Facing Changes None. # Tests + Formatting Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass # After Submitting If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date.
69 lines
2.0 KiB
Rust
69 lines
2.0 KiB
Rust
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{
|
|
Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value,
|
|
};
|
|
|
|
#[derive(Clone)]
|
|
pub struct OldAlias;
|
|
|
|
impl Command for OldAlias {
|
|
fn name(&self) -> &str {
|
|
"old-alias"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Alias a command (with optional flags) to a new name."
|
|
}
|
|
|
|
fn signature(&self) -> nu_protocol::Signature {
|
|
Signature::build("old-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_usage(&self) -> &str {
|
|
r#"This command is a parser keyword. For details, check:
|
|
https://www.nushell.sh/book/thinking_in_nu.html"#
|
|
}
|
|
|
|
fn is_parser_keyword(&self) -> bool {
|
|
true
|
|
}
|
|
|
|
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: "old-alias ll = ls -l",
|
|
result: Some(Value::nothing(Span::test_data())),
|
|
},
|
|
Example {
|
|
description: "Make an alias that makes a list of all custom commands",
|
|
example: "old-alias customs = ($nu.scope.commands | where is_custom | get command)",
|
|
result: Some(Value::nothing(Span::test_data())),
|
|
},
|
|
]
|
|
}
|
|
}
|