mirror of https://github.com/nushell/nushell synced 2025-01-12 13:19:01 +00:00

History

Piepmatz 5f3c8d45d8 Add `auto` option for `config.use_ansi_coloring` (#14647 ) <!-- 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.		2024-12-26 11:00:01 -06:00
..
command.rs	Fix quoting in `to nuon` and refactor quoting functions (#14180 )	2024-10-29 07:43:26 -05:00
config_files.rs	Add `auto` option for `config.use_ansi_coloring` (#14647 )	2024-12-26 11:00:01 -06:00
ide.rs	lsp and --ide-check fix for `path self` related diagnostics (#14538 )	2024-12-07 09:46:52 -06:00
logger.rs	Add options for filtering the log output from `nu` (#13044 )	2024-06-05 16:42:55 +08:00
main.rs	Add `auto` option for `config.use_ansi_coloring` (#14647 )	2024-12-26 11:00:01 -06:00
README.md	Remove old nushell/merge engine-q	2022-02-07 14:54:06 -05:00
run.rs	Add `auto` option for `config.use_ansi_coloring` (#14647 )	2024-12-26 11:00:01 -06:00
signals.rs	fix: relay Signals reset to plugins (#13510 )	2024-08-06 03:35:40 -07:00
terminal.rs	Deduplicate `nix` dependency versions (#12307 )	2024-03-27 16:43:37 +01:00
test_bins.rs	Make `Hooks` fields non-optional to match the new config defaults (#14345 )	2024-11-29 21:11:09 +00:00

README.md

Nushell REPL

This directory contains the main Nushell REPL (read eval print loop) as part of the CLI portion of Nushell, which creates the nu binary itself.

Current versions of the nu binary will use the Nu argument parsing logic to parse the commandline arguments passed to nu, leaving the logic here to be a thin layer around what the core libraries.