Skip to content

FIX: out of date external completion examples #923

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
May 24, 2023
Merged

FIX: out of date external completion examples #923

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8d0a719
fix the multi-completer external completion
amtoine May 23, 2023
d252065
use the new mutable `$env.* = ...` syntax
amtoine May 23, 2023
daea6e6
use 4 spaces indentation in the multi-completer example
amtoine May 23, 2023
47e8543
define completers and add note about how to configure any of them
amtoine May 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 25 additions & 32 deletions book/custom_completions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ module commands {
def animals [] {
["cat", "dog", "eel" ]
}

def animal-names [context: string] {
{
cat: ["Missy", "Phoebe"]
Expand Down Expand Up @@ -140,55 +140,48 @@ External completers can also be integrated, instead of relying solely on Nushell
For this set the `external_completer` field in `config.nu` to a block which will be evaluated if no Nushell completions were found.
You can configure the block to run an external completer, such as [carapace](https://github.com/rsteube/carapace-bin).

> **Note**
> in the following, we define a bunch of different completers.
>
> one can configure them in `$nu.config-path` as follows:
>
> ```nu
> $env.config.completions.external = {
> enable: true
> max_results: 100
> completer: $completer
> }
> ```

This example should enable carapace external completions:

```nu
# config.nu
let carapace_completer = {|spans|
carapace $spans.0 nushell $spans | from json
}

# The default config record. This is where much of your global configuration is setup.
let-env config = {
# ... your config
completions: {
external: {
enable: true
max_results: 100
completer: $carapace_completer
}
}
}
```

Multiple completers can be defined as such:

```nu
let external_completer = {|spans|
{
$spans.0: { default_completer $spans | from json } # default
ls: { ls_completer $spans | from json }
git: { git_completer $spans | from json }
} | get $spans.0 | each {|it| do $it}
let multiple_completers = {|spans|
{
$spans.0: { default_completer $spans | from json } # default
ls: { ls_completer $spans | from json }
git: { git_completer $spans | from json }
} | each {|it| do $it}
}
```

This example shows an external completer that uses the `fish` shell's `complete` command. (You must have the fish shell installed for this example to work.)

```nu
let fish_completer = {|spans|
fish --command $'complete "--do-complete=($spans | str join " ")"' | str trim | split row "\n" | each { |line| $line | split column "\t" value description } | flatten
}

let-env config = {
# ... your config
completions: {
external: {
enable: true
max_results: 100
completer: $fish_completer
}
}
fish --command $'complete "--do-complete=($spans | str join " ")"'
| str trim
| split row "\n"
| each { |line| $line | split column "\t" value description }
| flatten
}
```

Expand Down