licenses 0.6.0

Cargo subcommand for collecting licenses.
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
125
126
127
128
129
130
131
132
133
134

use crate::cargo_metadata::{filtered_packages, try_get_packages};
use crate::cargo_tree::crate_names;
use crate::config::load_config;
use crate::file_io::FileSystem;
use crate::licenses::subcommand;
use clap::{Args, Parser, Subcommand};
use serde::Deserialize;
use std::path::PathBuf;

mod cargo_metadata;
mod cargo_tree;
mod config;
mod file_io;
mod licenses;
mod log;

fn main() -> anyhow::Result<()> {
    let CargoSubcommand::Licenses { args, command } = CargoSubcommand::parse();

    let file_system = FileSystem {};
    let config = load_config(&file_system, args)?;
    let filtered_packages = filtered_packages(try_get_packages()?, &crate_names(&config)?);

    match command {
        LicensesSubcommand::Collect { path } => {
            subcommand::collect(&file_system, &config, &filtered_packages, path)?;
        }
        LicensesSubcommand::Summary(args) => {
            subcommand::summary(filtered_packages, &args)?;
        }
        LicensesSubcommand::Check => {
            subcommand::check(&file_system, &config, &filtered_packages)?;
        }
        LicensesSubcommand::Diff { path } => {
            subcommand::diff(&file_system, &config, &filtered_packages, path)?;
        }
    }

    Ok(())
}

#[derive(Parser)]
#[command(bin_name = "cargo", disable_help_subcommand = true)]
enum CargoSubcommand {
    #[command(
        name = "licenses",
        version,
        author,
        disable_version_flag = true,
        override_usage = "cargo licenses <COMMAND> [OPTIONS]"
    )]
    Licenses {
        #[command(flatten)]
        args: GlobalArgs,

        #[command(subcommand)]
        command: LicensesSubcommand,
    },
}

#[derive(Debug, Args, Deserialize, PartialEq, Eq, Default, Clone)]
#[serde(default, deny_unknown_fields)]
#[allow(clippy::struct_excessive_bools)]
pub struct GlobalArgs {
    /// Include dev dependencies [default: excluded]
    #[arg(short, long, global = true)]
    dev: bool,

    /// Include build dependencies [default: excluded]
    #[arg(short, long, global = true)]
    build: bool,

    /// The depth of dependencies to include [default: all sub dependencies]
    #[arg(short = 'D', long, global = true)]
    depth: Option<u8>,

    /// Activate all features [default: default features]
    #[arg(long, global = true)]
    #[serde(rename = "all-features")]
    all_features: bool,

    /// Do not activate default features [default: default features]
    #[arg(long, global = true)]
    #[serde(rename = "no-default-features")]
    no_default_features: bool,

    /// Enable specified feature [default: default features]
    #[arg(short = 'F', long, value_name = "FEATURE", global = true)]
    feature: Vec<String>,

    /// Exclude specified workspace [default: all included]
    #[arg(short, long, value_name = "WORKSPACE", global = true)]
    exclude: Vec<String>,

    /// Ignore specified crate [default: all included]
    #[arg(short, long, value_name = "CRATE", global = true)]
    ignore: Vec<String>,

    /// Path to configuration file
    #[arg(short, long, value_name = "PATH", global = true)]
    #[serde(skip)]
    config: Option<PathBuf>,
}

#[derive(Subcommand)]
enum LicensesSubcommand {
    /// Collects all licenses into a folder
    Collect {
        /// The output license folder path
        #[arg(short, long, default_value_t = String::from("licenses"))]
        path: String,
    },
    /// Provides a summary of all licenses
    Summary(SummaryArgs),
    /// Checks all licenses for inconsistencies
    Check,
    /// Diff between the current licenses folder and the licenses that would be collected
    Diff {
        /// The current licenses folder path
        #[arg(short, long, default_value_t = String::from("licenses"))]
        path: String,
    },
}

#[derive(Args)]
#[group(required = false, multiple = false)]
struct SummaryArgs {
    /// Display the summary as JSON
    #[arg(long)]
    json: bool,
    /// Display the summary as TOML
    #[arg(long)]
    toml: bool,
}