cli_xtask/subcommand/
doc.rs

1use std::process::Command;
2
3use crate::{
4    args::{EnvArgs, PackageArgs},
5    config::Config,
6    process::CommandExt,
7    Result, Run,
8};
9
10/// Arguments definition of the `doc` subcommand.
11#[cfg_attr(doc, doc = include_str!("../../doc/cargo-xtask-doc.md"))]
12#[derive(Debug, Clone, Default, clap::Args)]
13#[non_exhaustive]
14pub struct Doc {
15    /// Environment variables to set for `cargo doc`.
16    #[clap(flatten)]
17    pub env_args: EnvArgs,
18    /// Packages to run the `cargo doc` with.
19    #[clap(flatten)]
20    pub package_args: PackageArgs,
21    /// Options to pass to the `cargo doc`.
22    pub extra_options: Vec<String>,
23}
24
25impl Run for Doc {
26    fn run(&self, config: &Config) -> Result<()> {
27        self.run(config)
28    }
29}
30
31impl Doc {
32    /// Runs the `doc` subcommand.
33    #[tracing::instrument(name = "doc", skip_all, err)]
34    pub fn run(&self, _config: &Config) -> Result<()> {
35        let Self {
36            env_args,
37            package_args,
38            extra_options,
39        } = self;
40
41        for res in package_args.packages() {
42            let (workspace, package) = res?;
43            // cargo doc --package <pkg> <features> <extra_options>
44            Command::new("cargo")
45                .args(["doc", "--package", &package.name, "--all-features"])
46                .args(extra_options)
47                .envs(env_args.env.clone())
48                .workspace_spawn(workspace)?;
49        }
50
51        Ok(())
52    }
53}
cli_xtask/subcommand/doc.rs

cli_xtask/subcommand/
doc.rs
