Skip to content

Commit

Permalink
Fix invalid coverage computation when --output-format=json is enabled
Browse files Browse the repository at this point in the history
  • Loading branch information
GuillaumeGomez committed Nov 4, 2024
1 parent ca87b53 commit e9161db
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 6 deletions.
4 changes: 2 additions & 2 deletions src/librustdoc/clean/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2907,7 +2907,7 @@ fn clean_extern_crate<'tcx>(
None => false,
}
})
&& !cx.output_format.is_json();
&& !cx.is_json();

let krate_owner_def_id = krate.owner_id.def_id;
if please_inline {
Expand Down Expand Up @@ -3000,7 +3000,7 @@ fn clean_use_statement_inner<'tcx>(
// forcefully don't inline if this is not public or if the
// #[doc(no_inline)] attribute is present.
// Don't inline doc(hidden) imports so they can be stripped at a later stage.
let mut denied = cx.output_format.is_json()
let mut denied = cx.is_json()
|| !(visibility.is_public()
|| (cx.render_options.document_private && is_visible_from_parent_mod))
|| pub_underscore
Expand Down
7 changes: 7 additions & 0 deletions src/librustdoc/core.rs
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,13 @@ impl<'tcx> DocContext<'tcx> {
_ => None,
}
}

/// Returns `true` if the JSON output format is enabled for generating the crate content.
///
/// If another option like `--show-coverage` is enabled, it will return false.
pub(crate) fn is_json(&self) -> bool {
self.output_format.is_json() && !self.show_coverage
}
}

/// Creates a new `DiagCtxt` that can be used to emit warnings and errors.
Expand Down
1 change: 1 addition & 0 deletions src/librustdoc/passes/calculate_doc_coverage.rs
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ impl<'a, 'b> CoverageCalculator<'a, 'b> {

fn print_results(&self) {
let output_format = self.ctx.output_format;
// In this case we want to ensure that the `OutputFormat` is JSON and NOT the `DocContext`.
if output_format.is_json() {
println!("{}", self.to_json());
return;
Expand Down
2 changes: 1 addition & 1 deletion src/librustdoc/passes/strip_hidden.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ pub(crate) const STRIP_HIDDEN: Pass = Pass {
/// Strip items marked `#[doc(hidden)]`
pub(crate) fn strip_hidden(krate: clean::Crate, cx: &mut DocContext<'_>) -> clean::Crate {
let mut retained = ItemIdSet::default();
let is_json_output = cx.output_format.is_json() && !cx.show_coverage;
let is_json_output = cx.is_json();

// strip all #[doc(hidden)] items
let krate = {
Expand Down
2 changes: 1 addition & 1 deletion src/librustdoc/passes/strip_priv_imports.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ pub(crate) const STRIP_PRIV_IMPORTS: Pass = Pass {
};

pub(crate) fn strip_priv_imports(krate: clean::Crate, cx: &mut DocContext<'_>) -> clean::Crate {
let is_json_output = cx.output_format.is_json() && !cx.show_coverage;
let is_json_output = cx.is_json();
ImportStripper {
tcx: cx.tcx,
is_json_output,
Expand Down
2 changes: 1 addition & 1 deletion src/librustdoc/passes/strip_private.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ pub(crate) const STRIP_PRIVATE: Pass = Pass {
pub(crate) fn strip_private(mut krate: clean::Crate, cx: &mut DocContext<'_>) -> clean::Crate {
// This stripper collects all *retained* nodes.
let mut retained = ItemIdSet::default();
let is_json_output = cx.output_format.is_json() && !cx.show_coverage;
let is_json_output = cx.is_json();

// strip all private items
{
Expand Down
2 changes: 1 addition & 1 deletion src/librustdoc/visit_ast.rs
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
return false;
}

if self.cx.output_format.is_json() {
if self.cx.is_json() {
return false;
}

Expand Down

0 comments on commit e9161db

Please sign in to comment.