anza-xtask 0.2.0

Blockchain, Rebuilt for Scale
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

use {
    anyhow::{Context, Result},
    clap::Subcommand,
    log::{error, warn},
    std::{
        collections::HashMap,
        fs,
        path::{Path, PathBuf},
    },
    toml_edit::DocumentMut,
};

#[derive(clap::Args, Debug)]
pub struct CommandArgs {
    #[command(subcommand)]
    command: DevDepsCommands,
}

#[derive(Subcommand, Debug)]
enum DevDepsCommands {
    #[command(about = "Check dev-dependencies for workspace members using 'workspace = true'")]
    Check(CheckArgs),
}

#[derive(clap::Args, Debug)]
pub struct CheckArgs {
    /// Path to the workspace Cargo.toml (defaults to ./Cargo.toml)
    #[arg(long, default_value = "Cargo.toml")]
    pub manifest_path: PathBuf,
}

pub fn run(args: CommandArgs) -> Result<()> {
    match args.command {
        DevDepsCommands::Check(check_args) => run_check(check_args),
    }
}

fn run_check(args: CheckArgs) -> Result<()> {
    let workspace_root = args
        .manifest_path
        .parent()
        .unwrap_or_else(|| Path::new("."));

    // 1. Parse workspace Cargo.toml to get members
    let workspace_toml_content = fs::read_to_string(&args.manifest_path)
        .with_context(|| format!("Failed to read {:?}", args.manifest_path))?;
    let workspace_doc = workspace_toml_content
        .parse::<DocumentMut>()
        .with_context(|| format!("Failed to parse {:?}", args.manifest_path))?;

    let members = workspace_doc
        .get("workspace")
        .and_then(|ws| ws.get("members"))
        .and_then(|m| m.as_array())
        .context("No workspace.members found")?;

    // 2. Build map of package names -> member paths
    let mut package_to_member = HashMap::new();
    for member in members.iter() {
        let member_path = member.as_str().context("Member path is not a string")?;
        let member_cargo_toml = workspace_root.join(member_path).join("Cargo.toml");

        if !member_cargo_toml.exists() {
            warn!("(Skipping) {member_path}/Cargo.toml not found");
            continue;
        }

        let content = fs::read_to_string(&member_cargo_toml)?;
        let doc = content.parse::<DocumentMut>()?;

        if let Some(package_name) = doc
            .get("package")
            .and_then(|p| p.get("name"))
            .and_then(|n| n.as_str())
        {
            package_to_member.insert(package_name.to_string(), member_path);
        }
    }

    // 3. Check each member's dev-dependencies
    let mut total_issues = 0;
    for member in members.iter() {
        let member_path = member.as_str().context("Member path is not a string")?;
        let member_cargo_toml = workspace_root.join(member_path).join("Cargo.toml");

        if !member_cargo_toml.exists() {
            continue;
        }

        let content = fs::read_to_string(&member_cargo_toml)?;
        let doc = content.parse::<DocumentMut>()?;

        if let Some(dev_deps) = doc.get("dev-dependencies").and_then(|dd| dd.as_table()) {
            for (dep_name, dep_value) in dev_deps.iter() {
                // Check if this dependency uses workspace = true
                if let Some(table) = dep_value.as_table_like() {
                    if table
                        .get("workspace")
                        .and_then(|w| w.as_bool())
                        .unwrap_or(false)
                    {
                        // Check if this is a workspace member
                        if package_to_member.contains_key(dep_name) {
                            error!(
                                "{}/Cargo.toml - `{}` in dev-dependencies should use path = \"...\"",
                                member_path, dep_name
                            );
                            total_issues += 1;
                        }
                    }
                }
            }
        }
    }

    if total_issues == 0 {
        Ok(())
    } else {
        anyhow::bail!(
            "Found {} dev-dependencies using 'workspace = true' that should use path",
            total_issues
        )
    }
}