forked from extern/nushell
786ba3bf91
# Description This PR tights input/output type-checking a bit more. There are a lot of commands that don't have correct input/output types, so part of the effort is updating them. This PR now contains updates to commands that had wrong input/output signatures. It doesn't add examples for these new signatures, but that can be follow-up work. # User-Facing Changes BREAKING CHANGE BREAKING CHANGE This work enforces many more checks on pipeline type correctness than previous nushell versions. This strictness may uncover incompatibilities in existing scripts or shortcomings in the type information for internal commands. # 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 -A clippy::result_large_err` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass - `cargo run -- -c "use std testing; testing run-tests --path crates/nu-std"` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> # 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. -->
106 lines
3.0 KiB
Rust
106 lines
3.0 KiB
Rust
use nu_engine::{eval_block, redirect_env, CallExt};
|
|
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Closure, Command, EngineState, Stack};
|
|
use nu_protocol::{
|
|
Category, Example, IntoPipelineData, PipelineData, ShellError, Signature, SyntaxShape, Type,
|
|
Value,
|
|
};
|
|
|
|
#[derive(Clone)]
|
|
pub struct Collect;
|
|
|
|
impl Command for Collect {
|
|
fn name(&self) -> &str {
|
|
"collect"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("collect")
|
|
.input_output_types(vec![(Type::Any, Type::Any)])
|
|
.required(
|
|
"closure",
|
|
SyntaxShape::Closure(Some(vec![SyntaxShape::Any])),
|
|
"the closure to run once the stream is collected",
|
|
)
|
|
.switch(
|
|
"keep-env",
|
|
"let the block affect environment variables",
|
|
None,
|
|
)
|
|
.category(Category::Filters)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Collect the stream and pass it to a block."
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let capture_block: Closure = call.req(engine_state, stack, 0)?;
|
|
|
|
let block = engine_state.get_block(capture_block.block_id).clone();
|
|
let mut stack_captures = stack.captures_to_stack(&capture_block.captures);
|
|
|
|
let metadata = input.metadata();
|
|
let input: Value = input.into_value(call.head);
|
|
|
|
let mut saved_positional = None;
|
|
if let Some(var) = block.signature.get_positional(0) {
|
|
if let Some(var_id) = &var.var_id {
|
|
stack_captures.add_var(*var_id, input.clone());
|
|
saved_positional = Some(*var_id);
|
|
}
|
|
}
|
|
|
|
let result = eval_block(
|
|
engine_state,
|
|
&mut stack_captures,
|
|
&block,
|
|
input.into_pipeline_data(),
|
|
call.redirect_stdout,
|
|
call.redirect_stderr,
|
|
)
|
|
.map(|x| x.set_metadata(metadata));
|
|
|
|
if call.has_flag("keep-env") {
|
|
redirect_env(engine_state, stack, &stack_captures);
|
|
// for when we support `data | let x = $in;`
|
|
// remove the variables added earlier
|
|
for var_id in capture_block.captures.keys() {
|
|
stack_captures.remove_var(*var_id);
|
|
}
|
|
if let Some(u) = saved_positional {
|
|
stack_captures.remove_var(u);
|
|
}
|
|
// add any new variables to the stack
|
|
stack.vars.extend(stack_captures.vars);
|
|
}
|
|
result
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Use the second value in the stream",
|
|
example: "[1 2 3] | collect { |x| $x.1 }",
|
|
result: Some(Value::test_int(2)),
|
|
}]
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(Collect {})
|
|
}
|
|
}
|