Fix commandline --cursor to return int #11864
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sholderbach
added
the
pr:breaking-change
fdncred
approved these changes
Feb 15, 2024
sholderbach
reviewed
Feb 15, 2024
| @@ -19,6 +19,7 @@ impl Command for Commandline { | |||
| .input_output_types(vec
There was a problem hiding this comment.
Do we now allow divergence in output type? Otherwise this may still confuse the typecheck
There was a problem hiding this comment.
It seems to work but I guess we could have a separate subcommand like commandline cursor.
There was a problem hiding this comment.
I noticed that typecheck does not work well as @sholderbach pointed out.
❯ def foo []: string -> int { commandline -c }
Error: nu::parser::output_type_mismatch
× Command output doesn't match int.
╭─[entry #2:1:29]
1 │ def foo []: string -> int { commandline -c }
· ───────┬──────
· ╰── command doesn't output int
╰────It might be better to have a separate subcommand as @fdncred mentioned.
Should we revert this?
There was a problem hiding this comment.
We could revert it, or just add a new sub command and do the revert in that PR.
There was a problem hiding this comment.
I will create a PR to add a subcommand and I revert this in that PR.
kubouch
added
pr:bugfix
fdncred
pushed a commit
that referenced
this pull request
Feb 18, 2024
<!-- 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. #11864 (comment) ## 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. -->
dmatos2012
pushed a commit
to dmatos2012/nushell
that referenced
this pull request
Feb 20, 2024
<!-- 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. --> Fix nushell#11825 # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> `commandline --cursor` returns int. # 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. -->
dmatos2012
pushed a commit
to dmatos2012/nushell
that referenced
this pull request
Feb 20, 2024
<!-- 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, nushell#11825 nushell#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 nushell#11864 , typecheck does not work well. nushell#11864 (comment) ## 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. -->
kik4444
pushed a commit
to kik4444/nushell-fork
that referenced
this pull request
Feb 28, 2024
<!-- 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. --> Fix nushell#11825 # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> `commandline --cursor` returns int. # 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. -->
kik4444
pushed a commit
to kik4444/nushell-fork
that referenced
this pull request
Feb 28, 2024
<!-- 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, nushell#11825 nushell#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 nushell#11864 , typecheck does not work well. nushell#11864 (comment) ## 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. -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fix #11825
User-Facing Changes
commandline --cursorreturns int.Tests + Formatting
After Submitting