cli_xtask/subcommand/
lint.rs

1use crate::{args::FeatureArgs, config::Config, Result, Run, SubcommandRun};
2
3/// Arguments definition of the `lint` subcommand.
4#[cfg_attr(doc, doc = include_str!("../../doc/cargo-xtask-lint.md"))]
5#[derive(Debug, Clone, Default, clap::Args)]
6#[non_exhaustive]
7pub struct Lint {
8    /// Features to run the cargo commands with
9    #[clap(flatten)]
10    pub feature_args: FeatureArgs,
11}
12
13impl Run for Lint {
14    fn run(&self, config: &Config) -> Result<()> {
15        self.run(config)
16    }
17
18    fn to_subcommands(&self) -> Option<SubcommandRun> {
19        Some(self.to_subcommands())
20    }
21}
22
23impl Lint {
24    /// Returns a list of all subcommands to run.
25    pub fn subcommands(&self) -> Vec<Box<dyn Run>> {
26        let Self { feature_args } = self;
27        let _ = feature_args.clone(); // supress unused-variables warning
28
29        vec![
30            // cargo fmt --check
31            #[cfg(feature = "subcommand-fmt")]
32            Box::new(super::Fmt {
33                env_args: Default::default(),
34                package_args: feature_args.package_args.clone(),
35                extra_options: ["--check"].into_iter().map(String::from).collect(),
36            }),
37            // cargo clippy -- -D warnings
38            #[cfg(feature = "subcommand-clippy")]
39            Box::new(super::Clippy {
40                env_args: Default::default(),
41                feature_args: feature_args.clone(),
42                extra_options: ["--all-targets", "--", "-D", "warnings"]
43                    .into_iter()
44                    .map(String::from)
45                    .collect(),
46            }),
47            // RUSTDOCFLAGS="-D warnings" cargo doc
48            #[cfg(feature = "subcommand-doc")]
49            Box::new(super::Doc {
50                env_args: crate::args::EnvArgs::new([("RUSTDOCFLAGS", "-D warnings")]),
51                package_args: feature_args.package_args.clone(),
52                extra_options: ["--no-deps"].into_iter().map(String::from).collect(),
53            }),
54            #[cfg(feature = "subcommand-docsrs")]
55            Box::new(super::Docsrs {
56                env_args: crate::args::EnvArgs::new([("RUSTDOCFLAGS", "-D warnings")]),
57                package_args: feature_args.package_args.clone(),
58                default_target: false,
59                all_targets: false,
60                extra_options: vec![],
61            }),
62            // cargo sync-rdme --check
63            #[cfg(feature = "subcommand-sync-rdme")]
64            Box::new(super::SyncRdme {
65                env_args: Default::default(),
66                package_args: feature_args.package_args.clone(),
67                extra_options: ["--check"].into_iter().map(String::from).collect(),
68            }),
69            // cargo udeps
70            #[cfg(feature = "subcommand-udeps")]
71            Box::new(super::Udeps {
72                env_args: Default::default(),
73                feature_args: feature_args.clone(),
74                extra_options: vec![],
75            }),
76        ]
77    }
78
79    /// Returns the subcommands that this command will run.
80    pub fn to_subcommands(&self) -> SubcommandRun {
81        SubcommandRun::new(self.subcommands())
82    }
83
84    /// Runs the `lint` subcommand.
85    #[tracing::instrument(name = "lint", skip_all, err)]
86    pub fn run(&self, config: &Config) -> Result<()> {
87        self.to_subcommands().run(config)
88    }
89}