forked from extern/nushell
63 lines
1.8 KiB
Rust
63 lines
1.8 KiB
Rust
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{Category, Example, PipelineData, Signature, SyntaxShape, Value};
|
|
|
|
#[derive(Clone)]
|
|
pub struct Def;
|
|
|
|
impl Command for Def {
|
|
fn name(&self) -> &str {
|
|
"def"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Define a custom command"
|
|
}
|
|
|
|
fn signature(&self) -> nu_protocol::Signature {
|
|
Signature::build("def")
|
|
.required("def_name", SyntaxShape::String, "definition name")
|
|
.required("params", SyntaxShape::Signature, "parameters")
|
|
.required(
|
|
"block",
|
|
SyntaxShape::Block(Some(vec![])),
|
|
"body of the definition",
|
|
)
|
|
.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_nushell.html#parsing-and-evaluation-are-different-stages"#
|
|
}
|
|
|
|
fn is_parser_keyword(&self) -> bool {
|
|
true
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<nu_protocol::PipelineData, nu_protocol::ShellError> {
|
|
Ok(PipelineData::new(call.head))
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Define a command and run it",
|
|
example: r#"def say-hi [] { echo 'hi' }; say-hi"#,
|
|
result: Some(Value::test_string("hi")),
|
|
},
|
|
Example {
|
|
description: "Define a command and run it with parameter(s)",
|
|
example: r#"def say-sth [sth: string] { echo $sth }; say-sth hi"#,
|
|
result: Some(Value::test_string("hi")),
|
|
},
|
|
]
|
|
}
|
|
}
|