mirror of
https://github.com/nushell/nushell.git
synced 2025-04-23 20:58:19 +02:00
95f89a093a
<!-- 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. --> Add ansi codes to move cursor position: `ansi cursor_left`, `ansi cursor_right`, `ansi cursor_up`, `ansi cursor_down` Why I add these? I'm trying to add a spinner to the message end for a long running task, just to find that I need to move the cursor left to make it work as expected: `with-progress 'Waiting for the task to finish' { sleep 10sec }` ```nu def with-progress [ message: string, # Message to display action: closure, # Action to perform --success: string, # Success message --error: string # Error message ] { print -n $'($message) ' # ASCII spinner frames let frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'] # Start the spinner in the background let spinner_pid = job spawn { mut i = 0 print -n (ansi cursor_off) loop { print -n (ansi cursor_left) print -n ($frames | get $i) sleep 100ms $i = ($i + 1) mod ($frames | length) } } # Run the action and capture result let result = try { do $action { success: true } } catch { { success: false } } # Stop the spinner job kill $spinner_pid print "\r \r" # Show appropriate message if $result.success { print ($success | default '✓ Done!') } else { print ($error | default '✗ Failed!') exit 1 } } ``` # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> # 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. -->
30 lines
832 B
Rust
30 lines
832 B
Rust
use nu_test_support::nu;
|
|
|
|
#[test]
|
|
fn test_ansi_shows_error_on_escape() {
|
|
let actual = nu!(r"ansi --escape \");
|
|
|
|
assert!(actual.err.contains("no need for escape characters"))
|
|
}
|
|
|
|
#[test]
|
|
fn test_ansi_list_outputs_table() {
|
|
let actual = nu!("ansi --list | length");
|
|
|
|
assert_eq!(actual.out, "429");
|
|
}
|
|
|
|
#[test]
|
|
fn test_ansi_codes() {
|
|
let actual = nu!("$'(ansi clear_scrollback_buffer)'");
|
|
assert_eq!(actual.out, "\x1b[3J");
|
|
|
|
// Currently, bg is placed before fg in the results
|
|
// It's okay if something internally changes this, but
|
|
// if so, the test case will need to be updated to:
|
|
// assert_eq!(actual.out, "\x1b[31;48;2;0;255;0mHello\x1b[0m");
|
|
|
|
let actual = nu!("$'(ansi { fg: red, bg: \"#00ff00\" })Hello(ansi reset)'");
|
|
assert_eq!(actual.out, "\x1b[48;2;0;255;0;31mHello\x1b[0m");
|
|
}
|