add support for writing versions to JSON

docs/release-notes.md

@@ -44,6 +44,7 @@
   * Added Harmony DLL for internal use by SMAPI. (Mods should still include their own copy for backwards compatibility, and in case it's removed later. SMAPI will always load its own version though.)
   * Added option to suppress update checks for a specific mod in `StardewModdingAPI.config.json`.
   * Added absolute pixels to `ICursorPosition`.
+  * Added support for reading/writing `ISemanticVersion` to JSON.
   * Update checks now use the update key order when deciding which to link to.
   * Fixed error if a mod loads a PNG while the game is loading (e.g. custom map tilesheets via `IAssetLoader`).
   * Fixed assets loaded by temporary content managers not being editable by mods.

src/SMAPI.Web/Startup.cs

@@ -7,6 +7,7 @@ using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Newtonsoft.Json;
+using StardewModdingAPI.Toolkit.Serialisation;
 using StardewModdingAPI.Web.Framework;
 using StardewModdingAPI.Web.Framework.Clients.Chucklefish;
 using StardewModdingAPI.Web.Framework.Clients.GitHub;
@@ -56,6 +57,9 @@ namespace StardewModdingAPI.Web
                 .ConfigureApplicationPartManager(manager => manager.FeatureProviders.Add(new InternalControllerFeatureProvider()))
                 .AddJsonOptions(options =>
                 {
+                    foreach (JsonConverter converter in new JsonHelper().JsonSettings.Converters)
+                        options.SerializerSettings.Converters.Add(converter);
+
                     options.SerializerSettings.Formatting = Formatting.Indented;
                     options.SerializerSettings.NullValueHandling = NullValueHandling.Ignore;
                 });

src/StardewModdingAPI.Toolkit/Serialisation/Converters/SemanticVersionConverter.cs

@@ -1,17 +1,67 @@
+using System;
+using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 
 namespace StardewModdingAPI.Toolkit.Serialisation.Converters
 {
     /// <summary>Handles deserialisation of <see cref="ISemanticVersion"/>.</summary>
-    internal class SemanticVersionConverter : SimpleReadOnlyConverter<ISemanticVersion>
+    internal class SemanticVersionConverter : JsonConverter
     {
         /*********
-        ** Protected methods
+        ** Accessors
+        *********/
+        /// <summary>Get whether this converter can read JSON.</summary>
+        public override bool CanRead => true;
+
+        /// <summary>Get whether this converter can write JSON.</summary>
+        public override bool CanWrite => true;
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Get whether this instance can convert the specified object type.</summary>
+        /// <param name="objectType">The object type.</param>
+        public override bool CanConvert(Type objectType)
+        {
+            return typeof(ISemanticVersion).IsAssignableFrom(objectType);
+        }
+
+        /// <summary>Reads the JSON representation of the object.</summary>
+        /// <param name="reader">The JSON reader.</param>
+        /// <param name="objectType">The object type.</param>
+        /// <param name="existingValue">The object being read.</param>
+        /// <param name="serializer">The calling serializer.</param>
+        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
+        {
+            string path = reader.Path;
+            switch (reader.TokenType)
+            {
+                case JsonToken.StartObject:
+                    return this.ReadObject(JObject.Load(reader));
+                case JsonToken.String:
+                    return this.ReadString(JToken.Load(reader).Value<string>(), path);
+                default:
+                    throw new SParseException($"Can't parse {nameof(ISemanticVersion)} from {reader.TokenType} node (path: {reader.Path}).");
+            }
+        }
+
+        /// <summary>Writes the JSON representation of the object.</summary>
+        /// <param name="writer">The JSON writer.</param>
+        /// <param name="value">The value.</param>
+        /// <param name="serializer">The calling serializer.</param>
+        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
+        {
+            writer.WriteValue(value?.ToString());
+        }
+
+
+        /*********
+        ** Private methods
         *********/
         /// <summary>Read a JSON object.</summary>
         /// <param name="obj">The JSON object to read.</param>
-        /// <param name="path">The path to the current JSON node.</param>
-        protected override ISemanticVersion ReadObject(JObject obj, string path)
+        private ISemanticVersion ReadObject(JObject obj)
         {
             int major = obj.ValueIgnoreCase<int>("MajorVersion");
             int minor = obj.ValueIgnoreCase<int>("MinorVersion");
@@ -26,7 +76,7 @@ namespace StardewModdingAPI.Toolkit.Serialisation.Converters
         /// <summary>Read a JSON string.</summary>
         /// <param name="str">The JSON string value.</param>
         /// <param name="path">The path to the current JSON node.</param>
-        protected override ISemanticVersion ReadString(string str, string path)
+        private ISemanticVersion ReadString(string str, string path)
         {
             if (string.IsNullOrWhiteSpace(str))
                 return null;