clap_doc_generator 0.2.2

Automatically generate CLI documentation from clap definitions and update readme files
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

use std::process::Command;

#[test]
fn clippy_passes_for_all_feature_combinations() {
    let features: Vec<String> = read_feature_names();
    let combinations = combinations(&features);

    for combination in &combinations {
        let feature_str = combination.join(",");

        let output = Command::new("cargo")
            .args([
                "clippy",
                "--no-default-features",
                "--features",
                &feature_str,
                "--",
                "-D",
                "warnings",
            ])
            .output()
            .expect("failed to execute cargo clippy");

        let stderr = String::from_utf8_lossy(&output.stderr);

        assert!(
            output.status.success(),
            "clippy failed for features [{}]:\n{}",
            feature_str,
            stderr,
        );
    }
}

fn read_feature_names() -> Vec<String> {
    let manifest_dir = env!("CARGO_MANIFEST_DIR");
    let cargo_toml_path = format!("{manifest_dir}/Cargo.toml");
    let content = std::fs::read_to_string(&cargo_toml_path).expect("failed to read Cargo.toml");

    let parsed: toml::Table = toml::from_str(&content).expect("failed to parse Cargo.toml");

    parsed
        .get("features")
        .and_then(|f| f.as_table())
        .map(|table| {
            table
                .keys()
                .filter(|key| *key != "default")
                .cloned()
                .collect()
        })
        .unwrap_or_default()
}

fn combinations(items: &[String]) -> Vec<Vec<String>> {
    let count = 1_usize << items.len();
    let mut result = Vec::with_capacity(count - 1);

    for mask in 1..count {
        let mut subset = Vec::new();
        for (index, item) in items.iter().enumerate() {
            if mask & (1 << index) != 0 {
                subset.push(item.clone());
            }
        }
        result.push(subset);
    }

    result
}