Auto merge of #11842 - GuillaumeGomez:check_private_items-config, r=blyxyas

Add new `check_private_items` config Fixes #11742. It adds a new configuration which allows for `MISSING_SAFETY_DOC`, `UNNECESSARY_SAFETY_DOC`, `MISSING_PANICS_DOC` and `MISSING_ERRORS_DOC` lints to run on private items. changelog: add a new configuration which allows for `MISSING_SAFETY_DOC`, `UNNECESSARY_SAFETY_DOC`, `MISSING_PANICS_DOC` and `MISSING_ERRORS_DOC` lints to run on private items. r? `@blyxyas`

Author: bors

clippy_config/src/conf.rs

@@ -543,6 +543,10 @@ define_Conf! {
  /// for _ in &mut *rmvec {}
  /// ```
  (enforce_iter_loop_reborrow: bool = false),
+ /// Lint: MISSING_SAFETY_DOC, UNNECESSARY_SAFETY_DOC, MISSING_PANICS_DOC, MISSING_ERRORS_DOC
+ ///
+ /// Whether to also run the listed lints on private items.
+ (check_private_items: bool = false),
 }
 
 /// Search for the configuration file.

clippy_lints/src/doc/missing_headers.rs

@@ -15,17 +15,19 @@ pub fn check(
  headers: DocHeaders,
  body_id: Option<BodyId>,
  panic_span: Option<Span>,
+ check_private_items: bool,
 ) {
- if !cx.effective_visibilities.is_exported(owner_id.def_id) {
+ if !check_private_items && !cx.effective_visibilities.is_exported(owner_id.def_id) {
  return; // Private functions do not require doc comments
  }
 
  // do not lint if any parent has `#[doc(hidden)]` attribute (#7347)
- if cx
- .tcx
- .hir()
- .parent_iter(owner_id.into())
- .any(|(id, _node)| is_doc_hidden(cx.tcx.hir().attrs(id)))
+ if !check_private_items
+ && cx
+ .tcx
+ .hir()
+ .parent_iter(owner_id.into())
+ .any(|(id, _node)| is_doc_hidden(cx.tcx.hir().attrs(id)))
  {
  return;
  }

clippy_lints/src/doc/mod.rs

@@ -310,13 +310,15 @@ declare_clippy_lint! {
 pub struct DocMarkdown {
  valid_idents: FxHashSet<String>,
  in_trait_impl: bool,
+ check_private_items: bool,
 }
 
 impl DocMarkdown {
- pub fn new(valid_idents: &[String]) -> Self {
+ pub fn new(valid_idents: &[String], check_private_items: bool) -> Self {
  Self {
  valid_idents: valid_idents.iter().cloned().collect(),
  in_trait_impl: false,
+ check_private_items,
  }
  }
 }
@@ -349,7 +351,15 @@ impl<'tcx> LateLintPass<'tcx> for DocMarkdown {
  let body = cx.tcx.hir().body(body_id);
 
  let panic_span = FindPanicUnwrap::find_span(cx, cx.tcx.typeck(item.owner_id), body.value);
- missing_headers::check(cx, item.owner_id, sig, headers, Some(body_id), panic_span);
+ missing_headers::check(
+ cx,
+ item.owner_id,
+ sig,
+ headers,
+ Some(body_id),
+ panic_span,
+ self.check_private_items,
+ );
  }
  },
  hir::ItemKind::Impl(impl_) => {
@@ -387,7 +397,7 @@ impl<'tcx> LateLintPass<'tcx> for DocMarkdown {
  };
  if let hir::TraitItemKind::Fn(ref sig, ..) = item.kind {
  if !in_external_macro(cx.tcx.sess, item.span) {
- missing_headers::check(cx, item.owner_id, sig, headers, None, None);
+ missing_headers::check(cx, item.owner_id, sig, headers, None, None, self.check_private_items);
  }
  }
  }
@@ -404,7 +414,15 @@ impl<'tcx> LateLintPass<'tcx> for DocMarkdown {
  let body = cx.tcx.hir().body(body_id);
 
  let panic_span = FindPanicUnwrap::find_span(cx, cx.tcx.typeck(item.owner_id), body.value);
- missing_headers::check(cx, item.owner_id, sig, headers, Some(body_id), panic_span);
+ missing_headers::check(
+ cx,
+ item.owner_id,
+ sig,
+ headers,
+ Some(body_id),
+ panic_span,
+ self.check_private_items,
+ );
  }
  }
 }

clippy_lints/src/lib.rs

@@ -563,6 +563,7 @@ pub fn register_lints(store: &mut rustc_lint::LintStore, conf: &'static Conf) {
  vec_box_size_threshold,
  verbose_bit_mask_threshold,
  warn_on_all_wildcard_imports,
+ check_private_items,
 
  blacklisted_names: _,
  cyclomatic_complexity_threshold: _,
@@ -746,7 +747,7 @@ pub fn register_lints(store: &mut rustc_lint::LintStore, conf: &'static Conf) {
  avoid_breaking_exported_api,
  ))
  });
- store.register_late_pass(move |_| Box::new(doc::DocMarkdown::new(doc_valid_idents)));
+ store.register_late_pass(move |_| Box::new(doc::DocMarkdown::new(doc_valid_idents, check_private_items)));
  store.register_late_pass(|_| Box::new(neg_multiply::NegMultiply));
  store.register_late_pass(|_| Box::new(let_if_seq::LetIfSeq));
  store.register_late_pass(|_| Box::new(mixed_read_write_in_expression::EvalOrderDependence));

tests/ui-toml/private-doc-errors/clippy.toml

@@ -0,0 +1 @@
+check-private-items = true

tests/ui-toml/private-doc-errors/doc_lints.rs

@@ -0,0 +1,54 @@
+#![deny(
+ clippy::unnecessary_safety_doc,
+ clippy::missing_errors_doc,
+ clippy::missing_panics_doc
+)]
+
+/// This is a private function, skip to match behavior with `missing_safety_doc`.
+///
+/// # Safety
+///
+/// Boo!
+fn you_dont_see_me() {
+ //~^ ERROR: safe function's docs have unnecessary `# Safety` section
+ unimplemented!();
+}
+
+mod private_mod {
+ /// This is public but unexported function.
+ ///
+ /// # Safety
+ ///
+ /// Very safe!
+ pub fn only_crate_wide_accessible() -> Result<(), ()> {
+ //~^ ERROR: safe function's docs have unnecessary `# Safety` section
+ //~| ERROR: docs for function returning `Result` missing `# Errors` section
+ unimplemented!();
+ }
+}
+
+pub struct S;
+
+impl S {
+ /// Private, fine again to stay consistent with `missing_safety_doc`.
+ ///
+ /// # Safety
+ ///
+ /// Unnecessary!
+ fn private(&self) {
+ //~^ ERROR: safe function's docs have unnecessary `# Safety` section
+ //~| ERROR: docs for function which may panic missing `# Panics` section
+ panic!();
+ }
+}
+
+#[doc(hidden)]
+pub mod __macro {
+ pub struct T;
+ impl T {
+ pub unsafe fn f() {}
+ //~^ ERROR: unsafe function's docs miss `# Safety` section
+ }
+}
+
+fn main() {}

tests/ui-toml/private-doc-errors/doc_lints.stderr

@@ -0,0 +1,64 @@
+error: safe function's docs have unnecessary `# Safety` section
+ --> $DIR/doc_lints.rs:12:1
+ |
+LL | fn you_dont_see_me() {
+ | ^^^^^^^^^^^^^^^^^^^^
+ |
+note: the lint level is defined here
+ --> $DIR/doc_lints.rs:2:5
+ |
+LL | clippy::unnecessary_safety_doc,
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+error: safe function's docs have unnecessary `# Safety` section
+ --> $DIR/doc_lints.rs:23:5
+ |
+LL | pub fn only_crate_wide_accessible() -> Result<(), ()> {
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+error: docs for function returning `Result` missing `# Errors` section
+ --> $DIR/doc_lints.rs:23:5
+ |
+LL | pub fn only_crate_wide_accessible() -> Result<(), ()> {
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+ |
+note: the lint level is defined here
+ --> $DIR/doc_lints.rs:3:5
+ |
+LL | clippy::missing_errors_doc,
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+error: safe function's docs have unnecessary `# Safety` section
+ --> $DIR/doc_lints.rs:38:5
+ |
+LL | fn private(&self) {
+ | ^^^^^^^^^^^^^^^^^
+
+error: docs for function which may panic missing `# Panics` section
+ --> $DIR/doc_lints.rs:38:5
+ |
+LL | fn private(&self) {
+ | ^^^^^^^^^^^^^^^^^
+ |
+note: first possible panic found here
+ --> $DIR/doc_lints.rs:41:9
+ |
+LL | panic!();
+ | ^^^^^^^^
+note: the lint level is defined here
+ --> $DIR/doc_lints.rs:4:5
+ |
+LL | clippy::missing_panics_doc
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+error: unsafe function's docs miss `# Safety` section
+ --> $DIR/doc_lints.rs:49:9
+ |
+LL | pub unsafe fn f() {}
+ | ^^^^^^^^^^^^^^^^^
+ |
+ = note: `-D clippy::missing-safety-doc` implied by `-D warnings`
+ = help: to override `-D warnings` add `#[allow(clippy::missing_safety_doc)]`
+
+error: aborting due to 6 previous errors
+

tests/ui-toml/toml_unknown_key/conf_unknown_key.stderr

@@ -21,6 +21,7 @@ error: error reading Clippy's configuration file: unknown field `foobar`, expect
  await-holding-invalid-types
  blacklisted-names
  cargo-ignore-publish
+ check-private-items
  cognitive-complexity-threshold
  cyclomatic-complexity-threshold
  disallowed-macros
@@ -95,6 +96,7 @@ error: error reading Clippy's configuration file: unknown field `barfoo`, expect
  await-holding-invalid-types
  blacklisted-names
  cargo-ignore-publish
+ check-private-items
  cognitive-complexity-threshold
  cyclomatic-complexity-threshold
  disallowed-macros