refactor: replace @default symbols with constants

Author: BD103

bevy_lint/src/lints/cargo.rs

@@ -9,9 +9,6 @@ use rustc_span::Symbol;
 
 declare_bevy_lint_pass! {
     pub(crate) Cargo => [DUPLICATE_BEVY_DEPENDENCIES],
-    @default = {
-        bevy: Symbol = Symbol::intern("bevy"),
-    },
 }
 
 impl LateLintPass<'_> for Cargo {
@@ -34,7 +31,7 @@ impl LateLintPass<'_> for Cargo {
             .exec()
         {
             Ok(metadata) => {
-                super::nursery::duplicate_bevy_dependencies::check(cx, &metadata, self.bevy);
+                super::nursery::duplicate_bevy_dependencies::check(cx, &metadata);
             }
             Err(e) => {
                 cx.tcx

bevy_lint/src/lints/nursery/duplicate_bevy_dependencies.rs

@@ -62,7 +62,7 @@
 
 use std::{collections::BTreeMap, ops::Range, path::Path, sync::Arc};
 
-use crate::declare_bevy_lint;
+use crate::{declare_bevy_lint, sym};
 use cargo_metadata::{
     Metadata, Resolve,
     semver::{Prerelease, Version, VersionReq},
@@ -98,9 +98,9 @@ fn toml_span(range: Range<usize>, file: &SourceFile) -> Span {
     )
 }
 
-pub(crate) fn check(cx: &LateContext<'_>, metadata: &Metadata, bevy_symbol: Symbol) {
+pub(crate) fn check(cx: &LateContext<'_>, metadata: &Metadata) {
     // no reason to continue the check if there is only one instance of `bevy` required
-    if find_crates(cx.tcx, bevy_symbol).len() == 1 {
+    if find_crates(cx.tcx, sym::bevy).len() == 1 {
         return;
     }
 

bevy_lint/src/lints/pedantic/main_return_without_appexit.rs

@@ -33,7 +33,7 @@
 //! }
 //! ```
 
-use crate::{declare_bevy_lint, declare_bevy_lint_pass, utils::hir_parse::MethodCall};
+use crate::{declare_bevy_lint, declare_bevy_lint_pass, sym, utils::hir_parse::MethodCall};
 use clippy_utils::{
     diagnostics::span_lint_hir_and_then, is_entrypoint_fn, is_expr_used_or_unified,
     ty::match_type, visitors::for_each_expr,
@@ -52,9 +52,6 @@ declare_bevy_lint! {
 
 declare_bevy_lint_pass! {
     pub(crate) MainReturnWithoutAppExit => [MAIN_RETURN_WITHOUT_APPEXIT],
-    @default = {
-        run: Symbol = Symbol::intern("run"),
-    },
 }
 
 impl<'tcx> LateLintPass<'tcx> for MainReturnWithoutAppExit {
@@ -89,7 +86,7 @@ impl<'tcx> LateLintPass<'tcx> for MainReturnWithoutAppExit {
                     receiver,
                     ..
                 }) = MethodCall::try_from(cx, expr)
-                    && method_path.ident.name == self.run
+                    && method_path.ident.name == sym::run
                     && !expr.span.in_external_macro(cx.tcx.sess.source_map())
                 {
                     // Get the type of `src` for `src.run()`. We peel away all references because

bevy_lint/src/lints/suspicious/insert_event_resource.rs

@@ -40,8 +40,7 @@
 //! ```
 
 use crate::{
-    declare_bevy_lint, declare_bevy_lint_pass,
-    utils::hir_parse::{MethodCall, generic_args_snippet, span_args},
+    declare_bevy_lint, declare_bevy_lint_pass, sym, utils::hir_parse::{generic_args_snippet, span_args, MethodCall}
 };
 use clippy_utils::{
     diagnostics::span_lint_and_sugg,
@@ -63,10 +62,6 @@ declare_bevy_lint! {
 
 declare_bevy_lint_pass! {
     pub(crate) InsertEventResource => [INSERT_EVENT_RESOURCE],
-    @default = {
-        insert_resource: Symbol = Symbol::intern("insert_resource"),
-        init_resource: Symbol = Symbol::intern("init_resource"),
-    },
 }
 
 const HELP_MESSAGE: &str = "inserting an `Events` resource does not fully setup that event";
@@ -95,10 +90,10 @@ impl<'tcx> LateLintPass<'tcx> for InsertEventResource {
             // If the method is `App::insert_resource()` or `App::init_resource()`, check it with
             // its corresponding function.
             match method_call.method_path.ident.name {
-                symbol if symbol == self.insert_resource => {
+                symbol if symbol == sym::insert_resource => {
                     check_insert_resource(cx, &method_call);
                 }
-                symbol if symbol == self.init_resource => {
+                symbol if symbol == sym::init_resource => {
                     check_init_resource(cx, &method_call);
                 }
                 _ => {}

bevy_lint/src/lints/suspicious/insert_unit_bundle.rs

@@ -57,7 +57,7 @@ use rustc_lint::{LateContext, LateLintPass};
 use rustc_middle::ty::{Ty, TyKind};
 use rustc_span::Symbol;
 
-use crate::{declare_bevy_lint, declare_bevy_lint_pass, utils::hir_parse::MethodCall};
+use crate::{declare_bevy_lint, declare_bevy_lint_pass, sym, utils::hir_parse::MethodCall};
 
 declare_bevy_lint! {
     pub(crate) INSERT_UNIT_BUNDLE,
@@ -67,9 +67,6 @@ declare_bevy_lint! {
 
 declare_bevy_lint_pass! {
     pub(crate) InsertUnitBundle => [INSERT_UNIT_BUNDLE],
-    @default = {
-        spawn: Symbol = Symbol::intern("spawn"),
-    },
 }
 
 impl<'tcx> LateLintPass<'tcx> for InsertUnitBundle {
@@ -92,7 +89,7 @@ impl<'tcx> LateLintPass<'tcx> for InsertUnitBundle {
         // we skip it.
         if !(span.in_external_macro(cx.tcx.sess.source_map())
             || match_type(cx, src_ty, &crate::paths::COMMANDS)
-                && method_path.ident.name == self.spawn)
+                && method_path.ident.name == sym::spawn)
         {
             return;
         }

bevy_lint/src/lints/suspicious/iter_current_update_events.rs

@@ -43,7 +43,7 @@ use rustc_hir::Expr;
 use rustc_lint::{LateContext, LateLintPass};
 use rustc_span::Symbol;
 
-use crate::{declare_bevy_lint, declare_bevy_lint_pass, utils::hir_parse::MethodCall};
+use crate::{declare_bevy_lint, declare_bevy_lint_pass, sym, utils::hir_parse::MethodCall};
 
 declare_bevy_lint! {
     pub(crate) ITER_CURRENT_UPDATE_EVENTS,
@@ -53,10 +53,6 @@ declare_bevy_lint! {
 
 declare_bevy_lint_pass! {
     pub(crate) IterCurrentUpdateEvents => [ITER_CURRENT_UPDATE_EVENTS],
-
-    @default = {
-        iter_current_update_events: Symbol = Symbol::intern("iter_current_update_events"),
-    },
 }
 
 impl<'tcx> LateLintPass<'tcx> for IterCurrentUpdateEvents {
@@ -91,7 +87,7 @@ impl<'tcx> LateLintPass<'tcx> for IterCurrentUpdateEvents {
                 return;
             }
 
-            if method_call.method_path.ident.name == self.iter_current_update_events {
+            if method_call.method_path.ident.name == sym::iter_current_update_events {
                 span_lint_and_help(
                     cx,
                     ITER_CURRENT_UPDATE_EVENTS,

bevy_lint/src/sym.rs

@@ -5,6 +5,11 @@
 //! are used in the linter. The only exception to this is the [`EXTRA_SYMBOLS`] constant, which
 //! contains a complete ordered list of all symbols to be pre-interned.
 
+#![allow(
+    non_upper_case_globals,
+    reason = "Symbol constants are named as-is so it is easy to see what strings they represent."
+)]
+
 use rustc_span::{Symbol, symbol::PREDEFINED_SYMBOLS_COUNT};
 
 /// A helper used by [`declare_bevy_symbols!`] to extract its input.
@@ -53,4 +58,11 @@ macro_rules! declare_bevy_symbols {
     };
 }
 
-declare_bevy_symbols! {}
+declare_bevy_symbols! {
+    bevy,
+    init_resource,
+    insert_resource,
+    iter_current_update_events,
+    spawn,
+    run,
+}