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

external completer: support style #11442

Merged
merged 1 commit into from
Jan 25, 2024
Merged

Conversation

rsteube
Copy link
Contributor

@rsteube rsteube commented Dec 29, 2023

Description

Adds style support.

Reverse highlighting is recommended for the completion-menu:

style: {
    text: white
    selected_text: {
        attr: r
    }
    description_text: white_dimmed
}

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

User-Facing Changes

Style support for values during completion:

image

image

Tests + Formatting

After Submitting

@rsteube
Copy link
Contributor Author

rsteube commented Jan 3, 2024

This can be tested with v0.29 of carapace.
Config needs the new spread operator:

let external_completer = {|spans|
    carapace $spans.0 nushell ...$spans | from json
}

@rsteube rsteube force-pushed the completer-style branch 4 times, most recently from 52c430b to 9d9cfbc Compare January 24, 2024 22:33
@fdncred
Copy link
Collaborator

fdncred commented Jan 24, 2024

@rsteube Can we get this CI green (seems like you're working on it). I was updating to the latest nu-ansi-term and lscolors and can't compile nushell because of this.

@rsteube
Copy link
Contributor Author

rsteube commented Jan 24, 2024

Ah yes, saw the lscolors release and was just updating the branch.

@rsteube rsteube marked this pull request as ready for review January 24, 2024 22:44
@fdncred
Copy link
Collaborator

fdncred commented Jan 24, 2024

Does the default_config.nu need to change to support this? It doesn't seem like it's working very good with my config. I can't tell which item is selected.

This is what I typically use

    style: {
      text: { fg: "#33ff00" }
      selected_text: { fg: "#0c0c0c" bg: "#33ff00" attr: b}
      description_text: yellow
    }

@rsteube
Copy link
Contributor Author

rsteube commented Jan 24, 2024

Yes, reverse (r) highlighting would be best:

            style: {
                text: white
                selected_text: {
                    attr: r
                }
                description_text: white_dimmed
            }

@fdncred
Copy link
Collaborator

fdncred commented Jan 24, 2024

The reason the colors are configurable are so people can configure them. Seems like this change should respect the colors specified, especially since they provide fg and bg.

Also, it seems incomplete to just have one color now for selected text. Shouldn't there be one for the value and one for description?

@fdncred
Copy link
Collaborator

fdncred commented Jan 24, 2024

It seems like the default_config.nu should have this for the completion_menu, so it keeps with our green theme, unless we decide to change the value and the description color via style.

            style: {
                text: green
                selected_text: {attr: r}
                description_text: yellow
            }

@rsteube
Copy link
Contributor Author

rsteube commented Jan 24, 2024

The reason the colors are configurable are so people can configure them. Seems like this change should respect the colors specified, especially since they provide fg and bg.

Yeah, think I'll need to have another look at that in reedline.

Also, it seems incomplete to just have one color now for selected text. Shouldn't there be one for the value and one for description?

Possible 🤔

@fdncred
Copy link
Collaborator

fdncred commented Jan 24, 2024

ok, i landed that reedline change. @rsteube when you get a chance can you update reedline in this PR (cargo update -p reedline) and whatever else needs to be changed based on your most recent reedline PR?

@fdncred
Copy link
Collaborator

fdncred commented Jan 25, 2024

@rsteube would you mind rebasing (or fixing some other way)? I keep getting this when I check out your PR.

image

@fdncred
Copy link
Collaborator

fdncred commented Jan 25, 2024

This one is clearly not your fault. We're going to have to get that fixed and do another rebase. Sorry.
image

@fdncred
Copy link
Collaborator

fdncred commented Jan 25, 2024

ok, just landed #11638 which should fix this CI problem. if you could rebase again please.

@fdncred
Copy link
Collaborator

fdncred commented Jan 25, 2024

Thanks. I tested this and I think it's finally ready to land. Thanks for your help!

@fdncred fdncred merged commit 7f1fd76 into nushell:main Jan 25, 2024
19 checks passed
@rsteube rsteube deleted the completer-style branch January 25, 2024 14:22
@hustcer hustcer added this to the v0.90.0 milestone Feb 3, 2024
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

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
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Configuration / Styling on nushell?
3 participants