Move zoxide completer from external_completers to custom_completions

book/custom_completions.md

@@ -71,6 +71,29 @@ cat                 rat                 bat
 
 Because we made matching case-insensitive and used `positional: false`, Nushell will find the substring "a" in all of the completion suggestions. Additionally, because we set `sort: false`, the completions will be left in their original order. This is useful if your completions are already sorted in a particular order unrelated to their text (e.g. by date).
 
+## Another Practical Example - Zoxide Path Completions
+
+[Zoxide](https://github.com/ajeetdsouza/zoxide) allows easily jumping between visited folders in the system. It's possible to autocomplete matching folders with this completer:
+
+```nu
+def "nu-complete zoxide path" [context: string] {
+    let parts = $context | split row " " | skip 1
+    {
+      options: {
+        sort: false,
+        completion_algorithm: prefix,
+        positional: false,
+        case_sensitive: false,
+      },
+      completions: (zoxide query --list --exclude $env.PWD -- ...$parts | lines),
+    }
+  }
+
+def --env --wrapped z [...rest: string@"nu-complete zoxide path"] {
+  __zoxide_z ...$rest
+}
+```
+
 ## Modules and Custom Completions
 
 Since completion commands aren't meant to be called directly, it's common to define them in modules.
@@ -230,4 +253,4 @@ let carapace_completer = {|spans|
 }
 ```
 
-[More examples of custom completers can be found in the cookbook](../cookbook/external_completers.md).
+[More examples of external completers can be found in the cookbook](../cookbook/external_completers.md).

cookbook/external_completers.md

@@ -32,36 +32,6 @@ A couple of things to note on this command:
 - The output of the fish completer does not contain a header (name of the columns), so we add `--noheaders` to prevent `from tsv` from treating the first row as headers and later give the columns their names using `rename`.
 - `--no-infer` is optional. `from tsv` will infer the data type of the result, so a numeric value like some git hashes will be inferred as a number. `--no-infer` will keep everything as a string. It doesn't make a difference in practice but it will print a more consistent output if the completer is ran on it's own.
 
-### Zoxide completer
-
-[Zoxide](https://github.com/ajeetdsouza/zoxide) allows easily jumping between visited folders in the system. It's possible to autocomplete matching folders with this completer:
-
-```nu
-let zoxide_completer = {|spans|
-    $spans | skip 1 | zoxide query -l ...$in | lines | where {|x| $x != $env.PWD}
-}
-```
-
-This completer is not usable for almost every other command, so it's recommended to add it as an override in the [multiple completer](#multiple-completer):
-
-```nu
-{
-    z => $zoxide_completer
-    zi => $zoxide_completer
-}
-```
-
-> **Note**
-> Zoxide sets an alias (`z` by default) that calls the `__zoxide_z` function.
-> If [alias completions](#alias-completions) are supported, the following snippet can be used instead:
->
-> ```nu
-> {
->     __zoxide_z => $zoxide_completer
->     __zoxide_zi => $zoxide_completer
-> }
-> ```
-
 ### Multiple completer
 
 Sometimes, a single external completer is not flexible enough. Luckily, as many as needed can be combined into a single one. The following example uses `$default_completer` for all commands except the ones explicitly defined in the record:
@@ -154,8 +124,6 @@ let external_completer = {|spans|
         git => $fish_completer
         # carapace doesn't have completions for asdf
         asdf => $fish_completer
-        # use zoxide completions for zoxide commands
-        __zoxide_z | __zoxide_zi => $zoxide_completer
         _ => $carapace_completer
     } | do $in $spans
 }