nushell/tests/repl/test_commandline.rs

143 lines
3.4 KiB
Rust
Raw Normal View History

use crate::repl::tests::{fail_test, run_test, TestResult};
#[test]
fn commandline_test_get_empty() -> TestResult {
run_test("commandline", "")
}
#[test]
fn commandline_test_append() -> TestResult {
separate `commandline` into subcommands (#11877) <!-- 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. --> Related issue and PR, #11825 #11864 This improves the signature of `commandline`. ## Before `commandline` returns different types depending on the flags and an aurgument. | command | input | output | description | |-----------------------------|---------|---------|----------------------------------------| | `commandline` | nothing | string | get current cursor line | | `commandline arg` | nothing | nothing | replace the cursor line with `arg` | | `commandline --append arg` | nothing | nothing | append `arg` to the end of cursor line | | `commandline --insert arg` | nothing | nothing | insert `arg` to the position of cursor | | `commandline --replace arg` | nothing | nothing | replace the cursor line with `arg` | | `commandline --cursor` | nothing | int | get current cursor position | | `commandline --cursor pos` | nothing | nothing | set cursor position to pos | | `commandline --cursor-end` | nothing | nothing | set cursor position to end | `help commandline` shows that `commandline` accepts string as pipeline input, but `commandline` ignores pipeline input. ``` Input/output types: ╭───┬─────────┬─────────╮ │ # │ input │ output │ ├───┼─────────┼─────────┤ │ 0 │ nothing │ nothing │ │ 1 │ string │ string │ ╰───┴─────────┴─────────╯ ``` https://github.com/nushell/nushell/blob/671bd08bcda06ab340a05f960a03dd691e59c51a/crates/nu-cli/src/commands/commandline.rs#L70 This is misleading. Due to the change #11864 , typecheck does not work well. https://github.com/nushell/nushell/pull/11864#discussion_r1491814054 ## After Separate `commandline` into subcommands so that each subcommands returns the same type for the same input type. | command | input | output | description | |----------------------------------|---------|---------|----------------------------------------| | `commandline` | nothing | string | get current cursor line | | `commandline edit arg` | nothing | nothing | replace the cursor line with `arg` | | `commandline edit --append arg` | nothing | nothing | append `arg` to the end of cursor line | | `commandline edit --insert arg` | nothing | nothing | insert `arg` to the position of cursor | | `commandline edit --replace arg` | nothing | nothing | replace the cursor line with `arg` | | `commandline get-cursor` | nothing | int | get current cursor position | | `commandline set-cursor pos` | nothing | nothing | set cursor position to pos | | `commandline set-cursor --end` | nothing | nothing | set cursor position to end | # 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 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 > ``` --> # 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. -->
2024-02-18 23:15:59 +01:00
run_test(
"commandline edit --replace '0👩👩2'\n\
commandline set-cursor 2\n\
commandline edit --append 'ab'\n\
print (commandline)\n\
commandline get-cursor",
"0👩👩2ab\n\
2",
)
}
#[test]
fn commandline_test_insert() -> TestResult {
run_test(
"commandline edit --replace '0👩👩2'\n\
commandline set-cursor 2\n\
commandline edit --insert 'ab'\n\
print (commandline)\n\
commandline get-cursor",
"0👩👩ab2\n\
4",
)
}
#[test]
fn commandline_test_replace() -> TestResult {
run_test(
"commandline edit --replace '0👩👩2'\n\
commandline edit --replace 'ab'\n\
print (commandline)\n\
commandline get-cursor",
"ab\n\
2",
)
}
#[test]
fn commandline_test_cursor() -> TestResult {
run_test(
"commandline edit --replace '0👩👩2'\n\
commandline set-cursor 1\n\
commandline edit --insert 'x'\n\
commandline",
"0x👩👩2",
)?;
run_test(
"commandline edit --replace '0👩👩2'\n\
commandline set-cursor 2\n\
commandline edit --insert 'x'\n\
commandline",
"0👩👩x2",
)
}
#[test]
fn commandline_test_cursor_show_pos_begin() -> TestResult {
run_test(
"commandline edit --replace '0👩👩'\n\
commandline set-cursor 0\n\
commandline get-cursor",
"0",
)
}
#[test]
fn commandline_test_cursor_show_pos_end() -> TestResult {
run_test(
"commandline edit --replace '0👩👩'\n\
commandline set-cursor 2\n\
commandline get-cursor",
"2",
)
}
#[test]
fn commandline_test_cursor_show_pos_mid() -> TestResult {
run_test(
"commandline edit --replace '0👩👩2'\n\
commandline set-cursor 1\n\
commandline get-cursor",
"1",
)?;
run_test(
"commandline edit --replace '0👩👩2'\n\
commandline set-cursor 2\n\
commandline get-cursor",
"2",
)
}
#[test]
fn commandline_test_cursor_too_small() -> TestResult {
run_test(
"commandline edit --replace '123456'\n\
commandline set-cursor -1\n\
commandline edit --insert '0'\n\
commandline",
"0123456",
)
}
#[test]
fn commandline_test_cursor_too_large() -> TestResult {
run_test(
"commandline edit --replace '123456'\n\
commandline set-cursor 10\n\
commandline edit --insert '0'\n\
commandline",
"1234560",
)
}
#[test]
fn commandline_test_cursor_invalid() -> TestResult {
fail_test(
"commandline edit --replace '123456'\n\
commandline set-cursor 'abc'",
"expected int",
)
}
#[test]
fn commandline_test_cursor_end() -> TestResult {
run_test(
"commandline edit --insert '🤔🤔'; commandline set-cursor --end; commandline get-cursor",
"2", // 2 graphemes
)
}
#[test]
fn commandline_test_cursor_type() -> TestResult {
run_test("commandline get-cursor | describe", "int")
}