Lib.rs

一个快速、轻量级的 Windows PowerShell Tab 自动补全库。

关于

Tabby 将为您命令行应用程序生成 Tab 自动补全功能。它使用非常简单，设置也很容易！

用法

让我们开始设置，以便您可以开始 tab。

以下是 tabby 的基本用法。

步骤 1. 设置您的补全器

use std::path::Path;

use tabby::{setup::verify_setup, Completer};

fn main() {
    // Collect input args
    let args = std::env::args().collect::<Vec<String>>();

    if args.len() > 1 {
        // This part is required for tabby to work..
        if args[1] == "complete" {
            // create a new tabby completer
            // the path should be the absolute path to your tabby config (we'll get to this soon). Without an absolute path, tabby will not work.
            let completer = Completer::new(Path::new(
                r"C:\Users\myname\dev\mycli\tabby.config.json",
            ))
            .unwrap();

            // if you can't verify that tabby has installed a completer for your command line application, install tab completion.
            if !verify_setup(&completer).unwrap() {
                completer.install().unwrap();
            }

            // get completions for your command line applications
            let completions = completer.get_completions();
            
            // you must print the completions for powershell to be able to detect your completions.
            println!("{}", completions);
        }
    }
}

步骤 2. 编写补全

现在，我们将设置 tabby.config.json。您的 tabby 配置将包含 tabby 将能够完成的补全。这应该与您在前面步骤中使用的绝对路径相同。

{
  "name": "your-cli-exe-name-without-the-.exe-extension",
  "commands": [
        {
            "name": "acustomcommand",
            "flags": [
                "--aflag",
                "--anotherflag"
            ]
        },
        {
            "name": "anothercustomcommand",
            "flags": [
                "--verbose",
                "--debug"
            ]
        },
    ]
}

步骤 3. 编写补全

好了！我们差不多完成了。现在进行最后一步。通过您的 系统环境变量 将您的可执行文件添加到 PATH 中。

这就完成了！我们完成了。享受您的 Tab 补全 🥳。