add lint config, matching bevy's (#26)

ChristopherBiscardi · web-flow · commit bbe8f66fdd15 · 2024-09-23T03:14:11.000Z
* add lint config

* scaffold some docs to pass lints
diff --git a/Cargo.toml b/Cargo.toml
@@ -12,3 +12,28 @@ members = ["crates/*"]
 [[bin]]
 name = "bevy_editor_standalone"
 path = "crates/bevy_editor/src/main.rs"
+
+[workspace.lints.clippy]
+doc_markdown = "warn"
+manual_let_else = "warn"
+match_same_arms = "warn"
+redundant_closure_for_method_calls = "warn"
+redundant_else = "warn"
+semicolon_if_nothing_returned = "warn"
+type_complexity = "allow"
+undocumented_unsafe_blocks = "warn"
+unwrap_or_default = "warn"
+
+ptr_as_ptr = "warn"
+ptr_cast_constness = "warn"
+ref_as_ptr = "warn"
+
+[workspace.lints.rust]
+missing_docs = "warn"
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(docsrs_dep)'] }
+unsafe_code = "deny"
+unsafe_op_in_unsafe_fn = "warn"
+unused_qualifications = "warn"
+
+[lints]
+workspace = true
diff --git a/crates/bevy_color_picker/Cargo.toml b/crates/bevy_color_picker/Cargo.toml
@@ -4,3 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+
+[lints]
+workspace = true
diff --git a/crates/bevy_color_picker/src/lib.rs b/crates/bevy_color_picker/src/lib.rs
@@ -1,5 +1,6 @@
 //! A color picker widget for Bevy applications.
 
+/// an add function that adds two numbers
 pub fn add(left: u64, right: u64) -> u64 {
     left + right
 }
diff --git a/crates/bevy_command_palette/Cargo.toml b/crates/bevy_command_palette/Cargo.toml
@@ -4,3 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+
+[lints]
+workspace = true
diff --git a/crates/bevy_command_palette/src/lib.rs b/crates/bevy_command_palette/src/lib.rs
@@ -5,6 +5,7 @@
 //!
 //! Search and keyboard shortcuts will both be supported.
 
+/// an add function that adds two numbers
 pub fn add(left: u64, right: u64) -> u64 {
     left + right
 }
diff --git a/crates/bevy_context_menu/Cargo.toml b/crates/bevy_context_menu/Cargo.toml
@@ -4,3 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+
+[lints]
+workspace = true
diff --git a/crates/bevy_context_menu/src/lib.rs b/crates/bevy_context_menu/src/lib.rs
@@ -3,6 +3,7 @@
 //! This crate opens up a menu with a list of options when the user right-clicks (or otherwise triggers the context menu),
 //! based on what the user has clicked on.
 
+/// an add function that adds two numbers
 pub fn add(left: u64, right: u64) -> u64 {
     left + right
 }
diff --git a/crates/bevy_editor/Cargo.toml b/crates/bevy_editor/Cargo.toml
@@ -4,3 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+
+[lints]
+workspace = true
diff --git a/crates/bevy_editor_camera/Cargo.toml b/crates/bevy_editor_camera/Cargo.toml
@@ -4,3 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+
+[lints]
+workspace = true
diff --git a/crates/bevy_editor_camera/src/lib.rs b/crates/bevy_editor_camera/src/lib.rs
@@ -1,5 +1,6 @@
 //! A set of camera controllers suitable for controlling editor-style views and scene exploration.
 
+/// an add function that adds two numbers
 pub fn add(left: u64, right: u64) -> u64 {
     left + right
 }
diff --git a/crates/bevy_inspector/Cargo.toml b/crates/bevy_inspector/Cargo.toml
@@ -4,3 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+
+[lints]
+workspace = true
diff --git a/crates/bevy_inspector/src/lib.rs b/crates/bevy_inspector/src/lib.rs
@@ -2,6 +2,7 @@
 //!
 //! Data can be viewed and modified in real-time, with changes being reflected in the application.
 
+/// an add function that adds two numbers
 pub fn add(left: u64, right: u64) -> u64 {
     left + right
 }
diff --git a/crates/bevy_localization/Cargo.toml b/crates/bevy_localization/Cargo.toml
@@ -4,3 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+
+[lints]
+workspace = true
diff --git a/crates/bevy_localization/src/lib.rs b/crates/bevy_localization/src/lib.rs
@@ -1,5 +1,6 @@
 //! A localization framework for Bevy applications, backed by Fluent.
 
+/// an add function that adds two numbers
 pub fn add(left: u64, right: u64) -> u64 {
     left + right
 }
diff --git a/crates/bevy_menu_bar/Cargo.toml b/crates/bevy_menu_bar/Cargo.toml
@@ -4,3 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+
+[lints]
+workspace = true
diff --git a/crates/bevy_menu_bar/src/lib.rs b/crates/bevy_menu_bar/src/lib.rs
@@ -3,6 +3,7 @@
 //! This runs along the top of the screen and provides a list of options to the user,
 //! such as "File", "Edit", "View", etc.
 
+/// an add function that adds two numbers
 pub fn add(left: u64, right: u64) -> u64 {
     left + right
 }
diff --git a/crates/bevy_panes/Cargo.toml b/crates/bevy_panes/Cargo.toml
@@ -4,3 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+
+[lints]
+workspace = true
diff --git a/crates/bevy_panes/src/lib.rs b/crates/bevy_panes/src/lib.rs
@@ -1,5 +1,6 @@
 //! Resizable, draggable, collapsible and dockable panes for Bevy.
 
+/// an add function that adds two numbers
 pub fn add(left: u64, right: u64) -> u64 {
     left + right
 }
diff --git a/crates/bevy_preferences/Cargo.toml b/crates/bevy_preferences/Cargo.toml
@@ -4,3 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+
+[lints]
+workspace = true
diff --git a/crates/bevy_preferences/src/lib.rs b/crates/bevy_preferences/src/lib.rs
@@ -1,5 +1,6 @@
 //! A straightforward way to store and retrieve user preferences on disk for Bevy applications.
 
+/// an add function that adds two numbers
 pub fn add(left: u64, right: u64) -> u64 {
     left + right
 }
diff --git a/crates/bevy_scene_tree/Cargo.toml b/crates/bevy_scene_tree/Cargo.toml
@@ -4,3 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+
+[lints]
+workspace = true
diff --git a/crates/bevy_scene_tree/src/lib.rs b/crates/bevy_scene_tree/src/lib.rs
@@ -1,5 +1,6 @@
 //! An interactive, collapsible tree view for hierarchical ECS data in Bevy.
 
+/// an add function that adds two numbers
 pub fn add(left: u64, right: u64) -> u64 {
     left + right
 }
diff --git a/crates/bevy_toolbar/Cargo.toml b/crates/bevy_toolbar/Cargo.toml
@@ -4,3 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+
+[lints]
+workspace = true
diff --git a/crates/bevy_toolbar/src/lib.rs b/crates/bevy_toolbar/src/lib.rs
@@ -3,6 +3,7 @@
 //! Toolbars are a common UI element in many applications, providing quick access to frequently used commands,
 //! and typically display small icons with on-hover tooltips.
 
+/// an add function that adds two numbers
 pub fn add(left: u64, right: u64) -> u64 {
     left + right
 }
diff --git a/crates/bevy_tooltips/Cargo.toml b/crates/bevy_tooltips/Cargo.toml
@@ -4,3 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+
+[lints]
+workspace = true
diff --git a/crates/bevy_tooltips/src/lib.rs b/crates/bevy_tooltips/src/lib.rs
@@ -1,5 +1,6 @@
 //! A tooltip system for Bevy applications, providing contextual information on hover.
 
+/// an add function that adds two numbers
 pub fn add(left: u64, right: u64) -> u64 {
     left + right
 }
diff --git a/crates/bevy_undo/Cargo.toml b/crates/bevy_undo/Cargo.toml
@@ -4,3 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+
+[lints]
+workspace = true
diff --git a/crates/bevy_undo/src/lib.rs b/crates/bevy_undo/src/lib.rs
@@ -1,5 +1,6 @@
 //! An action-based undo-redo system for Bevy ECS data.
 
+/// an add function that adds two numbers
 pub fn add(left: u64, right: u64) -> u64 {
     left + right
 }
diff --git a/crates/bevy_widgets/Cargo.toml b/crates/bevy_widgets/Cargo.toml
@@ -4,3 +4,6 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+
+[lints]
+workspace = true
diff --git a/crates/bevy_widgets/src/lib.rs b/crates/bevy_widgets/src/lib.rs
@@ -1,5 +1,6 @@
 //! A collection of basic UI widgets for Bevy applications.
 
+/// an add function that adds two numbers
 pub fn add(left: u64, right: u64) -> u64 {
     left + right
 }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`//! A color picker widget for Bevy applications.`
`2`	`2`
	`3`	`+/// an add function that adds two numbers`
`3`	`4`	`pub fn add(left: u64, right: u64) -> u64 {`
`4`	`5`	`left + right`
`5`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`//!`
`6`	`6`	`//! Search and keyboard shortcuts will both be supported.`
`7`	`7`
	`8`	`+/// an add function that adds two numbers`
`8`	`9`	`pub fn add(left: u64, right: u64) -> u64 {`
`9`	`10`	`left + right`
`10`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`//! This crate opens up a menu with a list of options when the user right-clicks (or otherwise triggers the context menu),`
`4`	`4`	`//! based on what the user has clicked on.`
`5`	`5`
	`6`	`+/// an add function that adds two numbers`
`6`	`7`	`pub fn add(left: u64, right: u64) -> u64 {`
`7`	`8`	`left + right`
`8`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`//! A set of camera controllers suitable for controlling editor-style views and scene exploration.`
`2`	`2`
	`3`	`+/// an add function that adds two numbers`
`3`	`4`	`pub fn add(left: u64, right: u64) -> u64 {`
`4`	`5`	`left + right`
`5`	`6`	`}`