cmdtree 0.9.0

(Rust) commands tree
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

//! Example on implementing an argument completer.
//!
//! try running and hitting TAB with the following inputs to see completion!
//! ```
//! arg-completion=> path  <-- make sure you tab with a space after `path`
//! arg-completion=> nested path
//! arg-completion.nested => path
//! arg-completion=> no-complete  <-- won't see any completions!

use cmdtree::completion::*;
use cmdtree::{Builder, BuilderChain};

fn main() {
    let cmder = Builder::default_config("arg-completion")
        .add_action("path", "complete path names", |_, _| ())
        .add_action("no-complete", "", |_, _| ())
        .begin_class("nested", "")
        .add_action("path", "", |_, _| ())
        .into_commander()
        .unwrap();

    cmder.run_with_completion(|c| ArgCompleter {
        items: create_action_completion_items(c),
    });
}

struct ArgCompleter<'a> {
    items: Vec<ActionMatch<'a>>,
}

impl<'a, T: Terminal> Completer<T> for ArgCompleter<'a> {
    fn complete(
        &self,
        _word: &str,
        prompter: &Prompter<T>,
        _start: usize,
        end: usize,
    ) -> Option<Vec<Completion>> {
        // only want the completion on the 'path' action
        // notice the syntax for qualified paths.
        let actions = [".path", "nested..path"];

        let line = prompter.buffer();

        // retrieve the matched action is there is one.
        // also check that the action is one that should be completed on, using qualified path
        let action_match = self.items.iter().find(|x| {
            line.starts_with(x.info.completestr.as_str())
                && actions.contains(&x.qualified_path.as_str())
        })?;

        // going to use this logic for compeletions, but can implement own
        let path_completer = linefeed::complete::PathCompleter;

        let arg_line = &line[action_match.info.completestr.len()..]; // portion of line just for args
        let word_start = linefeed::complete::word_break_start(arg_line, " "); // break on spaces
        let word = &arg_line[word_start..];

        path_completer.complete(word, prompter, word_start, end)
    }
}