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

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

#[cfg(feature = "main")]
#[cfg_attr(docsrs, doc(cfg(feature = "main")))]
mod main;

/// Command line interface definition for cargo xtask command.
#[cfg_attr(doc, doc = include_str!("../doc/cargo-xtask.md"))]
///
/// # Examples
///
/// Use the premade entry point function with default configuration (`main`
/// feature is required):
///
/// ```rust
/// # #[cfg(feature = "main")]
/// # {
/// use cli_xtask::{Result, Xtask};
///
/// fn main() -> Result<()> {
///     <Xtask>::main()
/// }
/// # }
/// ```
///
/// Use the premade entry point function and custom configuration (`main`
/// feature is required):
///
/// ```rust
/// # #[cfg(feature = "main")]
/// # {
/// use cli_xtask::{config::Config, Result, Xtask};
///
/// fn main() -> Result<()> {
///     <Xtask>::main_with_config(|| Ok(Config::new()))
/// }
/// # }
/// ```
///
/// If you don't want to use the `main` feature, write the main function as
/// follows:
///
/// ```rust
/// # #[cfg(all(feature = "error-handler", feature = "logger"))]
/// # {
/// use cli_xtask::{clap::Parser, config::Config, error_handler, logger, Result, Xtask};
///
/// fn main() -> Result<()> {
///     // Parse command line arguments
///     let command = <Xtask>::parse();
///
///     // Setup error handler and logger
///     error_handler::install()?; // `error-handler` feature is required
///     logger::install(command.verbosity.get())?; // `logger` feature is required
///
///     // Run the subcommand specified by the command line arguments
///     command.run(&Config::new())?;
///
///     Ok(())
/// }
/// # }
/// ```
///
/// If you want to define your own subcommands, declare the type that implements
/// [`clap::Subcommand`] and [`Run`], then use `Xtask<YourOwnSubcommand>`
/// instead of `Xtask`.
///
/// ```rust
/// # #[cfg(feature = "main")]
/// # {
/// use cli_xtask::{
///     clap::{self, Parser},
///     config::Config,
///     subcommand, Result, Run, Xtask,
/// };
///
/// // Define your own subcommand arguments
/// #[derive(Debug, clap::Subcommand)]
/// enum YourOwnSubcommand {
///     #[clap(flatten)]
///     Predefined(subcommand::Subcommand),
///     /// Run foo function.
///     Foo,
///     /// Run bar function
///     Bar,
/// }
///
/// impl Run for YourOwnSubcommand {
///     fn run(&self, config: &Config) -> Result<()> {
///         match self {
///             Self::Predefined(subcommand) => subcommand.run(config)?,
///             Self::Foo => println!("foo!"),
///             Self::Bar => println!("bar!"),
///         }
///         Ok(())
///     }
///
///     fn into_any(self: Box<Self>) -> Box<dyn std::any::Any> {
///         self
///     }
///
///     fn as_any(&self) -> &dyn std::any::Any {
///         self
///     }
///
///     fn as_any_mut(&mut self) -> &mut dyn std::any::Any {
///         self
///     }
/// }
///
/// fn main() -> Result<()> {
///     Xtask::<YourOwnSubcommand>::main()
/// }
/// # }
/// ```
#[derive(Debug, Clone, Default, clap::Parser)]
#[non_exhaustive]
#[clap(bin_name = "cargo xtask", about = "Rust project automation command", long_about = None)]
pub struct Xtask<Subcommand = crate::subcommand::Subcommand>
where
    Subcommand: clap::Subcommand,
{
    /// Verbosity level
    #[clap(flatten)]
    pub verbosity: Verbosity,

    /// Subcommand to run
    #[clap(subcommand)]
    pub subcommand: Option<Subcommand>,
}

impl<Subcommand> Xtask<Subcommand>
where
    Subcommand: clap::Subcommand,
{
    /// Runs the subcommand specified by the command line arguments.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # #[cfg(all(feature = "error-handler", feature = "logger"))]
    /// # {
    /// use cli_xtask::{clap::Parser, config::Config, error_handler, logger, Result, Xtask};
    ///
    /// fn main() -> Result<()> {
    ///     // Parse command line arguments
    ///     let command = <Xtask>::parse();
    ///
    ///     // Setup error handler and logger
    ///     error_handler::install()?; // `error-handler` feature is required
    ///     logger::install(command.verbosity.get())?; // `logger` feature is required
    ///
    ///     // Run the subcommand specified by the command line arguments
    ///     command.run(&Config::new())?;
    ///
    ///     Ok(())
    /// }
    /// # }
    /// ```
    pub fn run(&self, config: &Config) -> Result<()>
    where
        Subcommand: Run,
    {
        let _config = config; // suppress unused-var warnings

        match &self.subcommand {
            Some(command) => command.run(config)?,
            None => <Self as clap::CommandFactory>::command().print_help()?,
        }

        Ok(())
    }
}