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
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct RustDocCommand {
deps: bool,
silence: bool,
}
impl RustDocCommand {
pub fn new() -> Self {
Self {
deps: false,
silence: false,
}
}
/// Include dependencies
///
/// Reasons to have this disabled:
/// - Faster API extraction
/// - Less likely to hit bugs in rustdoc, like
/// - rust-lang/rust#89097
/// - rust-lang/rust#83718
///
/// Reasons to have this enabled:
/// - Check for accidental inclusion of dependencies in your API
/// - Detect breaking changes from dependencies in your API
pub fn deps(mut self, yes: bool) -> Self {
self.deps = yes;
self
}
/// Don't write progress to stderr
pub fn silence(mut self, yes: bool) -> Self {
self.silence = yes;
self
}
/// Produce a rustdoc JSON file for the specified configuration.
pub fn dump(
&self,
manifest_path: &std::path::Path,
pkg_spec: Option<&str>,
all_features: bool,
) -> anyhow::Result<std::path::PathBuf> {
let metadata = cargo_metadata::MetadataCommand::new()
.manifest_path(manifest_path)
.no_deps()
.exec()?;
let manifest_target_directory = metadata
.target_directory
.as_path()
.as_std_path()
// HACK: Avoid potential errors when mixing toolchains
.join(crate::util::SCOPE)
.join("target");
let target_dir = manifest_target_directory.as_path();
let stderr = if self.silence {
std::process::Stdio::piped()
} else {
// Print cargo doc progress
std::process::Stdio::inherit()
};
let mut cmd = std::process::Command::new("cargo");
cmd.env("RUSTC_BOOTSTRAP", "1")
.env(
"RUSTDOCFLAGS",
"-Z unstable-options --document-private-items --document-hidden-items --output-format=json",
)
.stdout(std::process::Stdio::null()) // Don't pollute output
.stderr(stderr)
.arg("doc")
.arg("--manifest-path")
.arg(manifest_path)
.arg("--target-dir")
.arg(target_dir);
if let Some(pkg_spec) = pkg_spec {
cmd.arg("--package").arg(pkg_spec);
}
if !self.deps {
cmd.arg("--no-deps");
}
if all_features {
cmd.arg("--all-features");
}
let output = cmd.output()?;
if !output.status.success() {
if self.silence {
anyhow::bail!(
"Failed when running cargo-doc on {}:\n{}",
manifest_path.display(),
String::from_utf8_lossy(&output.stderr)
)
} else {
anyhow::bail!(
"Failed when running cargo-doc on {}. See stderr.",
manifest_path.display(),
)
}
}
if let Some(pkg_spec) = pkg_spec {
// N.B.: This package spec is not necessarily part of the manifest at `manifest_path`!
// For example, when getting rustdoc JSON for a crate version from the registry,
// the manifest is "synthetic" with only a dependency on that crate and version
// and therefore is not a manifest *for* that crate itself.
let crate_name = pkg_spec
.split_once('@')
.map(|s| s.0)
.unwrap_or(pkg_spec)
.to_owned();
// N.B.: Crates named like `foo-bar` have rustdoc JSON named like `foo_bar.json`.
let crate_name_with_underscores = crate_name.replace('-', "_");
let json_path = target_dir.join(format!("doc/{crate_name_with_underscores}.json"));
if json_path.exists() {
Ok(json_path)
} else {
anyhow::bail!(
"Could not find expected rustdoc output for `{}`: {}",
crate_name,
json_path.display()
);
}
} else {
let manifest = crate::manifest::Manifest::parse(manifest_path)?;
let lib_target_name = crate::manifest::get_lib_target_name(&manifest)?;
let json_path = target_dir.join(format!("doc/{lib_target_name}.json"));
if json_path.exists() {
return Ok(json_path);
}
let first_bin_target_name = crate::manifest::get_first_bin_target_name(&manifest)?;
let json_path = target_dir.join(format!("doc/{first_bin_target_name}.json"));
if !json_path.exists() {
let crate_name = if let Some(pkg_spec) = pkg_spec {
pkg_spec
.split_once('@')
.map(|s| s.0)
.unwrap_or(pkg_spec)
.to_owned()
} else {
crate::manifest::get_package_name(&manifest)?
};
anyhow::bail!(
"Could not find expected rustdoc output for `{}`: {}",
crate_name,
json_path.display()
);
}
Ok(json_path)
}
}
}
impl Default for RustDocCommand {
fn default() -> Self {
Self::new()
}
}
#[cfg(test)]
mod tests {
use std::path::Path;
use super::RustDocCommand;
#[test]
fn rustdoc_for_lib_crate_without_lib_section() {
RustDocCommand::default()
.dump(
Path::new("./test_rustdoc/implicit_lib/Cargo.toml"),
None,
true,
)
.expect("no errors");
}
#[test]
fn rustdoc_for_lib_crate_with_lib_section() {
RustDocCommand::default()
.dump(
Path::new("./test_rustdoc/renamed_lib/Cargo.toml"),
None,
true,
)
.expect("no errors");
}
#[test]
fn rustdoc_for_bin_crate_without_bin_section() {
RustDocCommand::default()
.dump(
Path::new("./test_rustdoc/implicit_bin/Cargo.toml"),
None,
true,
)
.expect("no errors");
}
#[test]
fn rustdoc_for_bin_crate_with_bin_section() {
RustDocCommand::default()
.dump(
Path::new("./test_rustdoc/renamed_bin/Cargo.toml"),
None,
true,
)
.expect("no errors");
}
}