mirror of
https://github.com/nushell/nushell.git
synced 2025-06-30 14:40:06 +02:00
Add tee
command for operating on copies of streams (#11928)
<!-- if this PR closes one or more issues, you can automatically link the PR with them by using one of the [*linking keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword), e.g. - this PR should close #xxxx - fixes #xxxx you can also mention related issues, PRs or discussions! --> [Related conversation on Discord](https://discord.com/channels/601130461678272522/615329862395101194/1209951539901366292) # Description <!-- Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes. Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience. --> This is inspired by the Unix tee command, but significantly more powerful. Rather than just writing to a file, you can do any kind of stream operation that Nushell supports within the closure. The equivalent of Unix `tee -a file.txt` would be, for example, `command | tee { save -a file.txt }` - but of course this is Nushell, and you can do the same with structured data to JSON objects, or even just run any other command on the system with it. A `--stderr` flag is provided for operating on the stderr stream from external programs. This may produce unexpected results if the stderr stream is not then also printed by something else - nushell currently doesn't. See #11929 for the fix for that. # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> If someone was using the system `tee` command, they might be surprised to find that it's different. # 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` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass (on Windows make sure to [enable developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging)) - `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 > ``` --> - 🟢 `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. -->
This commit is contained in:
@ -104,6 +104,7 @@ mod split_row;
|
||||
mod str_;
|
||||
mod table;
|
||||
mod take;
|
||||
mod tee;
|
||||
mod terminal;
|
||||
mod to_text;
|
||||
mod touch;
|
||||
|
49
crates/nu-command/tests/commands/tee.rs
Normal file
49
crates/nu-command/tests/commands/tee.rs
Normal file
@ -0,0 +1,49 @@
|
||||
use nu_test_support::{fs::file_contents, nu, playground::Playground};
|
||||
|
||||
#[test]
|
||||
fn tee_save_values_to_file() {
|
||||
Playground::setup("tee_save_values_to_file_test", |dirs, _sandbox| {
|
||||
let output = nu!(
|
||||
cwd: dirs.test(),
|
||||
r#"1..5 | tee { save copy.txt } | to text"#
|
||||
);
|
||||
assert_eq!("12345", output.out);
|
||||
assert_eq!(
|
||||
"1\n2\n3\n4\n5\n",
|
||||
file_contents(dirs.test().join("copy.txt"))
|
||||
);
|
||||
})
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tee_save_stdout_to_file() {
|
||||
Playground::setup("tee_save_stdout_to_file_test", |dirs, _sandbox| {
|
||||
let output = nu!(
|
||||
cwd: dirs.test(),
|
||||
r#"
|
||||
$env.FOO = "teststring"
|
||||
nu --testbin echo_env FOO | tee { save copy.txt }
|
||||
"#
|
||||
);
|
||||
assert_eq!("teststring", output.out);
|
||||
assert_eq!("teststring\n", file_contents(dirs.test().join("copy.txt")));
|
||||
})
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tee_save_stderr_to_file() {
|
||||
Playground::setup("tee_save_stderr_to_file_test", |dirs, _sandbox| {
|
||||
let output = nu!(
|
||||
cwd: dirs.test(),
|
||||
"\
|
||||
$env.FOO = \"teststring\"; \
|
||||
do { nu --testbin echo_env_stderr FOO } | \
|
||||
tee --stderr { save copy.txt } | \
|
||||
complete | \
|
||||
get stderr
|
||||
"
|
||||
);
|
||||
assert_eq!("teststring", output.out);
|
||||
assert_eq!("teststring\n", file_contents(dirs.test().join("copy.txt")));
|
||||
})
|
||||
}
|
Reference in New Issue
Block a user