#
cargo/ops/
cargo_doc.rs

    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

    use crate::core::compiler::{Compilation, CompileKind};
    use crate::core::{shell::Verbosity, Shell, Workspace};
    use crate::ops;
    use crate::util::context::{GlobalContext, PathAndArgs};
    use crate::util::CargoResult;
    use anyhow::{bail, Error};
    use std::path::Path;
    use std::path::PathBuf;
    use std::process::Command;
    use std::str::FromStr;

    /// Format of rustdoc [`--output-format`][1].
    ///
    /// [1]: https://doc.rust-lang.org/nightly/rustdoc/unstable-features.html#-w--output-format-output-format
    #[derive(Debug, Default, Clone)]
    pub enum OutputFormat {
        #[default]
        Html,
        Json,
    }

    impl OutputFormat {
        pub const POSSIBLE_VALUES: [&'static str; 2] = ["html", "json"];
    }

    impl FromStr for OutputFormat {
        // bail! error instead of string error like impl FromStr for Edition {
        type Err = Error;

        fn from_str(s: &str) -> Result<Self, Self::Err> {
            match s {
                "json" => Ok(OutputFormat::Json),
                "html" => Ok(OutputFormat::Html),
                _ => bail!(
                    "supported values for --output-format are `json` and `html`, \
    						 but `{}` is unknown",
                    s
                ),
            }
        }
    }

    /// Strongly typed options for the `cargo doc` command.
    #[derive(Debug)]
    pub struct DocOptions {
        /// Whether to attempt to open the browser after compiling the docs
        pub open_result: bool,
        /// Same as `rustdoc --output-format`
        pub output_format: OutputFormat,
        /// Options to pass through to the compiler
        pub compile_opts: ops::CompileOptions,
    }

    /// Main method for `cargo doc`.
    pub fn doc(ws: &Workspace<'_>, options: &DocOptions) -> CargoResult<()> {
        let compilation = ops::compile(ws, &options.compile_opts)?;

        if options.open_result {
            let name = &compilation.root_crate_names.get(0).ok_or_else(|| {
                anyhow::anyhow!(
                    "cannot open specified crate's documentation: no documentation generated"
                )
            })?;
            let kind = options.compile_opts.build_config.single_requested_kind()?;

            let path = path_by_output_format(&compilation, &kind, &name, &options.output_format);

            if path.exists() {
                let config_browser = {
                    let cfg: Option<PathAndArgs> = ws.gctx().get("doc.browser")?;
                    cfg.map(|path_args| (path_args.path.resolve_program(ws.gctx()), path_args.args))
                };
                let mut shell = ws.gctx().shell();
                let link = shell.err_file_hyperlink(&path);
                shell.status("Opening", format!("{link}{}{link:#}", path.display()))?;
                open_docs(&path, &mut shell, config_browser, ws.gctx())?;
            }
        } else if ws.gctx().shell().verbosity() == Verbosity::Verbose {
            for name in &compilation.root_crate_names {
                for kind in &options.compile_opts.build_config.requested_kinds {
                    let path =
                        path_by_output_format(&compilation, &kind, &name, &options.output_format);
                    if path.exists() {
                        let mut shell = ws.gctx().shell();
                        let link = shell.err_file_hyperlink(&path);
                        shell.status("Generated", format!("{link}{}{link:#}", path.display()))?;
                    }
                }
            }
        } else {
            let mut output = compilation.root_crate_names.iter().flat_map(|name| {
                options
                    .compile_opts
                    .build_config
                    .requested_kinds
                    .iter()
                    .map(|kind| path_by_output_format(&compilation, kind, name, &options.output_format))
                    .filter(|path| path.exists())
            });
            if let Some(first_path) = output.next() {
                let remaining = output.count();
                let remaining = match remaining {
                    0 => "".to_owned(),
                    1 => " and 1 other file".to_owned(),
                    n => format!(" and {n} other files"),
                };

                let mut shell = ws.gctx().shell();
                let link = shell.err_file_hyperlink(&first_path);
                shell.status(
                    "Generated",
                    format!("{link}{}{link:#}{remaining}", first_path.display(),),
                )?;
            }
        }

        Ok(())
    }

    fn path_by_output_format(
        compilation: &Compilation<'_>,
        kind: &CompileKind,
        name: &str,
        output_format: &OutputFormat,
    ) -> PathBuf {
        if matches!(output_format, OutputFormat::Json) {
            compilation.root_output[kind]
                .with_file_name("doc")
                .join(format!("{}.json", name))
        } else {
            compilation.root_output[kind]
                .with_file_name("doc")
                .join(name)
                .join("index.html")
        }
    }

    fn open_docs(
        path: &Path,
        shell: &mut Shell,
        config_browser: Option<(PathBuf, Vec<String>)>,
        gctx: &GlobalContext,
    ) -> CargoResult<()> {
        let browser =
            config_browser.or_else(|| Some((PathBuf::from(gctx.get_env_os("BROWSER")?), Vec::new())));

        match browser {
            Some((browser, initial_args)) => {
                if let Err(e) = Command::new(&browser).args(initial_args).arg(path).status() {
                    shell.warn(format!(
                        "Couldn't open docs with {}: {}",
                        browser.to_string_lossy(),
                        e
                    ))?;
                }
            }
            None => {
                if let Err(e) = opener::open(&path) {
                    let e = e.into();
                    crate::display_warning_with_error("couldn't open docs", &e, shell);
                }
            }
        };

        Ok(())
    }