cote 0.17.1

Quickly build your command line utils
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

#![allow(unused)]
use std::ffi::OsString;
use std::io::BufRead;
use std::io::Cursor;
use std::io::Seek;
use std::path::PathBuf;

use cote::prelude::*;
use cote::shell::shell::Complete;
use cote::shell::value::Values;
use cote::shell::CompletionManager;
use cote::shell::Context;

#[derive(Debug, Cote)]
#[cote(shellcomp)]
struct Cli {
    /// Enable IPV6 protocol
    ipv6: bool,

    /// Set http method
    #[arg(scvalues = ["PUT", "GET", "POST"])]
    method: Option<String>,

    /// Set url
    #[pos(scvalues = read_url_from_config())]
    url: String,

    /// Set files
    #[pos(index = 2.., scvalues = list_files())]
    files: Vec<PathBuf>,
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    assert!(complete_shells(
        vec!["example", "--i"],
        1,
        vec![
            ("fish", vec!["--ipv6\t\"Enable IPV6 protocol\""]),
            ("zsh", vec!["--ipv6:Enable IPV6 protocol"]),
            ("bash", vec!["--ipv6"]),
            ("powershell", vec!["--ipv6\tEnable IPV6 protocol"]),
            ("powershell7", vec!["--ipv6\tEnable IPV6 protocol"])
        ]
    )
    .is_ok());

    assert!(complete_shells(
        vec!["example", "--method="],
        1,
        vec![
            (
                "fish",
                vec!["--method=PUT", "--method=GET", "--method=POST"]
            ),
            ("zsh", vec!["--method=PUT", "--method=GET", "--method=POST"]),
            ("bash", vec!["PUT", "GET", "POST"]),
            (
                "powershell",
                vec!["--method=PUT", "--method=GET", "--method=POST"]
            ),
            (
                "powershell7",
                vec!["--method=PUT", "--method=GET", "--method=POST"]
            )
        ]
    )
    .is_ok());

    assert!(complete_shells(
        vec!["example", "--ipv6", "--method", "PUT", ""],
        4,
        vec![
            ("fish", vec!["github.com", "gitlab.com"]),
            ("zsh", vec!["github.com", "gitlab.com"]),
            ("bash", vec!["github.com", "gitlab.com"]),
            ("powershell", vec!["github.com", "gitlab.com"]),
            ("powershell7", vec!["github.com", "gitlab.com"])
        ]
    )
    .is_ok());

    assert!(complete_shells(
        vec!["example"],
        1,
        vec![
            ("fish", vec!["github.com", "gitlab.com"]),
            ("zsh", vec!["github.com", "gitlab.com"]),
            ("bash", vec!["github.com", "gitlab.com"]),
            ("powershell", vec!["github.com", "gitlab.com"]),
            ("powershell7", vec!["github.com", "gitlab.com"])
        ]
    )
    .is_ok());

    assert!(complete_shells(
        vec!["example", "--ipv6", "--method", "PUT", "gitlab.com", ""],
        5,
        vec![
            ("fish", vec!["a.json", "b.toml", "c.yaml"]),
            ("zsh", vec!["a.json", "b.toml", "c.yaml"]),
            ("bash", vec!["a.json", "b.toml", "c.yaml"]),
            ("powershell", vec!["a.json", "b.toml", "c.yaml"]),
            ("powershell7", vec!["a.json", "b.toml", "c.yaml"])
        ]
    )
    .is_ok());

    Ok(())
}

pub fn read_url_from_config<O>() -> impl Values<O> {
    cote::shell::value::repeat_values(|_| {
        Ok(["github.com", "gitlab.com"]
            .iter()
            .map(OsString::from)
            .collect())
    })
}

pub fn list_files<O>() -> impl Values<O> {
    cote::shell::value::repeat_values(|_| {
        Ok(["a.json", "b.toml", "c.yaml"]
            .iter()
            .map(OsString::from)
            .collect())
    })
}

pub fn complete_shells(
    args: Vec<impl Into<OsString>>,
    cword: usize,
    excepts: Vec<(&str, Vec<impl Into<String>>)>,
) -> Result<(), Box<dyn std::error::Error>> {
    let args = args.into_iter().map(|v| v.into()).collect::<Vec<_>>();

    for (shell, except) in excepts {
        let except = except.into_iter().map(|v| v.into()).collect::<Vec<_>>();

        complete_at(shell, &args, cword, &except)?;
    }
    Ok(())
}

pub fn complete_at(
    shell: &str,
    args: &[OsString],
    cword: usize,
    except: &[String],
) -> Result<(), Box<dyn std::error::Error>> {
    let os_string = OsString::default();
    let writer = Cursor::new(vec![]);
    let mut ctx = Context::new(
        args,
        args.get(cword).unwrap_or(&os_string),
        &args[cword - 1],
        cword,
    );
    let mut m = cote::shell::shell::Manager::default();
    let shell = m.find_mut(shell)?;
    let mut manager = CompletionManager::new(Cli::into_parser()?);

    shell.set_buff(writer);
    Cli::inject_completion_values(&mut manager)?;
    assert!(manager.complete(shell, &mut ctx).is_ok());
    let mut cursor = shell.take_buff().unwrap();

    cursor.seek(std::io::SeekFrom::Start(0))?;

    let output: Vec<_> = cursor.lines().collect::<Result<Vec<_>, std::io::Error>>()?;

    assert_eq!(output, except, "completion output check failed!");
    Ok(())
}