flag-rs 0.10.0

A Cobra-inspired CLI framework with dynamic completions
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300

//! Basic integration tests for shell completion functionality
//!
//! These tests verify the basic completion functionality that is implemented.

use flag_rs::{CommandBuilder, CompletionResult, Flag, FlagType};

/// Creates a test CLI with various command structures
fn create_test_cli() -> flag_rs::Command {
    CommandBuilder::new("testcli")
        .short("A test CLI for completion testing")
        .flag(
            Flag::new("verbose")
                .short('v')
                .usage("Enable verbose output")
                .value_type(FlagType::Bool),
        )
        .flag(
            Flag::new("config")
                .short('c')
                .usage("Config file path")
                .value_type(FlagType::File),
        )
        .subcommand(
            CommandBuilder::new("server")
                .short("Server management commands")
                .flag(
                    Flag::new("port")
                        .short('p')
                        .usage("Port to listen on")
                        .value_type(FlagType::Int)
                        .default(flag_rs::FlagValue::Int(8080)),
                )
                .subcommand(
                    CommandBuilder::new("start")
                        .short("Start the server")
                        .flag(
                            Flag::new("daemon")
                                .short('d')
                                .usage("Run as daemon")
                                .value_type(FlagType::Bool),
                        )
                        .arg_completion(|_ctx, prefix| {
                            let profiles = vec!["development", "staging", "production"];
                            Ok(CompletionResult::new().extend(
                                profiles
                                    .into_iter()
                                    .filter(|p| p.starts_with(prefix))
                                    .map(String::from),
                            ))
                        })
                        .build(),
                )
                .subcommand(
                    CommandBuilder::new("stop")
                        .short("Stop the server")
                        .flag(
                            Flag::new("force")
                                .short('f')
                                .usage("Force stop")
                                .value_type(FlagType::Bool),
                        )
                        .build(),
                )
                .build(),
        )
        .subcommand(
            CommandBuilder::new("database")
                .short("Database operations")
                .alias("db")
                .flag(
                    Flag::new("host")
                        .short('h')
                        .usage("Database host")
                        .value_type(FlagType::String)
                        .default(flag_rs::FlagValue::String("localhost".to_string())),
                )
                .flag_completion("host", |_ctx, prefix| {
                    let hosts = vec!["localhost", "db.example.com", "192.168.1.100"];
                    Ok(CompletionResult::new().extend(
                        hosts
                            .into_iter()
                            .filter(|h| h.starts_with(prefix))
                            .map(String::from),
                    ))
                })
                .subcommand(
                    CommandBuilder::new("migrate")
                        .short("Run database migrations")
                        .arg_completion(|_ctx, prefix| {
                            let migrations = vec![
                                "001_initial_schema",
                                "002_add_users_table",
                                "003_add_indexes",
                            ];
                            Ok(CompletionResult::new().extend(
                                migrations
                                    .into_iter()
                                    .filter(|m| m.starts_with(prefix))
                                    .map(String::from),
                            ))
                        })
                        .build(),
                )
                .build(),
        )
        .build()
}

#[test]
fn test_basic_command_structure() {
    let app = create_test_cli();

    // Test basic properties
    assert_eq!(app.name(), "testcli");
    assert_eq!(app.short(), "A test CLI for completion testing");

    // Test flags exist
    assert!(app.flags().contains_key("verbose"));
    assert!(app.flags().contains_key("config"));

    // Test subcommands exist
    assert!(app.subcommands().contains_key("server"));
    assert!(app.subcommands().contains_key("database"));
}

#[test]
fn test_completion_with_aliases() {
    let app = create_test_cli();

    // Find database command by alias
    let db_cmd = app.find_subcommand("db");
    assert!(db_cmd.is_some());
    assert_eq!(db_cmd.unwrap().name(), "database");
}

#[test]
fn test_dynamic_arg_completion() {
    let app = create_test_cli();
    let ctx = flag_rs::Context::new(vec![
        "testcli".to_string(),
        "server".to_string(),
        "start".to_string(),
    ]);

    // Find the start subcommand
    let server_cmd = app.find_subcommand("server").unwrap();
    let start_cmd = server_cmd.find_subcommand("start").unwrap();

    // Test argument completion
    let result = start_cmd.get_completions(&ctx, "dev", None).unwrap();
    assert_eq!(result.values, vec!["development"]);

    let result = start_cmd.get_completions(&ctx, "prod", None).unwrap();
    assert_eq!(result.values, vec!["production"]);

    let result = start_cmd.get_completions(&ctx, "", None).unwrap();
    assert_eq!(result.values.len(), 3);
}

#[test]
fn test_dynamic_flag_completion() {
    let app = create_test_cli();
    let ctx = flag_rs::Context::new(vec!["testcli".to_string(), "database".to_string()]);

    // Find the database command
    let db_cmd = app.find_subcommand("database").unwrap();

    // Test flag value completion
    let result = db_cmd.get_completions(&ctx, "local", Some("host")).unwrap();
    assert_eq!(result.values, vec!["localhost"]);

    let result = db_cmd.get_completions(&ctx, "db.", Some("host")).unwrap();
    assert_eq!(result.values, vec!["db.example.com"]);
}

#[test]
fn test_nested_subcommand_structure() {
    let app = create_test_cli();

    // Test that nested subcommands exist
    let server = app.find_subcommand("server").unwrap();
    assert!(server.subcommands().contains_key("start"));
    assert!(server.subcommands().contains_key("stop"));

    let database = app.find_subcommand("database").unwrap();
    assert!(database.subcommands().contains_key("migrate"));
}

#[test]
fn test_flag_types() {
    let app = CommandBuilder::new("typetest")
        .flag(Flag::new("choice").value_type(FlagType::Choice(vec![
            "option1".to_string(),
            "option2".to_string(),
            "option3".to_string(),
        ])))
        .flag(Flag::new("file").value_type(FlagType::File))
        .flag(Flag::new("dir").value_type(FlagType::Directory))
        .build();

    // Test that flags are properly stored with their types
    let choice_flag = app.flags().get("choice").unwrap();
    match &choice_flag.value_type {
        FlagType::Choice(choices) => {
            assert_eq!(choices.len(), 3);
            assert!(choices.contains(&"option1".to_string()));
        }
        _ => panic!("Expected Choice type"),
    }
}

#[test]
fn test_completion_with_global_flags() {
    let app = CommandBuilder::new("globaltest")
        .flag(
            Flag::new("global")
                .usage("A global flag")
                .value_type(FlagType::Bool),
        )
        .subcommand(
            CommandBuilder::new("sub")
                .flag(
                    Flag::new("local")
                        .usage("A local flag")
                        .value_type(FlagType::Bool),
                )
                .build(),
        )
        .build();

    // Verify flags are accessible at correct levels
    assert!(app.flags().contains_key("global"));

    let sub = app.find_subcommand("sub").unwrap();
    assert!(sub.flags().contains_key("local"));
    // Global flags are inherited through parent pointer
}

#[test]
fn test_completion_special_characters() {
    let app = CommandBuilder::new("special-test")
        .subcommand(
            CommandBuilder::new("sub-command")
                .flag(
                    Flag::new("with-dash")
                        .usage("Flag with dash")
                        .value_type(FlagType::Bool),
                )
                .build(),
        )
        .build();

    // Verify special characters are properly handled in names
    let sub = app.find_subcommand("sub-command");
    assert!(sub.is_some());
    assert!(sub.unwrap().flags().contains_key("with-dash"));
}

#[test]
fn test_empty_completion_result() {
    let app = CommandBuilder::new("emptytest")
        .arg_completion(|_ctx, prefix| {
            if prefix.starts_with('z') {
                Ok(CompletionResult::new())
            } else {
                Ok(CompletionResult::new().add("something"))
            }
        })
        .build();

    let ctx = flag_rs::Context::new(vec!["emptytest".to_string()]);

    // Should return empty result for "z" prefix
    let result = app.get_completions(&ctx, "z", None).unwrap();
    assert!(result.values.is_empty());

    // Should return result for other prefixes
    let result = app.get_completions(&ctx, "s", None).unwrap();
    assert_eq!(result.values, vec!["something"]);
}

#[test]
fn test_completion_with_descriptions() {
    let app = CommandBuilder::new("desctest")
        .arg_completion(|_ctx, _prefix| {
            Ok(CompletionResult::new()
                .add_with_description("option1", "First option")
                .add_with_description("option2", "Second option")
                .add("option3"))
        })
        .build();

    let ctx = flag_rs::Context::new(vec!["desctest".to_string()]);
    let result = app.get_completions(&ctx, "", None).unwrap();

    assert_eq!(result.values.len(), 3);
    assert_eq!(result.descriptions[0], "First option");
    assert_eq!(result.descriptions[1], "Second option");
    assert_eq!(result.descriptions[2], "");
}