cargo-orthohelp 0.8.0

OrthoConfig documentation tooling for IR generation.
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

//! Unit tests for MAML rendering.

use super::super::test_fixtures;
use super::*;
use crate::ir::{LocalizedDocMetadata, LocalizedFieldMetadata};
use crate::schema::{CliMetadata, DefaultValue, EnvMetadata, FileMetadata, ValueType};
use rstest::{fixture, rstest};

#[fixture]
fn minimal_doc() -> LocalizedDocMetadata {
    test_fixtures::minimal_doc("en-US", "Fixture app")
}

#[rstest]
fn render_help_includes_common_parameters(minimal_doc: LocalizedDocMetadata) {
    let command = CommandSpec {
        name: "fixture".to_owned(),
        metadata: &minimal_doc,
    };
    let xml = render_help(
        &[command],
        MamlOptions {
            should_include_common_parameters: true,
        },
    );
    assert!(xml.contains("<command:commonParameters"));
}

#[rstest]
fn render_help_renders_enum_values(mut minimal_doc: LocalizedDocMetadata) {
    minimal_doc.fields.push(LocalizedFieldMetadata {
        name: "level".to_owned(),
        help: "Log level".to_owned(),
        long_help: None,
        value: Some(ValueType::Enum {
            variants: vec!["info".to_owned(), "warn".to_owned()],
        }),
        default: Some(DefaultValue {
            display: "info".to_owned(),
        }),
        required: false,
        deprecated: None,
        cli: Some(CliMetadata {
            long: Some("level".to_owned()),
            short: Some('l'),
            value_name: None,
            multiple: false,
            takes_value: true,
            possible_values: vec![],
            hide_in_help: false,
        }),
        env: Some(EnvMetadata {
            var_name: "FIXTURE_LEVEL".to_owned(),
        }),
        file: Some(FileMetadata {
            key_path: "level".to_owned(),
        }),
        examples: vec![],
        links: vec![],
        notes: vec![],
    });

    let command = CommandSpec {
        name: "fixture".to_owned(),
        metadata: &minimal_doc,
    };
    let xml = render_help(
        &[command],
        MamlOptions {
            should_include_common_parameters: false,
        },
    );
    assert!(xml.contains("Possible values: info, warn."));
    assert!(xml.contains("Environment variable: FIXTURE_LEVEL."));
    assert!(xml.contains("Config key: level."));
}

#[rstest]
fn xml_escapes_reserved_chars(mut minimal_doc: LocalizedDocMetadata) {
    minimal_doc.about = "Use <tag> & more".to_owned();
    let command = CommandSpec {
        name: "fixture".to_owned(),
        metadata: &minimal_doc,
    };
    let xml = render_help(
        &[command],
        MamlOptions {
            should_include_common_parameters: false,
        },
    );
    assert!(xml.contains("Use &lt;tag&gt; &amp; more"));
}