clap-markdown 0.1.5

Autogenerate Markdown documentation for clap command-line tools
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

use clap::{Arg, Command};
use clap_markdown::{help_markdown_command_custom, MarkdownOptions};

use pretty_assertions::assert_eq;

/// Test behavior for an app that defines a:
///
/// * `name`
/// * `display_name`
///
/// but no custom `bin_name`.
#[test]
fn test_title_behavior_for_name_and_display_name_app() {
    let mut app = Command::new("my-program-name")
        // Note: Intentionally not setting custom bin name.
        // .bin_name("my-program-bin-name")
        .display_name("my-program-display-name")
        .version("1.2.3")
        .about("This program does things.")
        .arg(Arg::new("foo").short('f'));
    let () = app.build();

    //-------------------------------------------------------------------
    // Test the native behavior of `clap`, in terms of whether it prefers
    // the `name`, `bin_name`, and `display_name` properties are used.
    //-------------------------------------------------------------------

    assert_eq!(
        app.render_long_help().to_string(),
        "\
This program does things.

Usage: my-program-name [OPTIONS]

Options:
  -f <foo>
          

  -h, --help
          Print help

  -V, --version
          Print version
"
    );

    //-------------------------------------------------------
    // Test how clap-markdown handles the various name fields
    //-------------------------------------------------------

    assert_eq!(
        help_markdown_command_custom(
            &app,
            &MarkdownOptions::new().show_footer(false)
        ),
        "\
# Command-Line Help for `my-program-display-name`

This document contains the help content for the `my-program-display-name` command-line program.

**Command Overview:**

* [`my-program-display-name`↴](#my-program-display-name)

## `my-program-display-name`

This program does things.

**Usage:** `my-program-name [OPTIONS]`

###### **Options:**

* `-f <FOO>`
* `-h`, `--help` — Print help
* `-V`, `--version` — Print version



"
    );
}

/// Test behavior for an app that defines a:
///
/// * `name`
/// * `bin_name`
/// * `display_name`
#[test]
fn test_title_behavior_for_name_bin_name_and_display_name_app() {
    let mut app = Command::new("my-program-name")
        .bin_name("my-program-bin-name")
        .display_name("my-program-display-name")
        .version("1.2.3")
        .about("This program does things.")
        .arg(Arg::new("foo").short('f'));
    let () = app.build();

    //-------------------------------------------------------------------
    // Test the native behavior of `clap`, in terms of whether it prefers
    // the `name`, `bin_name`, and `display_name` properties are used.
    //-------------------------------------------------------------------

    assert_eq!(
        app.render_long_help().to_string(),
        "\
This program does things.

Usage: my-program-bin-name [OPTIONS]

Options:
  -f <foo>
          

  -h, --help
          Print help

  -V, --version
          Print version
"
    );

    //-------------------------------------------------------
    // Test how clap-markdown handles the various name fields
    //-------------------------------------------------------

    assert_eq!(
        help_markdown_command_custom(
            &app,
            &MarkdownOptions::new().show_footer(false)
        ),
        "\
# Command-Line Help for `my-program-display-name`

This document contains the help content for the `my-program-display-name` command-line program.

**Command Overview:**

* [`my-program-display-name`↴](#my-program-display-name)

## `my-program-display-name`

This program does things.

**Usage:** `my-program-bin-name [OPTIONS]`

###### **Options:**

* `-f <FOO>`
* `-h`, `--help` — Print help
* `-V`, `--version` — Print version



"
    );
}