Add .rustfmt.toml; manual tweaks to imports

Bromeon · Bromeon · commit 5d823392f932 · 2025-08-10T12:32:56.000+02:00
diff --git a/.rustfmt.toml b/.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"
diff --git a/godot-bindings/src/godot_json.rs b/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] [[
diff --git a/godot-bindings/src/import.rs b/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).
diff --git a/godot-core/src/builtin/collections/mod.rs b/godot-core/src/builtin/collections/mod.rs
@@ -18,6 +18,7 @@ pub(crate) mod containers {
 }
 
 // Re-export in godot::builtin::iter.
+#[rustfmt::skip] // Individual lines.
 pub(crate) mod iterators {
     pub use super::array::Iter as ArrayIter;
     pub use super::dictionary::Iter as DictIter;
diff --git a/godot-core/src/builtin/mod.rs b/godot-core/src/builtin/mod.rs
@@ -24,10 +24,9 @@ pub use crate::{array, dict, real, reals, varray, vdict};
 
 #[doc(hidden)]
 pub mod __prelude_reexport {
+    #[rustfmt::skip] // Do not reorder.
     use super::*;
-    
-    // ------------------------------------------------------------------------------------------------------------------------------------------
-    
+
     pub use aabb::*;
     pub use basis::*;
     pub use callable::*;
@@ -51,10 +50,9 @@ pub mod __prelude_reexport {
     pub use super::math::XformInv;
     pub use super::{EulerOrder, Side, VariantOperator, VariantType};
     pub use crate::{array, real, reals, varray, vdict, vslice};
-    
-    // ------------------------------------------------------------------------------------------------------------------------------------------
-    
+
     #[allow(deprecated)]
+    #[rustfmt::skip] // Do not reorder.
     pub use crate::dict;
 }
 
diff --git a/godot-core/src/builtin/real.rs b/godot-core/src/builtin/real.rs
@@ -164,6 +164,7 @@ mod real_mod {
 }
 
 // Public symbols (note that macro `real!` is re-exported in `lib.rs`)
+#[rustfmt::skip] // Do not reorder.
 pub use real_mod::{real, real_consts};
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
diff --git a/godot-core/src/classes/mod.rs b/godot-core/src/classes/mod.rs
@@ -22,7 +22,6 @@ mod match_class;
 
 // Re-exports all generated classes, interface traits and sidecar modules.
 pub use crate::gen::classes::*;
-
 // Macro re-export.
 pub use crate::match_class;
 
diff --git a/godot-core/src/global/mod.rs b/godot-core/src/global/mod.rs
@@ -42,19 +42,19 @@
 
 mod print;
 
-pub use crate::{
-    godot_error, godot_print, godot_print_rich, godot_script_error, godot_str, godot_warn,
-};
-
 // Some enums are directly re-exported from crate::builtin.
 pub use crate::gen::central::global_enums::*;
 pub use crate::gen::utilities::*;
+pub use crate::{
+    godot_error, godot_print, godot_print_rich, godot_script_error, godot_str, godot_warn,
+};
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 // Internal re-exports
 
 // This is needed for generated classes to find symbols, even those that have been moved to crate::builtin.
 #[allow(unused_imports)] // micromanaging imports for generated code is not fun
+#[rustfmt::skip] // Do not reorder.
 pub(crate) use crate::builtin::{Corner, EulerOrder, Side};
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
diff --git a/godot-core/src/init/mod.rs b/godot-core/src/init/mod.rs
@@ -5,20 +5,20 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
-use std::sync::atomic::{AtomicBool, Ordering::Relaxed};
+use std::sync::atomic::{AtomicBool, Ordering};
 
 use godot_ffi as sys;
-
 use sys::GodotFfi;
 
 use crate::builtin::{GString, StringName};
 use crate::out;
 
-pub use sys::GdextBuild;
-
-pub use sys::is_main_thread;
-#[cfg(not(wasm_nothreads))]
-pub use sys::main_thread_id;
+mod reexport_pub {
+    #[cfg(not(wasm_nothreads))]
+    pub use super::sys::main_thread_id;
+    pub use super::sys::{is_main_thread, GdextBuild};
+}
+pub use reexport_pub::*;
 
 #[doc(hidden)]
 #[deny(unsafe_op_in_unsafe_fn)]
@@ -101,13 +101,13 @@ unsafe extern "C" fn ffi_initialize_layer<E: ExtensionLibrary>(
 
         // TODO: Remove this workaround once after the upstream issue is resolved.
         if level == InitLevel::Scene {
-            if !LEVEL_SERVERS_CORE_LOADED.load(Relaxed) {
+            if !LEVEL_SERVERS_CORE_LOADED.load(Ordering::Relaxed) {
                 try_load::<E>(InitLevel::Core);
                 try_load::<E>(InitLevel::Servers);
             }
         } else if level == InitLevel::Core {
             // When it's normal initialization, the `Servers` level is normally initialized.
-            LEVEL_SERVERS_CORE_LOADED.store(true, Relaxed);
+            LEVEL_SERVERS_CORE_LOADED.store(true, Ordering::Relaxed);
         }
 
         // SAFETY: Godot will call this from the main thread, after `__gdext_load_library` where the library is initialized,
@@ -133,7 +133,7 @@ unsafe extern "C" fn ffi_deinitialize_layer<E: ExtensionLibrary>(
     let _ = crate::private::handle_panic(ctx, || {
         if level == InitLevel::Core {
             // Once the CORE api is unloaded, reset the flag to initial state.
-            LEVEL_SERVERS_CORE_LOADED.store(false, Relaxed);
+            LEVEL_SERVERS_CORE_LOADED.store(false, Ordering::Relaxed);
         }
 
         E::on_level_deinit(level);
diff --git a/godot-core/src/meta/mod.rs b/godot-core/src/meta/mod.rs
@@ -59,35 +59,38 @@ pub(crate) mod sealed;
 pub mod error;
 pub mod inspect;
 
+// Public re-exports
 pub use args::*;
 pub use class_name::ClassName;
 pub use godot_convert::{FromGodot, GodotConvert, ToGodot};
+pub use method_info::MethodInfo;
 pub use param_tuple::{InParamTuple, OutParamTuple, ParamTuple};
+pub use property_info::{PropertyHintInfo, PropertyInfo};
+#[cfg(feature = "trace")]
+pub use signature::trace;
+#[doc(hidden)]
+pub use signature::*;
 pub use traits::{ArrayElement, GodotType, PackedArrayElement};
 pub use uniform_object_deref::UniformObjectDeref;
 
-pub(crate) use array_type_info::ArrayTypeInfo;
-pub(crate) use traits::{
-    element_godot_type_name, element_variant_type, ffi_variant_type, ExtVariantType,
-    GodotFfiVariant, GodotNullableFfi,
-};
-
-use crate::registry::method::MethodParamOrReturnInfo;
-
-pub(crate) use crate::{
-    arg_into_ref, declare_arg_method, impl_asarg_by_ref, impl_asarg_by_value, impl_godot_as_self,
-};
 // Public due to signals emit() needing it. Should be made pub(crate) again if that changes.
 pub use crate::arg_into_owned;
 
-#[doc(hidden)]
-pub use signature::*;
-
-#[cfg(feature = "trace")]
-pub use signature::trace;
-
-pub use method_info::MethodInfo;
-pub use property_info::{PropertyHintInfo, PropertyInfo};
+// Crate-local re-exports
+mod reexport_crate {
+    pub(crate) use super::array_type_info::ArrayTypeInfo;
+    pub(crate) use super::traits::{
+        element_godot_type_name, element_variant_type, ffi_variant_type, ExtVariantType,
+        GodotFfiVariant, GodotNullableFfi,
+    };
+    // Private imports for this module only.
+    pub(super) use crate::registry::method::MethodParamOrReturnInfo;
+    pub(crate) use crate::{
+        arg_into_ref, declare_arg_method, impl_asarg_by_ref, impl_asarg_by_value,
+        impl_godot_as_self,
+    };
+}
+pub(crate) use reexport_crate::*;
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 
diff --git a/godot-core/src/meta/traits.rs b/godot-core/src/meta/traits.rs
@@ -17,10 +17,8 @@ use crate::meta::{
 use crate::registry::method::MethodParamOrReturnInfo;
 use crate::registry::property::builtin_type_string;
 
-// ----------------------------------------------------------------------------------------------------------------------------------------------
-// Public re-exports
-
 // Re-export sys traits in this module, so all are in one place.
+#[rustfmt::skip] // Do not reorder.
 pub use sys::{ExtVariantType, GodotFfi, GodotNullableFfi};
 
 /// Conversion of [`GodotFfi`] types to/from [`Variant`].
diff --git a/godot-core/src/obj/script.rs b/godot-core/src/obj/script.rs
@@ -12,31 +12,34 @@
 //!
 //! See [`ScriptInstance`](trait.ScriptInstance.html) for usage.
 
-// Re-export guards.
-pub use crate::obj::guards::{ScriptBaseMut, ScriptBaseRef};
-
 use std::ffi::c_void;
 use std::ops::{Deref, DerefMut};
 
-#[cfg(not(feature = "experimental-threads"))]
-use godot_cell::panicking::{GdCell, MutGuard, RefGuard};
-
 #[cfg(feature = "experimental-threads")]
 use godot_cell::blocking::{GdCell, MutGuard, RefGuard};
+#[cfg(not(feature = "experimental-threads"))]
+use godot_cell::panicking::{GdCell, MutGuard, RefGuard};
 
 use crate::builtin::{GString, StringName, Variant, VariantType};
 use crate::classes::{Object, Script, ScriptLanguage};
 use crate::meta::{MethodInfo, PropertyInfo};
 use crate::obj::{Base, Gd, GodotClass};
 use crate::sys;
 
-#[cfg(before_api = "4.3")]
-use self::bounded_ptr_list::BoundedPtrList;
+// ----------------------------------------------------------------------------------------------------------------------------------------------
+// Public re-exports.
 
+// Godot 4.2+.
 #[cfg(since_api = "4.2")]
-use crate::classes::IScriptExtension;
+mod reexport_4_2 {
+    pub use crate::classes::IScriptExtension;
+    pub use crate::obj::Inherits;
+}
 #[cfg(since_api = "4.2")]
-use crate::obj::Inherits;
+pub use reexport_4_2::*;
+
+// Re-export guards.
+pub use crate::obj::guards::{ScriptBaseMut, ScriptBaseRef};
 
 /// Implement custom scripts that can be attached to objects in Godot.
 ///
@@ -602,21 +605,24 @@ mod bounded_ptr_list {
     }
 }
 
+#[cfg(before_api = "4.3")]
+use self::bounded_ptr_list::BoundedPtrList;
+
 #[deny(unsafe_op_in_unsafe_fn)]
 mod script_instance_info {
     use std::any::type_name;
     use std::ffi::c_void;
 
-    use crate::builtin::{StringName, Variant};
-    use crate::private::handle_panic;
-    use crate::sys;
-
-    use super::{ScriptInstance, ScriptInstanceData, SiMut};
-    use crate::meta::{MethodInfo, PropertyInfo};
     use sys::conv::{bool_to_sys, SYS_FALSE, SYS_TRUE};
     #[cfg(since_api = "4.3")]
     use sys::conv::{ptr_list_from_sys, ptr_list_into_sys};
 
+    use super::{ScriptInstance, ScriptInstanceData, SiMut};
+    use crate::builtin::{StringName, Variant};
+    use crate::meta::{MethodInfo, PropertyInfo};
+    use crate::private::handle_panic;
+    use crate::sys;
+
     /// # Safety
     ///
     /// - `p_instance` must point to a live immutable [`ScriptInstanceData<T>`] for the duration of this function call
diff --git a/godot-core/src/private.rs b/godot-core/src/private.rs
@@ -7,33 +7,36 @@
 
 #[cfg(debug_assertions)]
 use std::cell::RefCell;
+use std::io::Write;
+use std::sync::atomic;
+
+use sys::Global;
 
 use crate::global::godot_error;
 use crate::meta::error::CallError;
 use crate::meta::CallContext;
 use crate::obj::Gd;
 use crate::{classes, sys};
-use std::io::Write;
-use std::sync::atomic;
-use sys::Global;
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 // Public re-exports
 
-pub use crate::gen::classes::class_macros;
-pub use crate::obj::rtti::ObjectRtti;
-pub use crate::registry::callbacks;
-pub use crate::registry::plugin::{
-    ClassPlugin, DynTraitImpl, ErasedDynGd, ErasedRegisterFn, ITraitImpl, InherentImpl, PluginItem,
-    Struct,
-};
-#[cfg(since_api = "4.2")]
-pub use crate::registry::signal::priv_re_export::*;
-pub use crate::storage::{as_storage, Storage};
-pub use sys::out;
-
-#[cfg(feature = "trace")]
-pub use crate::meta::trace;
+mod reexport_pub {
+    pub use crate::gen::classes::class_macros;
+    #[cfg(feature = "trace")]
+    pub use crate::meta::trace;
+    pub use crate::obj::rtti::ObjectRtti;
+    pub use crate::registry::callbacks;
+    pub use crate::registry::plugin::{
+        ClassPlugin, DynTraitImpl, ErasedDynGd, ErasedRegisterFn, ITraitImpl, InherentImpl,
+        PluginItem, Struct,
+    };
+    #[cfg(since_api = "4.2")]
+    pub use crate::registry::signal::priv_re_export::*;
+    pub use crate::storage::{as_storage, Storage};
+    pub use crate::sys::out;
+}
+pub use reexport_pub::*;
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 // Global variables
diff --git a/godot-core/src/task/futures.rs b/godot-core/src/task/futures.rs
diff --git a/godot-core/src/task/mod.rs b/godot-core/src/task/mod.rs
diff --git a/godot-ffi/src/binding/mod.rs b/godot-ffi/src/binding/mod.rs

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ pub(crate) mod containers {`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`// Re-export in godot::builtin::iter.`
	`21`	`+#[rustfmt::skip] // Individual lines.`
`21`	`22`	`pub(crate) mod iterators {`
`22`	`23`	`pub use super::array::Iter as ArrayIter;`
`23`	`24`	`pub use super::dictionary::Iter as DictIter;`
Original file line number	Diff line number	Diff line change
`@@ -164,6 +164,7 @@ mod real_mod {`
`164`	`164`	`}`
`165`	`165`
`166`	`166`	// Public symbols (note that macro `real!` is re-exported in `lib.rs`)
	`167`	`+#[rustfmt::skip] // Do not reorder.`
`167`	`168`	`pub use real_mod::{real, real_consts};`
`168`	`169`
`169`	`170`	`// ----------------------------------------------------------------------------------------------------------------------------------------------`