作者： jiashiwen 原文来源：https://tidb.net/blog/ec09d93b

文盘 Rust – 子命令提示，提高用户体验

notice”Rust is a trademark of the Mozilla Foundation in the US and other countries.”

上次我们聊到 CLI 的领域交互模式。在领域交互模式中，可能存在多层次的子命令。在使用过程中如果全评记忆的话，命令少还好，多了真心记不住。频繁 –help 也是个很麻烦的事情。如果每次按 ‘tab’ 键就可以提示或补齐命令是不是很方便呢。这一节我们就来说说 ‘autocommplete’ 如何实现。我们还是以 interactcli-rs 中的实现来解说实现过程。

实现过程

其实，rustyline  已经为我们提供了基本的 helper 功能框架, 其中包括了 completer。我们来看代码，文件位置 src/interact/cli.rs

#[derive(Helper)]struct MyHelper {    completer: CommandCompleter,    highlighter: MatchingBracketHighlighter,    validator: MatchingBracketValidator,    hinter: HistoryHinter,    colored_prompt: String,}
pub fn run() {    let config = Config::builder()        .history_ignore_space(true)        .completion_type(CompletionType::List)        .output_stream(OutputStreamType::Stdout)        .build();
    let h = MyHelper {        completer: get_command_completer(),        highlighter: MatchingBracketHighlighter::new(),        hinter: HistoryHinter {},        colored_prompt: "".to_owned(),        validator: MatchingBracketValidator::new(),    };
    let mut rl = Editor::with_config(config);    // let mut rl = Editor::<()>::new();    rl.set_helper(Some(h));
    ......
}

首先定义 MyHelper 结构体， 需要实现 Completer + Hinter + Highlighter + Validator trait。然后通过 rustyline 的 set_helper 函数加载我们定义好的 helper。在 MyHelper 结构体中，需要我们自己来实现 completer 的逻辑。

Sub command autocompleter 实现详解

• SubCmd 结构体

• SubCmd 结构体包含，命令级别，命令名称，以及该命令包含的子命令信息，以便在实现实现 autocomplete 时定位命令和子命令的范围

• 在程序启动时遍历所有的 command，src/cmd/rootcmd.rs 中的 all_subcommand 函数负责收集所有命令并转换为 Vec

• CommandCompleter 子命令自动补充功能的核心部分

• CommandCompleter 的实现部分比较多，大致包括两个部分，前一部分包括：获取某一级别下所有可能的子命令、获取某级别下某字符串开头的子命令、获取某级别下某个命令的所有子命令，等基本功能。这部分代码中有注释就不一一累述。函数 complete_cmd 用来计算行中的位置以及在该位置的替换内容。输入项是命令行的内容以及光标所在位置，输出项为在该位置需要替换的内容。比如，我们在提示符下输入 “root cm” root 下包含 cmd1、cmd2 两个子命令，此时如果按 ‘tab’ 键，complete_cmd 函数就会返回 (7,[cmd1,cmd2])。

文盘 Rust 系列

• 文盘 Rust – 生命周期问题引发的 static hashmap 锁
  

• 文盘 Rust – 起手式，CLI 程序
  

• 文盘 Rust – 领域交互模式如何实现
  

• 文盘 Rust – 子命令提示，提高用户体验