fix: remove broken module initializer

chickensoft-games · Jun 10, 2024 · c2efc46 · c2efc46
1 parent 1769199
commit c2efc46
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 8 deletions.
diff --git a/Chickensoft.Serialization.Godot.Tests/test/src/BasisConverterTest.cs b/Chickensoft.Serialization.Godot.Tests/test/src/BasisConverterTest.cs
@@ -16,6 +16,8 @@ public void CanConvert() {
 
   [Test]
   public void Converts() {
+    GodotSerialization.Setup();
+
     var options = new JsonSerializerOptions() {
       WriteIndented = true,
       TypeInfoResolver = new SerializableTypeResolver(),

diff --git a/Chickensoft.Serialization.Godot.Tests/test/src/Transform3DConverterTest.cs b/Chickensoft.Serialization.Godot.Tests/test/src/Transform3DConverterTest.cs
@@ -16,6 +16,8 @@ public void CanConvert() {
 
   [Test]
   public void Converts() {
+    GodotSerialization.Setup();
+
     var options = new JsonSerializerOptions() {
       WriteIndented = true,
       TypeInfoResolver = new SerializableTypeResolver(),

diff --git a/Chickensoft.Serialization.Godot.Tests/test/src/Vector3ConverterTest.cs b/Chickensoft.Serialization.Godot.Tests/test/src/Vector3ConverterTest.cs
@@ -16,6 +16,8 @@ public void CanConvert() {
 
   [Test]
   public void Converts() {
+    GodotSerialization.Setup();
+
     var options = new JsonSerializerOptions() {
       WriteIndented = true,
       TypeInfoResolver = new SerializableTypeResolver(),

diff --git a/Chickensoft.Serialization.Godot/Chickensoft.Serialization.Godot.csproj b/Chickensoft.Serialization.Godot/Chickensoft.Serialization.Godot.csproj
@@ -49,6 +49,5 @@
     </PackageReference>
     <PackageReference Include="GodotSharp" Version="4.2.2" />
     <PackageReference Include="Chickensoft.Serialization" Version="1.1.0" />
-    <PackageReference Include="PolyKit" Version="3.0.9" />
   </ItemGroup>
 </Project>
diff --git a/Chickensoft.Serialization.Godot/src/GodotSerialization.cs b/Chickensoft.Serialization.Godot/src/GodotSerialization.cs
@@ -1,18 +1,16 @@
 namespace Chickensoft.Serialization.Godot;
 
-using System.Diagnostics.CodeAnalysis;
-using System.Runtime.CompilerServices;
 using Chickensoft.Serialization;
 
 /// <summary>
 /// Godot serialization.
 /// </summary>
 public static class GodotSerialization {
-#pragma warning disable CA2255
-  [ModuleInitializer]
-  [ExcludeFromCodeCoverage]
-#pragma warning restore CA2255
-  internal static void Setup() {
+  /// <summary>
+  /// Register the converters for Godot types with the Chickensoft Serialization
+  /// system.
+  /// </summary>
+  public static void Setup() {
     Serializer.AddConverter(new Vector3Converter());
     Serializer.AddConverter(new BasisConverter());
     Serializer.AddConverter(new Transform3DConverter());

diff --git a/README.md b/README.md
@@ -10,6 +10,12 @@ Please contribute! This only supports the following types:
 - ✅ `Basis`
 - ✅ `Transform3D`
 
+Be sure to place the following line somewhere before you start serializing/deserializing:
+
+```csharp
+GodotSerialization.Setup();
+```
+
 ---
 
 <p align="center">