feat(codegen): Adds support for partial opt-in with already existing properties (#617)

- [X] Fixes an issue with ordering of properties in serialization.
- [X] Adds opt-in with existing properties.

Example:
```cs
private int _myExistingField;

[SerializableField(1)]
public int MyExistingProperty
{
    get => _myExistingField;
    set
    {
        if (value == 0)
        {
            Parent = null;
        }
        
        if (value != _myExistingField)
        {
            ((ISerializable)this).MarkDirty();
            _myExistingField = value;
        }
    }
}
```

Projects/SerializationGenerator/SerializableMigration/Rules/ArrayMigrationRule.cs

@@ -42,6 +42,7 @@ namespace SerializationGenerator
                 compilation,
                 "ArrayEntry",
                 arrayTypeSymbol.ElementType,
+                0,
                 attributes,
                 serializableTypes
             );

Projects/SerializationGenerator/SerializableMigration/Rules/HashSetMigrationRule.cs

@@ -44,6 +44,7 @@ namespace SerializationGenerator
                 compilation,
                 "SetEntry",
                 setTypeSymbol,
+                0,
                 attributes,
                 serializableTypes
             );

Projects/SerializationGenerator/SerializableMigration/Rules/KeyValuePairMigrationRule.cs

@@ -44,6 +44,7 @@ namespace SerializationGenerator
                 compilation,
                 "key",
                 typeArguments[0],
+                0,
                 attributes,
                 serializableTypes
             );
@@ -52,6 +53,7 @@ namespace SerializationGenerator
                 compilation,
                 "value",
                 typeArguments[1],
+                1,
                 attributes,
                 serializableTypes
             );

Projects/SerializationGenerator/SerializableMigration/Rules/ListMigrationRule.cs

@@ -44,6 +44,7 @@ namespace SerializationGenerator
                 compilation,
                 "ListEntry",
                 listTypeSymbol,
+                0,
                 attributes,
                 serializableTypes
             );

Projects/SerializationGenerator/SerializableMigration/SerializableMetadata.cs

@@ -13,20 +13,20 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  *************************************************************************/
 
-using System.Collections.Generic;
+using System.Collections.Immutable;
 using System.Text.Json.Serialization;
 
 namespace SerializationGenerator
 {
-    public class SerializableMetadata
+    public record SerializableMetadata
     {
         [JsonPropertyName("version")]
-        public int Version { get; set; }
+        public int Version { get; init; }
 
         [JsonPropertyName("type")]
-        public string Type { get; set; }
+        public string Type { get; init; }
 
         [JsonPropertyName("properties")]
-        public List<SerializableProperty> Properties { get; set; }
+        public ImmutableArray<SerializableProperty> Properties { get; init; }
     }
 }

Projects/SerializationGenerator/SerializableMigration/SerializableMigrationRulesEngine.cs

@@ -49,6 +49,7 @@ namespace SerializationGenerator
             Compilation compilation,
             string propertyName,
             ISymbol propertyType,
+            int order,
             ImmutableArray<AttributeData> attributes,
             ImmutableArray<INamedTypeSymbol> serializableTypes
         )

Projects/SerializationGenerator/SerializableMigration/SerializableProperty.cs

@@ -17,7 +17,7 @@ using System.Text.Json.Serialization;
 
 namespace SerializationGenerator
 {
-    public class SerializableProperty
+    public record SerializableProperty
     {
         [JsonPropertyName("name")]
         public string Name { get; init; }
@@ -30,5 +30,8 @@ namespace SerializationGenerator
 
         [JsonPropertyName("ruleArguments")]
         public string[] RuleArguments { get; init; }
+
+        [JsonIgnore]
+        public int Order { get; init; }
     }
 }

Projects/SerializationGenerator/SerializableMigration/SerializablePropertyComparer.cs

@@ -0,0 +1,42 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2021 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: SerializablePropertyComparer.cs                                 *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Collections.Generic;
+
+namespace SerializationGenerator
+{
+    public class SerializablePropertyComparer : IComparer<SerializableProperty>
+    {
+        public int Compare(SerializableProperty x, SerializableProperty y)
+        {
+            if (Equals(x, y))
+            {
+                return 0;
+            }
+
+            if (Equals(null, y))
+            {
+                return 1;
+            }
+
+            if (Equals(null, x))
+            {
+                return -1;
+            }
+
+            return x.Order.CompareTo(y.Order);
+        }
+    }
+}