mirror of
https://github.com/nushell/nushell
synced 2025-01-13 05:38:57 +00:00
5f3c8d45d8
<!--
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.
-->
In this PR I continued the idea of #11494, it added an `auto` option to
the ansi coloring config option, I did this too but in a more simple
approach.
So I added a new enum `UseAnsiColoring` with the three values `True`,
`False` and `Auto`. When that value is set to `auto`, the default value,
it will use `std::io::stdout().is_terminal()` to decided whether to use
ansi coloring. This allows to dynamically decide whether to print ansi
color codes or not, [cargo does it the same
way](652623b779/src/bin/cargo/main.rs (L72)).
`True` and `False` act as overrides to the `is_terminal` check. So with
that PR it is possible to force ansi colors on the `table` command or
automatically remove them from the miette errors if no terminal is used.
# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->
Terminal users shouldn't be affected by this change as the default value
was `true` and `is_terminal` returns for terminals `true` (duh).
Non-terminal users, that use `nu` in some embedded way or the engine
implemented in some other way (like my jupyter kernel) will now have by
default no ansi coloring and need to enable it manually if their
environment allows it.
# 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
> ```
-->
The test for fancy errors expected ansi codes, since tests aren't run
"in terminal", the ansi codes got stripped away.
I added a line that forced ansi colors above it. I'm not sure if that
should be the case or if we should test against no ansi colors.
- 🟢 `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 should resolve #11464 and partially #11847. This also closes
#11494.
117 lines
3.1 KiB
Rust
117 lines
3.1 KiB
Rust
use nu_test_support::{nu, nu_repl_code};
|
||
|
||
#[test]
|
||
fn filesize_metric_true() {
|
||
let code = &[
|
||
r#"$env.config = { filesize: { metric: true, format:"mb" } }"#,
|
||
r#"20mib | into string"#,
|
||
];
|
||
let actual = nu!(nu_repl_code(code));
|
||
assert_eq!(actual.out, "21.0 MB");
|
||
}
|
||
|
||
#[test]
|
||
fn filesize_metric_false() {
|
||
let code = &[
|
||
r#"$env.config = { filesize: { metric: false, format:"mib" } }"#,
|
||
r#"20mib | into string"#,
|
||
];
|
||
let actual = nu!(nu_repl_code(code));
|
||
assert_eq!(actual.out, "20.0 MiB");
|
||
}
|
||
|
||
#[test]
|
||
fn filesize_metric_overrides_format() {
|
||
let code = &[
|
||
r#"$env.config = { filesize: { metric: false, format:"mb" } }"#,
|
||
r#"20mib | into string"#,
|
||
];
|
||
let actual = nu!(nu_repl_code(code));
|
||
assert_eq!(actual.out, "20.0 MiB");
|
||
}
|
||
|
||
#[test]
|
||
fn filesize_format_auto_metric_true() {
|
||
let code = &[
|
||
r#"$env.config = { filesize: { metric: true, format:"auto" } }"#,
|
||
r#"[2mb 2gb 2tb] | into string | to nuon"#,
|
||
];
|
||
let actual = nu!(nu_repl_code(code));
|
||
assert_eq!(actual.out, r#"["2.0 MB", "2.0 GB", "2.0 TB"]"#);
|
||
}
|
||
|
||
#[test]
|
||
fn filesize_format_auto_metric_false() {
|
||
let code = &[
|
||
r#"$env.config = { filesize: { metric: false, format:"auto" } }"#,
|
||
r#"[2mb 2gb 2tb] | into string | to nuon"#,
|
||
];
|
||
let actual = nu!(nu_repl_code(code));
|
||
assert_eq!(actual.out, r#"["1.9 MiB", "1.9 GiB", "1.8 TiB"]"#);
|
||
}
|
||
|
||
#[test]
|
||
fn fancy_default_errors() {
|
||
let code = nu_repl_code(&[
|
||
"$env.config.use_ansi_coloring = true",
|
||
r#"def force_error [x] {
|
||
error make {
|
||
msg: "oh no!"
|
||
label: {
|
||
text: "here's the error"
|
||
span: (metadata $x).span
|
||
}
|
||
}
|
||
}"#,
|
||
r#"force_error "My error""#,
|
||
]);
|
||
|
||
let actual = nu!(format!("try {{ {code} }}"));
|
||
|
||
assert_eq!(
|
||
actual.err,
|
||
"Error: \n \u{1b}[31m×\u{1b}[0m oh no!\n ╭─[\u{1b}[36;1;4mline2:1:13\u{1b}[0m]\n \u{1b}[2m1\u{1b}[0m │ force_error \"My error\"\n · \u{1b}[35;1m ─────┬────\u{1b}[0m\n · \u{1b}[35;1m╰── \u{1b}[35;1mhere's the error\u{1b}[0m\u{1b}[0m\n ╰────\n\n"
|
||
);
|
||
}
|
||
|
||
#[test]
|
||
fn narratable_errors() {
|
||
let code = nu_repl_code(&[
|
||
r#"$env.config = { error_style: "plain" }"#,
|
||
r#"def force_error [x] {
|
||
error make {
|
||
msg: "oh no!"
|
||
label: {
|
||
text: "here's the error"
|
||
span: (metadata $x).span
|
||
}
|
||
}
|
||
}"#,
|
||
r#"force_error "my error""#,
|
||
]);
|
||
|
||
let actual = nu!(format!("try {{ {code} }}"));
|
||
|
||
assert_eq!(
|
||
actual.err,
|
||
r#"Error: oh no!
|
||
Diagnostic severity: error
|
||
Begin snippet for line2 starting at line 1, column 1
|
||
|
||
snippet line 1: force_error "my error"
|
||
label at line 1, columns 13 to 22: here's the error
|
||
|
||
|
||
"#,
|
||
);
|
||
}
|
||
|
||
#[test]
|
||
fn plugins() {
|
||
let code = &[
|
||
r#"$env.config = { plugins: { nu_plugin_config: { key: value } } }"#,
|
||
r#"$env.config.plugins"#,
|
||
];
|
||
let actual = nu!(nu_repl_code(code));
|
||
assert_eq!(actual.out, r#"{nu_plugin_config: {key: value}}"#);
|
||
}
|