Add warn-by-default lint for visibility on const _ declarations

Add a warn-by-default `unused_visibility` lint for visibility qualifiers
on `const _` declarations - e.g. `pub const _: () = ();`.
These have no effect.

Author: Jules-Bertholet

compiler/rustc_ast_passes/src/ast_validation.rs

@@ -33,7 +33,7 @@ use rustc_session::Session;
 use rustc_session::lint::BuiltinLintDiag;
 use rustc_session::lint::builtin::{
     DEPRECATED_WHERE_CLAUSE_LOCATION, MISSING_ABI, MISSING_UNSAFE_ON_EXTERN,
-    PATTERNS_IN_FNS_WITHOUT_BODY,
+    PATTERNS_IN_FNS_WITHOUT_BODY, UNUSED_VISIBILITY,
 };
 use rustc_span::{Ident, Span, kw, sym};
 use rustc_target::spec::{AbiMap, AbiMapping};
@@ -1236,14 +1236,25 @@ impl<'a> Visitor<'a> for AstValidator<'a> {
                     }
                 });
             }
-            ItemKind::Const(box ConstItem { defaultness, expr, .. }) => {
+            ItemKind::Const(box ConstItem { defaultness, ident, expr, .. }) => {
                 self.check_defaultness(item.span, *defaultness);
                 if expr.is_none() {
                     self.dcx().emit_err(errors::ConstWithoutBody {
                         span: item.span,
                         replace_span: self.ending_semi_or_hi(item.span),
                     });
                 }
+                if ident.name == kw::Underscore
+                    && !matches!(item.vis.kind, VisibilityKind::Inherited)
+                {
+                    self.lint_buffer.buffer_lint(
+                        UNUSED_VISIBILITY,
+                        item.id,
+                        item.vis.span,
+                        BuiltinLintDiag::UnusedVisibility(item.vis.span),
+                    )
+                }
+
                 visit::walk_item(self, item);
             }
             ItemKind::Static(box StaticItem { expr, safety, .. }) => {

compiler/rustc_lint/messages.ftl

@@ -956,6 +956,9 @@ lint_unused_op = unused {$op} that must be used
 
 lint_unused_result = unused result of type `{$ty}`
 
+lint_unused_visibility = visibility qualifiers have no effect on `const _` declarations
+    .suggestion = remove the qualifier
+
 lint_use_let_underscore_ignore_suggestion = use `let _ = ...` to ignore the expression or result
 
 lint_useless_ptr_null_checks_fn_ptr = function pointers are not nullable, so checking them for null will always return false

compiler/rustc_lint/src/early/diagnostics.rs

@@ -361,5 +361,8 @@ pub fn decorate_builtin_lint(
         BuiltinLintDiag::OutOfScopeMacroCalls { span, path, location } => {
             lints::OutOfScopeMacroCalls { span, path, location }.decorate_lint(diag)
         }
+        BuiltinLintDiag::UnusedVisibility(span) => {
+            lints::UnusedVisibility { span }.decorate_lint(diag)
+        }
     }
 }

compiler/rustc_lint/src/lib.rs

@@ -288,6 +288,7 @@ fn register_builtins(store: &mut LintStore) {
         "unused",
         UNUSED_IMPORTS,
         UNUSED_VARIABLES,
+        UNUSED_VISIBILITY,
         UNUSED_ASSIGNMENTS,
         DEAD_CODE,
         UNUSED_MUT,

compiler/rustc_lint/src/lints.rs

@@ -3188,3 +3188,10 @@ impl Subdiagnostic for MismatchedLifetimeSyntaxesSuggestion {
         }
     }
 }
+
+#[derive(LintDiagnostic)]
+#[diag(lint_unused_visibility)]
+pub(crate) struct UnusedVisibility {
+    #[suggestion(style = "short", code = "", applicability = "machine-applicable")]
+    pub span: Span,
+}

compiler/rustc_lint_defs/src/builtin.rs

@@ -141,6 +141,7 @@ declare_lint_pass! {
         UNUSED_QUALIFICATIONS,
         UNUSED_UNSAFE,
         UNUSED_VARIABLES,
+        UNUSED_VISIBILITY,
         USELESS_DEPRECATED,
         WARNINGS,
         // tidy-alphabetical-end
@@ -690,6 +691,26 @@ declare_lint! {
     "detect variables which are not used in any way"
 }
 
+declare_lint! {
+    /// The `unused_visibility` lint dectects visibility qualifiers (like `pub`)
+    /// on a `const _` item.
+    ///
+    /// ### Example
+    ///
+    /// ```rust
+    /// const _: () = {};
+    /// ```
+    ///
+    /// {{produces}}
+    ///
+    /// ### Explanation
+    ///
+    /// These qualifiers have no effect.
+    pub UNUSED_VISIBILITY,
+    Warn,
+    "detect visibility qualifiers on `const _` items"
+}
+
 declare_lint! {
     /// The `unused_assignments` lint detects assignments that will never be read.
     ///

compiler/rustc_lint_defs/src/lib.rs

@@ -748,6 +748,7 @@ pub enum BuiltinLintDiag {
         path: String,
         location: String,
     },
+    UnusedVisibility(Span),
 }
 
 pub type RegisteredTools = FxIndexSet<Ident>;

src/tools/clippy/tests/ui-toml/absolute_paths/absolute_paths.no_short.stderr

@@ -71,10 +71,10 @@ LL |         impl<T: core::cmp::Eq> core::fmt::Display for X<T>
    |                                ^^^^^^^^^^^^^^^^^^
 
 error: consider bringing this path into scope with the `use` keyword
-  --> tests/ui-toml/absolute_paths/absolute_paths.rs:113:14
+  --> tests/ui-toml/absolute_paths/absolute_paths.rs:113:10
    |
-LL | pub const _: crate::S = {
-   |              ^^^^^^^^
+LL | const _: crate::S = {
+   |          ^^^^^^^^
 
 error: consider bringing this path into scope with the `use` keyword
   --> tests/ui-toml/absolute_paths/absolute_paths.rs:114:9

src/tools/clippy/tests/ui-toml/absolute_paths/absolute_paths.rs

@@ -110,7 +110,7 @@ mod m1 {
 }
 
 //~[no_short]v absolute_paths
-pub const _: crate::S = {
+const _: crate::S = {
     let crate::S = m1::S; //~[no_short] absolute_paths
 
     crate::m1::S

tests/ui/consts/promoted_const_call3.rs

@@ -4,12 +4,12 @@ pub const C: () = {
     //~^ ERROR: destructor of `String` cannot be evaluated at compile-time
 };
 
-pub const _: () = {
+const _: () = {
     let _: &'static _ = &id(&String::new());
     //~^ ERROR: destructor of `String` cannot be evaluated at compile-time
 };
 
-pub const _: () = {
+const _: () = {
     let _: &'static _ = &std::mem::ManuallyDrop::new(String::new());
     //~^ ERROR: temporary value dropped while borrowed
 };