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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
//! Command line interfaces for xtask workflows.

use std::any::Any;

use crate::{config::Config, Result, Run};

#[cfg(feature = "subcommand-build")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-build")))]
mod build;
#[cfg(feature = "subcommand-build")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-build")))]
pub use self::build::Build;

#[cfg(feature = "subcommand-clippy")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-clippy")))]
mod clippy;
#[cfg(feature = "subcommand-clippy")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-clippy")))]
pub use self::clippy::Clippy;

#[cfg(feature = "subcommand-dist-archive")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-archive")))]
mod dist_archive;
#[cfg(feature = "subcommand-dist-archive")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-archive")))]
pub use self::dist_archive::DistArchive;

#[cfg(subcommand_dist_build)]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-*")))]
mod dist_build;
#[cfg(subcommand_dist_build)]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-*")))]
pub use self::dist_build::DistBuild;

#[cfg(feature = "subcommand-dist-build-bin")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-bin")))]
mod dist_build_bin;
#[cfg(feature = "subcommand-dist-build-bin")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-bin")))]
pub use self::dist_build_bin::DistBuildBin;

#[cfg(feature = "subcommand-dist-build-completion")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-completion")))]
mod dist_build_completion;
#[cfg(feature = "subcommand-dist-build-completion")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-completion")))]
pub use self::dist_build_completion::DistBuildCompletion;

#[cfg(feature = "subcommand-dist-build-doc")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-doc")))]
mod dist_build_doc;
#[cfg(feature = "subcommand-dist-build-doc")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-doc")))]
pub use self::dist_build_doc::DistBuildDoc;

#[cfg(feature = "subcommand-dist-build-license")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-license")))]
mod dist_build_license;
#[cfg(feature = "subcommand-dist-build-license")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-license")))]
pub use self::dist_build_license::DistBuildLicense;

#[cfg(feature = "subcommand-dist-build-man")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-man")))]
mod dist_build_man;
#[cfg(feature = "subcommand-dist-build-man")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-man")))]
pub use self::dist_build_man::DistBuildMan;

#[cfg(feature = "subcommand-dist-build-readme")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-readme")))]
mod dist_build_readme;
#[cfg(feature = "subcommand-dist-build-readme")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-readme")))]
pub use self::dist_build_readme::DistBuildReadme;

#[cfg(feature = "subcommand-dist-clean")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-clean")))]
mod dist_clean;
#[cfg(feature = "subcommand-dist-clean")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-clean")))]
pub use self::dist_clean::DistClean;

#[cfg(feature = "subcommand-dist")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist")))]
mod dist;
#[cfg(feature = "subcommand-dist")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist")))]
pub use self::dist::Dist;

#[cfg(feature = "subcommand-exec")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-exec")))]
mod exec;
#[cfg(feature = "subcommand-exec")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-exec")))]
pub use self::exec::Exec;

#[cfg(feature = "subcommand-doc")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-doc")))]
mod doc;
#[cfg(feature = "subcommand-doc")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-doc")))]
pub use self::doc::Doc;

#[cfg(feature = "subcommand-docsrs")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-docsrs")))]
mod docsrs;
#[cfg(feature = "subcommand-docsrs")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-docsrs")))]
pub use self::docsrs::Docsrs;

#[cfg(feature = "subcommand-fmt")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-fmt")))]
mod fmt;
#[cfg(feature = "subcommand-fmt")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-fmt")))]
pub use self::fmt::Fmt;

#[cfg(feature = "subcommand-lint")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-lint")))]
mod lint;
#[cfg(feature = "subcommand-lint")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-lint")))]
pub use self::lint::Lint;

#[cfg(feature = "subcommand-pre-release")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-pre-release")))]
mod pre_release;
#[cfg(feature = "subcommand-pre-release")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-pre-release")))]
pub use self::pre_release::PreRelease;

#[cfg(feature = "subcommand-sync-rdme")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-sync-rdme")))]
mod sync_rdme;
#[cfg(feature = "subcommand-sync-rdme")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-sync-rdme")))]
pub use self::sync_rdme::SyncRdme;

#[cfg(feature = "subcommand-test")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-test")))]
mod test;
#[cfg(feature = "subcommand-test")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-test")))]
pub use self::test::Test;

#[cfg(feature = "subcommand-tidy")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-tidy")))]
mod tidy;
#[cfg(feature = "subcommand-tidy")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-tidy")))]
pub use self::tidy::Tidy;

#[cfg(feature = "subcommand-udeps")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-udeps")))]
mod udeps;
#[cfg(feature = "subcommand-udeps")]
#[cfg_attr(docsrs, doc(cfg(feature = "subcommand-udeps")))]
pub use self::udeps::Udeps;

/// Subcommand definition for cargo xtask command.
#[cfg_attr(doc, doc = include_str!("../doc/cargo-xtask.md"))]
///
/// # Examples
///
/// You can use this struct to define a subcommand of your application:
///
/// ```rust
/// use cli_xtask::{clap, config::Config, subcommand::Subcommand, Result};
///
/// #[derive(Debug, clap::Parser)]
/// struct App {
///     #[clap(subcommand)]
///     subcommand: Subcommand,
/// }
///
/// impl App {
///     pub fn run(&self, config: &Config) -> Result<()> {
///         self.subcommand.run(config)
///     }
/// }
/// ```
///
/// You can mix the subcommands defined in this enum with your own subcommands:
///
/// ```rust
/// use cli_xtask::{clap, config::Config, Result};
///
/// #[derive(Debug, clap::Parser)]
/// struct App {
///     #[clap(subcommand)]
///     subcommand: YourOwnSubcommand,
/// }
///
/// #[derive(Debug, clap::Subcommand)]
/// enum YourOwnSubcommand {
///     #[clap(flatten)]
///     Predefined(cli_xtask::subcommand::Subcommand),
///     Foo,
///     Bar,
/// }
/// ```
#[derive(Debug, clap::Subcommand)]
#[clap(bin_name = "cargo xtask", about = "Rust project automation command", long_about = None)]
#[non_exhaustive]
pub enum Subcommand {
    /// `cargo build` with options useful for testing and continuous
    /// integration.
    #[cfg(feature = "subcommand-build")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-build")))]
    Build(Build),

    /// `cargo clippy` with options useful for tesing and continuous
    /// integration.
    #[cfg(feature = "subcommand-clippy")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-clippy")))]
    Clippy(Clippy),

    /// Build the artifacs and create the archive file for distribution.
    #[cfg(feature = "subcommand-dist")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist")))]
    Dist(Dist),

    /// Create the archive file for distribution.
    #[cfg(feature = "subcommand-dist-archive")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-archive")))]
    DistArchive(DistArchive),

    /// Build all artifacts for distribution.
    #[cfg(subcommand_dist_build)]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-*")))]
    DistBuild(DistBuild),

    /// Build the release binaries for distribution.
    #[cfg(feature = "subcommand-dist-build-bin")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-bin")))]
    DistBuildBin(DistBuildBin),

    /// Build the shell completion files for distribution.
    #[cfg(feature = "subcommand-dist-build-completion")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-completion")))]
    DistBuildCompletion(DistBuildCompletion),

    /// Build the documentation for distribution.
    #[cfg(feature = "subcommand-dist-build-doc")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-doc")))]
    DistBuildDoc(DistBuildDoc),

    /// Build the license files for distribution.
    #[cfg(feature = "subcommand-dist-build-license")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-license")))]
    DistBuildLicense(DistBuildLicense),

    /// Build the man pages for distribution.
    #[cfg(feature = "subcommand-dist-build-man")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-man")))]
    DistBuildMan(DistBuildMan),

    /// Build the readme files for distribution.
    #[cfg(feature = "subcommand-dist-build-readme")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-build-readme")))]
    DistBuildReadme(DistBuildReadme),

    /// Remove the artifacts and archives for distribution.
    #[cfg(feature = "subcommand-dist-clean")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-dist-clean")))]
    DistClean(DistClean),

    /// `cargo doc` with options useful for testing and continuous integration.
    #[cfg(feature = "subcommand-doc")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-doc")))]
    Doc(Doc),

    /// `cargo doc` with docs.rs specific options.
    #[cfg(feature = "subcommand-docsrs")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-docsrs")))]
    Docsrs(Docsrs),

    /// Run commands on all workspaces in the current directory and
    /// subdirectories.
    #[cfg(feature = "subcommand-exec")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-exec")))]
    Exec(Exec),

    /// `cargo fmt` with options useful for testing and continuous integration.
    #[cfg(feature = "subcommand-fmt")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-fmt")))]
    Fmt(Fmt),

    /// Run lint commands at once.
    #[cfg(feature = "subcommand-lint")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-lint")))]
    Lint(Lint),

    /// Run pre-release checks.
    #[cfg(feature = "subcommand-pre-release")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-pre-release")))]
    PreRelease(PreRelease),

    /// `cargo sync-rdme` with options useful for testing and continuous
    /// integration.
    #[cfg(feature = "subcommand-sync-rdme")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-syncrdme")))]
    SyncRdme(sync_rdme::SyncRdme),

    /// `cargo test` with options useful for testing and continuous integration.
    #[cfg(feature = "subcommand-test")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-test")))]
    Test(Test),

    /// Fix the package problems.
    #[cfg(feature = "subcommand-tidy")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-tidy")))]
    Tidy(Tidy),

    /// `cargo udeps` with options useful for testing and continuous
    /// integration.
    #[cfg(feature = "subcommand-udeps")]
    #[cfg_attr(docsrs, doc(cfg(feature = "subcommand-udeps")))]
    Udeps(Udeps),
}

impl Run for Subcommand {
    fn run(&self, config: &Config) -> Result<()> {
        self.run(config)
    }

    fn into_any(self: Box<Self>) -> Box<dyn Any> {
        self
    }

    fn as_any(&self) -> &dyn Any {
        self
    }

    fn as_any_mut(&mut self) -> &mut dyn Any {
        self
    }
}

impl Subcommand {
    /// Returns the selected subcommand.
    pub fn selected(&self) -> &dyn Run {
        match self {
            #[cfg(feature = "subcommand-build")]
            Self::Build(args) => args,

            #[cfg(feature = "subcommand-clippy")]
            Self::Clippy(args) => args,

            #[cfg(feature = "subcommand-dist")]
            Self::Dist(args) => args,

            #[cfg(feature = "subcommand-dist-archive")]
            Self::DistArchive(args) => args,

            #[cfg(subcommand_dist_build)]
            Self::DistBuild(args) => args,

            #[cfg(feature = "subcommand-dist-build-bin")]
            Self::DistBuildBin(args) => args,

            #[cfg(feature = "subcommand-dist-build-completion")]
            Self::DistBuildCompletion(args) => args,

            #[cfg(feature = "subcommand-dist-build-doc")]
            Self::DistBuildDoc(args) => args,

            #[cfg(feature = "subcommand-dist-build-license")]
            Self::DistBuildLicense(args) => args,

            #[cfg(feature = "subcommand-dist-build-man")]
            Self::DistBuildMan(args) => args,

            #[cfg(feature = "subcommand-dist-build-readme")]
            Self::DistBuildReadme(args) => args,

            #[cfg(feature = "subcommand-dist-clean")]
            Self::DistClean(args) => args,

            #[cfg(feature = "subcommand-doc")]
            Self::Doc(args) => args,

            #[cfg(feature = "subcommand-docsrs")]
            Self::Docsrs(args) => args,

            #[cfg(feature = "subcommand-exec")]
            Self::Exec(args) => args,

            #[cfg(feature = "subcommand-fmt")]
            Self::Fmt(args) => args,

            #[cfg(feature = "subcommand-lint")]
            Self::Lint(args) => args,

            #[cfg(feature = "subcommand-pre-release")]
            Self::PreRelease(args) => args,

            #[cfg(feature = "subcommand-sync-rdme")]
            Self::SyncRdme(args) => args,

            #[cfg(feature = "subcommand-test")]
            Self::Test(args) => args,

            #[cfg(feature = "subcommand-tidy")]
            Self::Tidy(args) => args,

            #[cfg(feature = "subcommand-udeps")]
            Self::Udeps(args) => args,

            #[cfg(not(subcommand))]
            _ => unreachable!("no commands defined: {self:?}"),
        }
    }

    /// Runs the subcommand specified by the command line arguments.
    pub fn run(&self, config: &Config) -> Result<()> {
        self.selected().run(config)
    }
}