extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2024-11-22 08:23:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve the "input and output are the same file" error text (#12619)

Browse Source 
# Description
Continuing from #12601, this PR improves the error message help text and
adds an example to `collect`.
This commit is contained in:
Ian Manske 2024-04-22 14:00:38 +00:00 committed by GitHub
parent 20bf3c587f
commit 797a90520c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
crates/nu-cmd-lang/src/core_commands/collect.rs
View File

@ -19,14 +19,14 @@ impl Command for Collect {
) )
.switch( .switch(
"keep-env", "keep-env",
"let the block affect environment variables", "let the closure affect environment variables",
None, None,
) )
.category(Category::Filters) .category(Category::Filters)
} }
fn usage(&self) -> &str { fn usage(&self) -> &str {
"Collect the stream and pass it to a block." "Collect a stream into a value and then run a closure with the collected value as input."
} }
fn run( fn run(
@ -36,11 +36,11 @@ impl Command for Collect {
call: &Call, call: &Call,
input: PipelineData, input: PipelineData,
) -> Result<PipelineData, ShellError> { ) -> Result<PipelineData, ShellError> {
let capture_block: Closure = call.req(engine_state, stack, 0)?; let closure: Closure = call.req(engine_state, stack, 0)?;
let block = engine_state.get_block(capture_block.block_id).clone(); let block = engine_state.get_block(closure.block_id).clone();
let mut stack_captures = let mut stack_captures =
stack.captures_to_stack_preserve_out_dest(capture_block.captures.clone()); stack.captures_to_stack_preserve_out_dest(closure.captures.clone());
let metadata = input.metadata(); let metadata = input.metadata();
let input: Value = input.into_value(call.head); let input: Value = input.into_value(call.head);
@ -67,7 +67,7 @@ impl Command for Collect {
redirect_env(engine_state, stack, &stack_captures); redirect_env(engine_state, stack, &stack_captures);
// for when we support `data | let x = $in;` // for when we support `data | let x = $in;`
// remove the variables added earlier // remove the variables added earlier
for (var_id, _) in capture_block.captures { for (var_id, _) in closure.captures {
stack_captures.remove_var(var_id); stack_captures.remove_var(var_id);
} }
if let Some(u) = saved_positional { if let Some(u) = saved_positional {
@ -80,11 +80,18 @@ impl Command for Collect {
} }
fn examples(&self) -> Vec<Example> { fn examples(&self) -> Vec<Example> {
vec![Example { vec![
description: "Use the second value in the stream", Example {
example: "[1 2 3] | collect { |x| $x.1 }", description: "Use the second value in the stream",
result: Some(Value::test_int(2)), example: "[1 2 3] | collect { |x| $x.1 }",
}] result: Some(Value::test_int(2)),
},
Example {
description: "Read and write to the same file",
example: "open file.txt | collect { save -f file.txt }",
result: None,
},
]
} }
} }

2
crates/nu-command/src/filesystem/save.rs
View File

@ -260,7 +260,7 @@ fn saving_to_source_file_error(dest: &Spanned<PathBuf>) -> ShellError {
dest.item.display() dest.item.display()
), ),
span: Some(dest.span), span: Some(dest.span),
help: Some("you should change the output path".into()), help: Some("You should use `collect` to run your save command (see `help collect`). Or, you can put the file data in a variable and then pass the variable to `save`.".into()),
inner: vec![], inner: vec![],
} }
} }