Merge pull request #1269 from godot-rust/qol/code-style

Code style: stricter imports

Author: Bromeon

.rustfmt.toml

@@ -0,0 +1,12 @@
+# https://github.com/rust-lang/rustfmt/blob/master/Configurations.md
+
+# Orders imports by std:: -> third_party:: -> crate:: paths.
+#
+# Downside: it can mix pub/pub(crate)/private imports. To manage this, use two approaches:
+# 1. If many symbols appear, local inline modules `reexport_pub` and `reexport_crate`.
+# 2. For individual symbols, #[rustfmt::skip] attribute attached to the `use` statement.
+# We may change this appraoch in the future.
+group_imports = "StdExternalCrate"
+
+# Normalizes a::{b, c::d}, a::e -> a::{b, e}, a::c::d.
+imports_granularity = "Module"

godot-bindings/src/godot_exe.rs

@@ -7,15 +7,17 @@
 
 //! Commands related to Godot executable
 
+use std::fs;
+use std::path::{Path, PathBuf};
+use std::process::{Command, Output};
+
+use regex::Regex;
+
 use crate::godot_version::{parse_godot_version, validate_godot_version};
 use crate::header_gen::generate_rust_binding;
 use crate::watch::StopWatch;
 use crate::GodotVersion;
 
-use regex::Regex;
-use std::fs;
-use std::path::{Path, PathBuf};
-use std::process::{Command, Output};
 // Note: CARGO_BUILD_TARGET_DIR and CARGO_TARGET_DIR are not set.
 // OUT_DIR would be standing to reason, but it's an unspecified path that cannot be referenced by CI.
 // const GODOT_VERSION_PATH: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/src/gen/godot_version.txt");

godot-bindings/src/godot_json.rs

@@ -14,13 +14,16 @@
 // Moving said types to `godot-bindings` would increase the cognitive overhead (since domain mapping is responsibility of `godot-codegen`, while godot-bindings is responsible for providing required resources & emitting the version).
 // In the future we might experiment with splitting said types into separate crates.
 
+use std::fs;
+use std::path::Path;
+
+use nanoserde::DeJson;
+
 use crate::depend_on_custom_json::header_gen::generate_rust_binding;
 use crate::godot_version::validate_godot_version;
 use crate::{GodotVersion, StopWatch};
-use nanoserde::DeJson;
-use std::fs;
-use std::path::Path;
 
+#[rustfmt::skip] // Do not reorder.
 // GDExtension headers are backward compatible (new incremental changes in general are exposed as additions to the existing API) while godot-rust simply ignores extra declarations in header file.
 // Therefore, latest headers should work fine for all the past and future Godot versions – as long as the engine remains unchanged.
 // [version-sync] [[

godot-bindings/src/godot_version.rs

@@ -9,11 +9,13 @@
 // while all the functions included are used only with `custom-api` and `custom-api-json` features.
 #![cfg_attr(not(feature = "api-custom"), allow(unused_variables, dead_code))]
 
-use crate::GodotVersion;
-use regex::{Captures, Regex};
 use std::error::Error;
 use std::str::FromStr;
 
+use regex::{Captures, Regex};
+
+use crate::GodotVersion;
+
 pub fn parse_godot_version(version_str: &str) -> Result<GodotVersion, Box<dyn Error>> {
     // Format of the string emitted by `godot --version`:
     // https://github.com/godot-rust/gdext/issues/118#issuecomment-1465748123

godot-bindings/src/import.rs

@@ -30,37 +30,27 @@ pub const ALL_VERSIONS: &[(u8, u8, u8)] = &[
 ];
 
 // [version-sync] [[
-//  [line] #[cfg(feature = "api-$kebabVersion")]\npub use gdextension_api::version_$snakeVersion as prebuilt;\n
+//  [line] #[cfg(feature = "api-$kebabVersion")]\npub use gdextension_api::version_$snakeVersion as prebuilt;
 #[cfg(feature = "api-4-1")]
 pub use gdextension_api::version_4_1 as prebuilt;
-
 #[cfg(feature = "api-4-1-1")]
 pub use gdextension_api::version_4_1_1 as prebuilt;
-
 #[cfg(feature = "api-4-1-2")]
 pub use gdextension_api::version_4_1_2 as prebuilt;
-
 #[cfg(feature = "api-4-1-3")]
 pub use gdextension_api::version_4_1_3 as prebuilt;
-
 #[cfg(feature = "api-4-1-4")]
 pub use gdextension_api::version_4_1_4 as prebuilt;
-
 #[cfg(feature = "api-4-2")]
 pub use gdextension_api::version_4_2 as prebuilt;
-
 #[cfg(feature = "api-4-2-1")]
 pub use gdextension_api::version_4_2_1 as prebuilt;
-
 #[cfg(feature = "api-4-2-2")]
 pub use gdextension_api::version_4_2_2 as prebuilt;
-
 #[cfg(feature = "api-4-3")]
 pub use gdextension_api::version_4_3 as prebuilt;
-
 #[cfg(feature = "api-4-4")]
 pub use gdextension_api::version_4_4 as prebuilt;
-
 // ]]
 
 // If none of the api-* features are provided, use default prebuilt version (typically latest Godot stable release).

godot-bindings/src/lib.rs

@@ -48,9 +48,10 @@ mod godot_version;
 #[cfg(feature = "api-custom")]
 #[path = ""]
 mod depend_on_custom {
-    use super::*;
     use std::borrow::Cow;
 
+    use super::*;
+
     pub(crate) mod godot_exe;
     pub(crate) mod godot_version;
     pub(crate) mod header_gen;
@@ -82,10 +83,10 @@ pub use depend_on_custom::*;
 #[cfg(feature = "api-custom-json")]
 #[path = ""]
 mod depend_on_custom_json {
-    use super::*;
-
     use std::borrow::Cow;
 
+    use super::*;
+
     pub(crate) mod godot_json;
     pub(crate) mod godot_version;
     pub(crate) mod header_gen;

godot-bindings/src/watch.rs

@@ -6,12 +6,10 @@
  */
 
 use std::fs::File;
-use std::io::BufWriter;
+use std::io::{BufWriter, Write};
 use std::path::Path;
 use std::time::{Duration, Instant};
 
-use std::io::Write;
-
 pub struct StopWatch {
     last_instant: Instant,
     metrics: Vec<Metric>,

godot-cell/src/borrow_state.rs

@@ -18,7 +18,7 @@
 /// If a catastrophic error occurs, then the state will be poisoned. If the state is poisoned then that's
 /// almost certainly an implementation bug, and should never happen. But in an abundance of caution it is
 /// included to be safe.
-#[derive(Debug, Clone, PartialEq)]
+#[derive(Clone, PartialEq, Debug)]
 pub struct BorrowState {
     /// The number of `&T` references that are tracked.
     shared_count: usize,
@@ -267,7 +267,7 @@ impl Default for BorrowState {
     }
 }
 
-#[derive(Debug, Clone, PartialEq, Eq)]
+#[derive(Clone, Eq, PartialEq, Debug)]
 pub enum BorrowStateErr {
     Poisoned(String),
     IsPoisoned,
@@ -300,16 +300,19 @@ impl From<String> for BorrowStateErr {
 
 #[cfg(all(test, feature = "proptest"))]
 mod proptests {
+    use proptest::arbitrary::Arbitrary;
+    use proptest::collection::vec;
+    use proptest::prelude::*;
+
     use super::*;
-    use proptest::{arbitrary::Arbitrary, collection::vec, prelude::*};
 
     impl BorrowState {
         fn has_shared_reference(&self) -> bool {
             self.shared_count > 0
         }
     }
 
-    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
+    #[derive(Copy, Clone, Eq, PartialEq, Debug)]
     enum Operation {
         IncShared,
         DecShared,
@@ -362,7 +365,7 @@ mod proptests {
         }
     }
 
-    #[derive(Debug, Clone, PartialEq, Eq)]
+    #[derive(Clone, Eq, PartialEq, Debug)]
     struct OperationExecutor {
         vec: Vec<Operation>,
     }

godot-cell/tests/mock/blocking.rs

@@ -12,7 +12,8 @@
 use std::collections::HashMap;
 use std::error::Error;
 use std::marker::PhantomData;
-use std::sync::{atomic::AtomicUsize, Mutex, OnceLock};
+use std::sync::atomic::AtomicUsize;
+use std::sync::{Mutex, OnceLock};
 use std::time::Duration;
 
 use godot_cell::blocking::{GdCell, InaccessibleGuard};

godot-cell/tests/mock/panicking.rs

@@ -12,7 +12,8 @@
 use std::collections::HashMap;
 use std::error::Error;
 use std::marker::PhantomData;
-use std::sync::{atomic::AtomicUsize, Mutex, OnceLock};
+use std::sync::atomic::AtomicUsize;
+use std::sync::{Mutex, OnceLock};
 
 use godot_cell::panicking::{GdCell, InaccessibleGuard};