cargo-matrix 0.4.0

Run feature matrices against cargo commands that support feature lists
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

// Copyright (c) 2024 cargo-matrix developers
//
// Licensed under the Apache License, Version 2.0
// <LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0> or the MIT
// license <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
// option. All files in the project carrying such notice may not be copied,
// modified, or distributed except according to those terms.

use clap::{Args, Parser, Subcommand, crate_authors, crate_description, crate_version};
use getset::Getters;
use std::path::PathBuf;

#[derive(Debug, Parser)]
#[command(name = "cargo")]
#[command(bin_name = "cargo")]
pub(crate) enum Cargo {
    Matrix(MatrixArgs),
}

#[derive(Args, Debug, Getters)]
#[clap(
    author = crate_authors!(),
    version = crate_version!(),
    about = crate_description!(),
)]
#[command(version, about, long_about = None)]
#[getset(get = "pub(crate)")]
pub(crate) struct MatrixArgs {
    /// Choose the channel you wish to pull your config from
    #[clap(long, short)]
    channel: Option<String>,

    /// Perform a dry run and print output as if all the jobs succeeded.
    #[clap(long)]
    dry_run: bool,

    /// Specify an explict path to the manifest file
    #[arg(long)]
    manifest_path: Option<PathBuf>,

    /// Specify a specific package to run matrix against
    #[arg(long, short)]
    package: Option<String>,

    /// Split the workspace packages into 'n' chunks of packages
    #[arg(
        long,
        default_value_t = 1,
        requires = "chunk",
        help = "Split the workspace into n chunks, each chunk containing a roughly equal number of crates"
    )]
    num_chunks: usize,

    /// The chunk number to test, i.e. if `num_chunks` = 4, chunks can be 1, 2, 3, or 4.
    #[arg(
        long,
        default_value_t = 1,
        requires = "num_chunks",
        help = "Which chunk to test, indexed at 1"
    )]
    chunk: usize,

    /// The supported cargo subcomand to run
    #[command(subcommand)]
    command: CargoSubcommands,
}

#[derive(Debug, Subcommand)]
pub(crate) enum CargoSubcommands {
    /// cargo build
    Build(VarArgs),
    /// cargo check
    Check(VarArgs),
    /// cargo clippy
    Clippy(VarArgs),
    /// cargo test
    Test(VarArgs),
    /// cargo llvm-cov
    LlvmCov(VarArgs),
}

#[derive(Args, Debug, Getters)]
#[getset(get = "pub(crate)")]
pub(crate) struct VarArgs {
    /// Arguments to pass to the cargo command
    #[clap(trailing_var_arg = true, allow_hyphen_values = true)]
    args: Vec<String>,
}