mirror of
https://github.com/nushell/nushell.git
synced 2025-05-06 16:02:58 +00:00
c09488f515
# Description
I've noticed this several times but kept forgetting to fix it:
The example given for `help def` for the `--wrapped` flag is:
```nu
Define a custom wrapper for an external command
> def --wrapped my-echo [...rest] { echo $rest }; my-echo spam
╭───┬──────╮
│ 0 │ spam │
╰───┴──────╯
```
That's ... odd, since (a) it specifically says *"for an external"*
command, and yet uses (and shows the output from) the builtin `echo`.
Also, (b) I believe `--wrapped` is *only* applicable to external
commands. Finally, (c) the `my-echo spam` doesn't even demonstrate a
wrapped argument.
Unless I'm truly missing something, the example just makes no sense.
This updates the example to really demonstrate `def --wrapped` with the
*external* version of `^echo`. It uses the `-e` command to interpret the
escape-tab character in the string.
```nu
> def --wrapped my-echo [...rest] { ^echo ...$rest }; my-echo -e 'spam\tspam'
spam spam
```
# User-Facing Changes
Help example only.
# Tests + Formatting
- 🟢 `toolkit fmt`
- 🟢 `toolkit clippy`
- 🟢 `toolkit test`
- 🟢 `toolkit test stdlib`
# 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.
-->
76 lines
2.7 KiB
Rust
76 lines
2.7 KiB
Rust
use nu_engine::command_prelude::*;
|
|
use nu_protocol::engine::CommandType;
|
|
|
|
#[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")
|
|
.input_output_types(vec![(Type::Nothing, Type::Nothing)])
|
|
.required("def_name", SyntaxShape::String, "Command name.")
|
|
.required("params", SyntaxShape::Signature, "Parameters.")
|
|
.required("block", SyntaxShape::Closure(None), "Body of the definition.")
|
|
.switch("env", "keep the environment defined inside the command", None)
|
|
.switch("wrapped", "treat unknown flags and arguments as strings (requires ...rest-like parameter in signature)", None)
|
|
.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 command_type(&self) -> CommandType {
|
|
CommandType::Keyword
|
|
}
|
|
|
|
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: "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")),
|
|
},
|
|
Example {
|
|
description: "Set environment variable by call a custom command",
|
|
example: r#"def --env foo [] { $env.BAR = "BAZ" }; foo; $env.BAR"#,
|
|
result: Some(Value::test_string("BAZ")),
|
|
},
|
|
Example {
|
|
description: "cd affects the environment, so '--env' is required to change directory from within a command",
|
|
example: r#"def --env gohome [] { cd ~ }; gohome; $env.PWD == ('~' | path expand)"#,
|
|
result: Some(Value::test_string("true")),
|
|
},
|
|
Example {
|
|
description: "Define a custom wrapper for an external command",
|
|
example: r#"def --wrapped my-echo [...rest] { ^echo ...$rest }; my-echo -e 'spam\tspam'"#,
|
|
result: Some(Value::test_string("spam\tspam")),
|
|
},
|
|
]
|
|
}
|
|
}
|