cli_xtask/subcommand/
dist_build_doc.rs

1use eyre::eyre;
2
3use crate::{config::Config, fs::ToRelative, Result, Run};
4
5/// Arguments definition of the `dist-build-doc` subcommand.
6#[cfg_attr(doc, doc = include_str!("../../doc/cargo-xtask-dist-build-doc.md"))]
7#[derive(Debug, Clone, Default, clap::Args)]
8#[non_exhaustive]
9pub struct DistBuildDoc {}
10
11impl Run for DistBuildDoc {
12    fn run(&self, config: &Config) -> Result<()> {
13        self.run(config)
14    }
15}
16
17impl DistBuildDoc {
18    /// Runs the `dist-build-doc` subcommand.
19    #[tracing::instrument(name = "dist-build-doc", skip_all, err)]
20    pub fn run(&self, config: &Config) -> Result<()> {
21        tracing::info!("Building documents...");
22
23        let Self {} = self;
24        let config = config.dist()?;
25
26        let packages = config.packages();
27
28        let working_dir = config.dist_working_directory(None);
29        let doc_dir = working_dir.join("doc");
30        let add_package_dir = packages.len() > 1;
31        crate::fs::remove_dir(&doc_dir)?;
32
33        let Self {} = self;
34
35        for package in packages {
36            let dest_dir = if add_package_dir {
37                doc_dir.join(package.name())
38            } else {
39                doc_dir.clone()
40            };
41
42            for src_file in package.documents() {
43                let file_name = src_file.file_name().ok_or_else(|| {
44                    eyre!("document file has no name: {}", src_file.to_relative())
45                })?;
46                let dest_file = dest_dir.join(file_name);
47                crate::fs::copy(src_file, dest_file)?;
48            }
49        }
50
51        Ok(())
52    }
53}