xtasks 0.0.2

Essential tools and tasks for Rust projects using the xtask pattern, simplifying common build and development workflows.
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

// Copyright © 2023 xtasks. All rights reserved.
// SPDX-License-Identifier: Apache-2.0 OR MIT

use anyhow::{Context, Result as AnyResult};
use duct::cmd;

use dtt::DateTime;
use rlg::{macro_log, LogFormat, LogLevel};
use vrd::Random;

/// Analyses the dependencies of the current project to find which ones contribute most to the build size.
///
/// # Parameters
///
/// * `package` - The name of the package to analyze.
///
/// # Errors
///
/// Returns an error if the `cargo bloat` command fails to execute. This could happen if the specified package
/// is not found, or if `cargo bloat` is not installed.
pub fn deps(package: &str) -> AnyResult<()> {
    let date = DateTime::new();
    let log = macro_log!(
        &Random::default().int(0, 1_000_000_000).to_string(),
        &date.iso_8601,
        &LogLevel::INFO,
        "Dependencies",
        "Starting dependency analysis",
        &LogFormat::CLF
    );
    drop(log);

    cmd!("cargo", "bloat", "-p", package, "--crates")
        .run()
        .map(|_| ())
        .map_err(|err| {
            // Log the error and then return it
            let log = macro_log!(
                &Random::default().int(0, 1_000_000_000).to_string(),
                &date.iso_8601,
                &LogLevel::ERROR,
                "Dependencies",
                "Dependency analysis failed",
                &LogFormat::CLF);
            drop(log);
            err
        })
        .with_context(|| format!("Failed to execute 'cargo bloat' for dependency analysis on package '{package}'"))?;
    let log = macro_log!(
        &Random::default().int(0, 1_000_000_000).to_string(),
        &date.iso_8601,
        &LogLevel::ERROR,
        "Dependencies",
        "Dependency analysis completed",
        &LogFormat::CLF
    );
    drop(log);
    Ok(())
}

/// Analyses the build times of dependencies in the current project.
///
/// # Parameters
///
/// * `package` - The name of the package to analyze.
///
/// # Errors
///
/// Returns an error if the `cargo bloat` command fails to execute. This could be due to a variety of reasons,
/// such as the package not being found, or `cargo bloat` not being installed.
pub fn time(package: &str) -> AnyResult<()> {
    let date = DateTime::new();
    let log = macro_log!(
        &Random::default().int(0, 1_000_000_000).to_string(),
        &date.iso_8601,
        &LogLevel::ERROR,
        "Time Analysis",
        "Starting build time analysis",
        &LogFormat::CLF
    );
    drop(log);

    cmd!("cargo", "bloat", "-p", package, "--time")
        .run()
        .map(|_| ())  // Convert Ok(Output) to Ok(())
        .map_err(|err| {
            // Log the error and then return it
            let log = macro_log!(
                &Random::default().int(0, 1_000_000_000).to_string(),
                &date.iso_8601,
                &LogLevel::ERROR,
                "Time Analysis",
                "Build time analysis failed",
                &LogFormat::CLF);
            drop(log);
            err
        })
        .with_context(|| format!("Failed to execute 'cargo bloat' for build time analysis on package '{package}'"))?;
    let log = macro_log!(
        &Random::default().int(0, 1_000_000_000).to_string(),
        &date.iso_8601,
        &LogLevel::ERROR,
        "Time Analysis",
        "Build time analysis completed",
        &LogFormat::CLF
    );
    drop(log);
    Ok(())
}