Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nu-complete: display values #5292

Open
rsteube opened this issue Apr 22, 2022 · 4 comments
Open

nu-complete: display values #5292

rsteube opened this issue Apr 22, 2022 · 4 comments
Labels
completions Issues related to tab completion enhancement New feature or request line editor Issues related to reedline Stale used for marking issues and prs as stale syntax-highlighting Bugs or performance issues with the syntax highlighting logic

Comments

@rsteube
Copy link
Contributor

rsteube commented Apr 22, 2022

Related problem

Other shells discern between the actual value being inserted and the one being displayed.
This enables shorter values for multiparts completion like paths where only the current segment is shown.
Additionally, some shells provide the ability to set the color (either by ansi escape sequence or additional parameter) to highlight specific values and paths (LS_COLORS).

Describe the solution you'd like

A way to return display values additionally to the ones to be inserted from custom completions. As well as the color if possible.

Describe alternatives you've considered

No response

Additional context and details

2022-04-22-113916_1276x305_scrot

related #5291

@fdncred
Copy link
Collaborator

fdncred commented Apr 22, 2022

Most of the menu stuff is in reedline, but some is also in nushell. It would be nice to use the LS_COLORS we currently support in menus. @elferherrera where would someone go to implement this coloring change?

@fdncred fdncred added the enhancement New feature or request label Apr 22, 2022
@elferherrera
Copy link
Contributor

Sorry, can you paste an image of how you would like it to look like?

@fdncred
Copy link
Collaborator

fdncred commented Apr 22, 2022

The completions example above already has a screenshot, note that folders are a different color than files, etc.

@rsteube
Copy link
Contributor Author

rsteube commented Apr 22, 2022

Here's another example with git:
2022-04-22-132119_1276x228_scrot

@sholderbach sholderbach added line editor Issues related to reedline syntax-highlighting Bugs or performance issues with the syntax highlighting logic completions Issues related to tab completion labels Aug 22, 2022
@github-actions github-actions bot added the Stale used for marking issues and prs as stale label Jan 17, 2023
fdncred pushed a commit that referenced this issue Jan 25, 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

Adds style support.

Reverse highlighting is recommended for the
[completion-menu](https://www.nushell.sh/book/line_editor.html#completion-menu):
```nushell
style: {
    text: white
    selected_text: {
        attr: r
    }
    description_text: white_dimmed
}
```

needs nushell/reedline#691
related #5292
fix carapace-sh/carapace#967

<!--
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.
-->

# User-Facing Changes

Style support for values during completion:


![image](https://github.com/nushell/nushell/assets/9090290/f5e4440e-61db-4eeb-87b3-f887b6918c50)


![image](https://github.com/nushell/nushell/assets/9090290/e59065a6-58c2-4f5f-82ea-e2b9c2464b9a)

<!-- 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 issue 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

Adds style support.

Reverse highlighting is recommended for the
[completion-menu](https://www.nushell.sh/book/line_editor.html#completion-menu):
```nushell
style: {
    text: white
    selected_text: {
        attr: r
    }
    description_text: white_dimmed
}
```

needs nushell/reedline#691
related nushell#5292
fix carapace-sh/carapace#967

<!--
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.
-->

# User-Facing Changes

Style support for values during completion:


![image](https://github.com/nushell/nushell/assets/9090290/f5e4440e-61db-4eeb-87b3-f887b6918c50)


![image](https://github.com/nushell/nushell/assets/9090290/e59065a6-58c2-4f5f-82ea-e2b9c2464b9a)

<!-- 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
Labels
completions Issues related to tab completion enhancement New feature or request line editor Issues related to reedline Stale used for marking issues and prs as stale syntax-highlighting Bugs or performance issues with the syntax highlighting logic
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants