From bc6b31fd44a5fecf942ba7d031b7d6ef83bfc052 Mon Sep 17 00:00:00 2001
From: Ben Frankel <ben.frankel7@gmail.com>
Date: Sun, 7 Jul 2024 03:51:53 -0700
Subject: [PATCH] Move lints to Cargo.toml and add comments

---
 Cargo.toml  | 28 ++++++++++++++++++++++++----
 src/main.rs |  5 -----
 2 files changed, 24 insertions(+), 9 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index 315c89f6..0b55067c 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -7,7 +7,10 @@ license = "MIT OR Apache-2.0 OR CC0-1.0"
 [dependencies]
 bevy = "0.14"
 # Disable low-severity logs at compile time for performance.
-log = { version = "0.4", features = ["max_level_debug", "release_max_level_warn"] }
+log = { version = "0.4", features = [
+    "max_level_debug",
+    "release_max_level_warn",
+] }
 
 [features]
 default = [
@@ -27,6 +30,15 @@ dev_native = [
     "bevy/embedded_watcher",
 ]
 
+# Idiomatic Bevy code often triggers these lints, and the CI workflow treats them as errors.
+# In some cases they may still signal poor code quality however, so consider commenting out these lines.
+[lints.clippy]
+# Bevy supplies arguments to systems via dependency injection, so it's natural for systems to
+# request more than 7 arguments -- which triggers this lint.
+too_many_arguments = "allow"
+# Queries that access many components may trigger this lint.
+type_complexity = "allow"
+
 # Compile with Performance Optimizations:
 # https://bevyengine.org/learn/quick-start/getting-started/setup/#compile-with-performance-optimizations
 
@@ -38,13 +50,21 @@ opt-level = 1
 [profile.dev.package."*"]
 opt-level = 3
 
-# Enable additional optimization in release mode at the cost of compile time.
+# Enable more optimization in release mode at the cost of compile time.
 [profile.release]
-lto = "thin"
+# Compile the entire crate as one unit.
+# Significantly slows compile times, marginal improvements.
 codegen-units = 1
+# Do a second optimization pass over the entire program, including dependencies.
+# Slightly slows compile times, marginal improvements.
+lto = "thin"
 
-# Optimize for size in wasm-release mode.
+# Optimize for size in wasm-release mode to reduce load times and bandwidth usage on web.
 [profile.wasm-release]
+# Use release profile as default values.
 inherits = "release"
+# Optimize with size in mind (also try "s", sometimes it is better).
+# This doesn't increase compilation times compared to -O3, great improvements.
 opt-level = "z"
+# Strip all debugging information from the binary to reduce file size.
 strip = "debuginfo"
diff --git a/src/main.rs b/src/main.rs
index a4712a6a..5802218e 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -1,8 +1,3 @@
-// Bevy code commonly triggers these lints and they may be important signals
-// about code quality. They are sometimes hard to avoid though, and the CI
-// workflow treats them as errors, so this allows them throughout the project.
-// Feel free to delete this line.
-#![allow(clippy::too_many_arguments, clippy::type_complexity)]
 // Disable console on Windows for non-dev builds.
 #![cfg_attr(not(feature = "dev"), windows_subsystem = "windows")]