Go-Prompt: 构建强大交互式命令行工具

Go-Prompt 是一个用于 Go 语言的交互式命令行提示库，它提供了类似 Python 的 prompt-toolkit 的功能，可以帮助开发者快速构建功能丰富的命令行界面(CLI)工具。

主要特性

• 自动补全
• 语法高亮
• 多行输入支持
• 历史命令记录
• 自定义提示符
• 异步执行支持

安装

go get github.com/c-bata/go-prompt

基础使用示例

package main

import (
	"fmt"
	"github.com/c-bata/go-prompt"
)

func completer(d prompt.Document) []prompt.Suggest {
	s := []prompt.Suggest{
		{Text: "users", Description: "Store the username and age"},
		{Text: "articles", Description: "Store the article text posted by user"},
		{Text: "comments", Description: "Store the text commented to articles"},
		{Text: "groups", Description: "Store the user group info"},
	}
	return prompt.FilterHasPrefix(s, d.GetWordBeforeCursor(), true)
}

func main() {
	fmt.Println("Please select table.")
	t := prompt.Input("> ", completer)
	fmt.Println("You selected " + t)
}

高级功能实现

1. 自定义提示符和颜色

func main() {
	p := prompt.New(
		executor,
		completer,
		prompt.OptionPrefix(">>> "),
		prompt.OptionPrefixTextColor(prompt.Yellow),
		prompt.OptionTitle("My Awesome CLI"),
	)
	p.Run()
}

2. 多行输入支持

func main() {
	p := prompt.New(
		executor,
		completer,
		prompt.OptionMultiLine(true),
		prompt.OptionPrefix(">>> "),
	)
	p.Run()
}

3. 历史命令记录

func main() {
	history := []string{"ls -la", "cd ~", "exit"}
	p := prompt.New(
		executor,
		completer,
		prompt.OptionHistory(history),
	)
	p.Run()
}

4. 自定义快捷键绑定

func main() {
	p := prompt.New(
		executor,
		completer,
		prompt.OptionAddKeyBind(
			prompt.KeyBind{
				Key: prompt.ControlC,
				Fn: func(buf *prompt.Buffer) {
					fmt.Println("\nCtrl+C pressed!")
				},
			},
		),
	)
	p.Run()
}

实际应用示例：构建一个简单的数据库CLI

package main

import (
	"fmt"
	"strings"
	"github.com/c-bata/go-prompt"
)

var livePrefixState struct {
	livePrefix string
	isEnable   bool
}

func changeLivePrefix() (string, bool) {
	return livePrefixState.livePrefix, livePrefixState.isEnable
}

func executor(in string) {
	in = strings.TrimSpace(in)
	
	if in == "" {
		livePrefixState.isEnable = false
		livePrefixState.livePrefix = in
		return
	}
	
	blocks := strings.Split(in, " ")
	switch blocks[0] {
	case "select":
		if len(blocks) < 2 {
			fmt.Println("select [table_name]")
			return
		}
		fmt.Printf("Querying data from %s...\n", blocks[1])
	case "insert":
		if len(blocks) < 2 {
			fmt.Println("insert [table_name] [data]")
			return
		}
		fmt.Printf("Inserting data into %s: %s\n", blocks[1], strings.Join(blocks[2:], " "))
	case "exit", "quit":
		fmt.Println("Bye!")
		return
	default:
		fmt.Println("Unknown command")
	}
	
	livePrefixState.livePrefix = in + " > "
	livePrefixState.isEnable = true
}

func completer(d prompt.Document) []prompt.Suggest {
	s := []prompt.Suggest{
		{Text: "select", Description: "Query data from table"},
		{Text: "insert", Description: "Insert data into table"},
		{Text: "update", Description: "Update table data"},
		{Text: "delete", Description: "Delete data from table"},
		{Text: "exit", Description: "Exit the program"},
		{Text: "quit", Description: "Exit the program"},
	}
	
	if d.TextBeforeCursor() == "" {
		return s
	}
	
	return prompt.FilterHasPrefix(s, d.GetWordBeforeCursor(), true)
}

func main() {
	fmt.Println("Welcome to SimpleDB CLI. Type 'exit' or 'quit' to exit.")
	p := prompt.New(
		executor,
		completer,
		prompt.OptionPrefix("> "),
		prompt.OptionLivePrefix(changeLivePrefix),
		prompt.OptionTitle("SimpleDB CLI"),
	)
	p.Run()
}

性能优化建议

1. 异步补全：对于耗时较长的补全操作，使用异步方式
2. 缓存补全结果：对频繁使用的补全结果进行缓存
3. 精简补全列表：避免返回过长的补全列表
4. 延迟加载：对于大型数据集，考虑延迟加载补全项

总结

Go-Prompt 提供了构建交互式命令行工具所需的核心功能，通过合理使用其API，可以创建出用户体验良好的CLI应用。它的主要优势在于：

• 简单易用的API设计
• 高度可定制化的界面
• 良好的性能表现
• 活跃的社区支持

对于需要构建复杂命令行工具的项目，Go-Prompt 是一个值得考虑的选择。