feature-manifest 0.7.1

Document, validate, and render Cargo feature metadata.
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

use std::path::PathBuf;

use anyhow::{Result, bail};

use crate::{
    InjectionMarkers, WorkspaceManifest, inject_between_markers, injected_region_matches,
    output_matches, render_markdown, write_output,
};

pub fn run(
    workspace: &WorkspaceManifest,
    include_private: bool,
    write: Option<PathBuf>,
    insert_into: Option<PathBuf>,
    check: bool,
    markers: InjectionMarkers,
) -> Result<()> {
    let markdown = render_markdown(workspace, include_private);

    if check {
        return check_outputs(&markdown, write, insert_into, &markers);
    }

    let mut wrote_somewhere = false;

    if let Some(path) = write {
        write_output(&path, &markdown)?;
        println!("wrote Markdown to `{}`", path.display());
        wrote_somewhere = true;
    }

    if let Some(path) = insert_into {
        inject_between_markers(&path, &markdown, &markers)?;
        println!("injected Markdown into `{}`", path.display());
        wrote_somewhere = true;
    }

    if !wrote_somewhere {
        println!("{markdown}");
    }

    Ok(())
}

fn check_outputs(
    markdown: &str,
    write: Option<PathBuf>,
    insert_into: Option<PathBuf>,
    markers: &InjectionMarkers,
) -> Result<()> {
    if write.is_none() && insert_into.is_none() {
        bail!("`md --check` requires `--write <PATH>` or `--insert-into <PATH>`");
    }

    let mut stale = Vec::new();

    if let Some(path) = write {
        if output_matches(&path, markdown)? {
            println!("`{}` is up to date", path.display());
        } else {
            println!("`{}` is stale", path.display());
            stale.push(path);
        }
    }

    if let Some(path) = insert_into {
        if injected_region_matches(&path, markdown, markers)? {
            println!("`{}` injected region is up to date", path.display());
        } else {
            println!("`{}` injected region is stale", path.display());
            stale.push(path);
        }
    }

    if !stale.is_empty() {
        bail!("generated Markdown is stale");
    }

    Ok(())
}