usage-rs 7.0.0

A compiled CLI parser for Rust, built on usage specs
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

#![cfg(feature = "spec")]

use std::ffi::{OsStr, OsString};

#[derive(Debug, usage_rs::Cli)]
#[usage(
    bin = "static-spec",
    spec_endpoint_file = "tests/fixtures/static.usage.kdl"
)]
struct StaticSpec {
    #[usage(long)]
    verbose: bool,
}

#[test]
fn embedded_spec_matches_the_live_serializer() {
    let expected = StaticSpec::to_kdl();
    let request = [OsStr::new(usage_rs::SPEC_REQUEST)];
    assert_eq!(
        StaticSpec::spec_request(&request).as_deref(),
        Some(expected.as_str())
    );
    let outcome = StaticSpec::embedded_outcome(&[OsString::from(usage_rs::SPEC_REQUEST)]);
    let exit = outcome.exit().unwrap();
    assert_eq!(exit.text, expected);
    assert_eq!(exit.code, 0);
    assert!(!exit.stderr);
}

#[test]
fn ordinary_arguments_still_parse() {
    assert!(StaticSpec::spec_request(&[OsStr::new("--verbose")]).is_none());
    assert!(
        StaticSpec::parse_from(&[OsStr::new("--verbose")])
            .unwrap()
            .verbose
    );
}

// The test feature enables usage-argv/help-advanced through usage-test too.
#[cfg(not(any(feature = "help-advanced", feature = "test")))]
#[test]
#[should_panic(expected = "require the `help-advanced` feature")]
fn recursive_help_is_explicitly_unavailable_in_the_small_build() {
    usage_rs::help::render_all(StaticSpec::spec(), StaticSpec::command());
}

#[cfg(not(any(feature = "help-advanced", feature = "test")))]
#[test]
#[should_panic(expected = "require the `help-advanced` feature")]
fn hand_written_flattened_metadata_is_not_silently_ignored() {
    let root = usage_rs::spec::CommandMeta {
        extra: &usage_rs::spec::CommandExtra {
            flatten_help: true,
            ..*StaticSpec::spec().root.extra
        },
        ..*StaticSpec::spec().root
    };
    let spec = usage_rs::spec::Spec {
        root: &root,
        ..*StaticSpec::spec()
    };
    usage_rs::help::render(&spec, StaticSpec::command(), false);
}