posh-tabcomplete 0.2.0

Blazing fast tab completion for powershell.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

# posh-tabcomplete
[![Crates.io](https://img.shields.io/crates/v/posh-tabcomplete.svg)](https://crates.io/crates/posh-tabcomplete)
[![Build Status](https://github.com/domsleee/posh-tabcomplete/actions/workflows/ci.yml/badge.svg)](https://github.com/domsleee/posh-tabcomplete/actions/workflows/ci.yml)

Blazing fast tab completion for powershell and pwsh.

![demo](media/demo.gif)

This video is using the `MenuComplete` binding in  `code $PROFILE`:

```powershell
Set-PSReadLineKeyHandler -Key Tab MenuComplete
```

Features:
* Fast startup and execution using [nushell/nu-engine](https://crates.io/crates/nu-engine)
* Extendable using `.nu` files, with built in support for commmon tasks like `git` and `npm run`
* Supports all platforms. Tested on windows, WSL, mac and linux

By default, [completions.nu](./resource/completions.nu) is used. An alternative `.nu` file can be specified in the `TABCOMPLETE_FILE` environment variable.

## Installation

### Step 1. Install binary

There are binaries available in [releases](https://github.com/domsleee/posh-tabcomplete/releases), or with one of these commands:

| Repository      | Instructions                              |
| --------------- | ----------------------------------------- |
| **[crates.io]** | `cargo install posh-tabcomplete --locked` |


### Step 2. Setup powershell

Add this line to your profile, you can edit this by typing `code $PROFILE` in powershell:
```pwsh
Invoke-Expression (&posh-tabcomplete init | Out-String)
```

[crates.io]: https://crates.io/crates/posh-tabcomplete

## Built in completions
The completions packaged with the binary in [completions.nu](./resource/completions.nu) are:
* [git completions](https://github.com/nushell/nu_scripts/blob/main/custom-completions/git/git-completions.nu). These are also combined with [git auto generated completions](https://github.com/nushell/nu_scripts/blob/main/custom-completions/auto-generate/completions/git.nu)
* [npm completions](https://github.com/nushell/nu_scripts/blob/main/custom-completions/npm/npm-completions.nu)
* [cargo completions](https://github.com/nushell/nu_scripts/blob/main/custom-completions/cargo/cargo-completions.nu)

## Benchmarks
To run these, run `./benchmark/benchmark_all.ps1`

| Benchmark                                            | Results                                                 |
| ---------------------------------------------------- | ------------------------------------------------------- |
| `benchmark/init` - startup time                      | posh-tabcomplete: 45ms, posh-git: 280ms (6.22x faster)  |
| `benchmark/complete` - tab completion (100 branches) | posh-tabcomplete: 104ms, posh-git: 222ms (2.13x faster) |

## Aliases / Function support
Functions are supported. For example, the completion of `gco` in the demo is:
```pwsh
function gco() { git checkout $args }
```

There is no support for alias completions at this time.

## Full list of completions

See [completions.nu](./resource/completions.nu):

* `git`
  * `branch`
  * `checkout`
  * `cherry-pick`
  * `fetch`
  * `merge`
  * `push`
  * `rebase`
  * `switch`
  * `diff`
* `npm`
  * `run`