cargo-sync-rdme 0.8.0

Cargo subcommand to synchronize README with crate 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

//! Integration test for workspace-level metadata configuration.

use std::fs;

use indoc::formatdoc;
use similar_asserts::assert_eq;
use test_helper::{self as helper, Workspace};

#[test]
fn workspace_metadata_applies_to_package_and_resolves_relative_extra_targets() {
    let fixture_name = "workspace_metadata";
    let workspace = Workspace::from_fixture(fixture_name);

    workspace
        .cargo_sync_rdme_default()
        .args(["-p", "pkg-a"])
        .assert()
        .success();

    let workspace_dir = workspace.root_path();
    let fixture_dir = helper::package_fixtures_dir().join(fixture_name);

    for (relative_path, title) in [
        ("pkg-a/docs/package.md", "`pkg-a` Extra"),
        ("pkg-a/README.md", "`pkg-a`"),
    ] {
        assert_eq!(
            fs::read_to_string(workspace_dir.join(relative_path)).unwrap(),
            formatdoc! {r"
                # {title}

                <!-- cargo-sync-rdme badge [[ -->
                [![crates.io](https://img.shields.io/crates/v/pkg-a.svg?logo=rust&style=for-the-badge)](https://crates.io/crates/pkg-a)
                <!-- cargo-sync-rdme ]] -->
            "},
            "content mismatch: {relative_path}",
        );
    }

    for relative_path in ["docs/workspace.md", "pkg-b/README.md", "README.md"] {
        assert_eq!(
            fs::read_to_string(workspace_dir.join(relative_path)).unwrap(),
            fs::read_to_string(fixture_dir.join(relative_path)).unwrap(),
            "content mismatch: {relative_path}",
        );
    }
}