mirror of
https://github.com/nushell/nushell
synced 2024-12-30 15:03:25 +00:00
e52d7bc585
<!-- 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! --> # 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. --> Part of https://github.com/nushell/nushell/issues/12963, step 2. This PR refactors changes the use of `expression.span` to `expression.span_id` via a new helper `Expression::span()`. A new `GetSpan` is added to abstract getting the span from both `EngineState` and `StateWorkingSet`. # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> `format pattern` loses the ability to use variables in the pattern, e.g., `... | format pattern 'value of {$it.name} is {$it.value}'`. This is because the command did a custom parse-eval cycle, creating spans that are not merged into the main engine state. We could clone the engine state, add Clone trait to StateDelta and merge the cloned delta to the cloned state, but IMO there is not much value from having this ability, since we have string interpolation nowadays: `... | $"value of ($in.name) is ($in.value)"`. # 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 toolkit.nu; toolkit test stdlib"` 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. -->
114 lines
2.8 KiB
Rust
114 lines
2.8 KiB
Rust
use nu_test_support::fs::Stub::{EmptyFile, FileWithContentToBeTrimmed};
|
|
use nu_test_support::playground::Playground;
|
|
use nu_test_support::{nu, pipeline};
|
|
|
|
#[test]
|
|
fn creates_the_resulting_string_from_the_given_fields() {
|
|
let actual = nu!(
|
|
cwd: "tests/fixtures/formats", pipeline(
|
|
r#"
|
|
open cargo_sample.toml
|
|
| get package
|
|
| format pattern "{name} has license {license}"
|
|
"#
|
|
));
|
|
|
|
assert_eq!(actual.out, "nu has license ISC");
|
|
}
|
|
|
|
#[test]
|
|
fn format_input_record_output_string() {
|
|
let actual = nu!(r#"{name: Downloads} | format pattern "{name}""#);
|
|
|
|
assert_eq!(actual.out, "Downloads");
|
|
}
|
|
|
|
#[test]
|
|
fn given_fields_can_be_column_paths() {
|
|
let actual = nu!(
|
|
cwd: "tests/fixtures/formats", pipeline(
|
|
r#"
|
|
open cargo_sample.toml
|
|
| format pattern "{package.name} is {package.description}"
|
|
"#
|
|
));
|
|
|
|
assert_eq!(actual.out, "nu is a new type of shell");
|
|
}
|
|
|
|
#[test]
|
|
fn cant_use_variables() {
|
|
let actual = nu!(
|
|
cwd: "tests/fixtures/formats", pipeline(
|
|
r#"
|
|
open cargo_sample.toml
|
|
| format pattern "{$it.package.name} is {$it.package.description}"
|
|
"#
|
|
));
|
|
|
|
// TODO SPAN: This has been removed during SpanId refactor
|
|
assert!(actual.err.contains("Removed functionality"));
|
|
}
|
|
|
|
#[test]
|
|
fn error_unmatched_brace() {
|
|
let actual = nu!(
|
|
cwd: "tests/fixtures/formats", pipeline(
|
|
r#"
|
|
open cargo_sample.toml
|
|
| format pattern "{package.name"
|
|
"#
|
|
));
|
|
|
|
assert!(actual.err.contains("unmatched curly brace"));
|
|
}
|
|
|
|
#[test]
|
|
fn format_filesize_works() {
|
|
Playground::setup("format_filesize_test_1", |dirs, sandbox| {
|
|
sandbox.with_files(&[
|
|
EmptyFile("yehuda.txt"),
|
|
EmptyFile("jttxt"),
|
|
EmptyFile("andres.txt"),
|
|
]);
|
|
|
|
let actual = nu!(
|
|
cwd: dirs.test(), pipeline(
|
|
"
|
|
ls
|
|
| format filesize KB size
|
|
| get size
|
|
| first
|
|
"
|
|
));
|
|
|
|
assert_eq!(actual.out, "0.0 KB");
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn format_filesize_works_with_nonempty_files() {
|
|
Playground::setup(
|
|
"format_filesize_works_with_nonempty_files",
|
|
|dirs, sandbox| {
|
|
sandbox.with_files(&[FileWithContentToBeTrimmed(
|
|
"sample.toml",
|
|
r#"
|
|
[dependency]
|
|
name = "nu"
|
|
"#,
|
|
)]);
|
|
|
|
let actual = nu!(
|
|
cwd: dirs.test(),
|
|
"ls sample.toml | format filesize B size | get size | first"
|
|
);
|
|
|
|
#[cfg(not(windows))]
|
|
assert_eq!(actual.out, "25");
|
|
|
|
#[cfg(windows)]
|
|
assert_eq!(actual.out, "27");
|
|
},
|
|
)
|
|
}
|