From 0b03b4f16a446e4b139efd33f6378598ae66efee Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Wed, 7 Nov 2018 12:04:20 -0500
Subject: deprecate old manifest version format

---
 src/SMAPI/Framework/SCore.cs                                       | 6 ++++++
 src/StardewModdingAPI.Toolkit/SemanticVersion.cs                   | 7 ++++++-
 .../Serialisation/Converters/SemanticVersionConverter.cs           | 2 +-
 3 files changed, 13 insertions(+), 2 deletions(-)

(limited to 'src')

diff --git a/src/SMAPI/Framework/SCore.cs b/src/SMAPI/Framework/SCore.cs
index 3e8766c2..6cb564ce 100644
--- a/src/SMAPI/Framework/SCore.cs
+++ b/src/SMAPI/Framework/SCore.cs
@@ -895,6 +895,12 @@ namespace StardewModdingAPI.Framework
                 return false;
             }
 
+            // add deprecation warning for old version format
+            {
+                if (mod.Manifest?.Version is Toolkit.SemanticVersion version && version.IsLegacyFormat)
+                    this.DeprecationManager.Warn(mod.DisplayName, "non-string manifest version", "2.8", DeprecationLevel.Notice);
+            }
+
             // validate dependencies
             // Although dependences are validated before mods are loaded, a dependency may have failed to load.
             if (mod.Manifest.Dependencies?.Any() == true)
diff --git a/src/StardewModdingAPI.Toolkit/SemanticVersion.cs b/src/StardewModdingAPI.Toolkit/SemanticVersion.cs
index 32fea3d7..de33df2f 100644
--- a/src/StardewModdingAPI.Toolkit/SemanticVersion.cs
+++ b/src/StardewModdingAPI.Toolkit/SemanticVersion.cs
@@ -42,6 +42,9 @@ namespace StardewModdingAPI.Toolkit
         /// <summary>An optional prerelease tag.</summary>
         public string Build { get; }
 
+        /// <summary>Whether the version was parsed from the legacy object format.</summary>
+        public bool IsLegacyFormat { get; }
+
 
         /*********
         ** Public methods
@@ -51,12 +54,14 @@ namespace StardewModdingAPI.Toolkit
         /// <param name="minor">The minor version incremented for backwards-compatible changes.</param>
         /// <param name="patch">The patch version for backwards-compatible fixes.</param>
         /// <param name="tag">An optional prerelease tag.</param>
-        public SemanticVersion(int major, int minor, int patch, string tag = null)
+        /// <param name="isLegacyFormat">Whether the version was parsed from the legacy object format.</param>
+        public SemanticVersion(int major, int minor, int patch, string tag = null, bool isLegacyFormat = false)
         {
             this.MajorVersion = major;
             this.MinorVersion = minor;
             this.PatchVersion = patch;
             this.Build = this.GetNormalisedTag(tag);
+            this.IsLegacyFormat = isLegacyFormat;
 
             this.AssertValid();
         }
diff --git a/src/StardewModdingAPI.Toolkit/Serialisation/Converters/SemanticVersionConverter.cs b/src/StardewModdingAPI.Toolkit/Serialisation/Converters/SemanticVersionConverter.cs
index 070f2c97..e0e185c9 100644
--- a/src/StardewModdingAPI.Toolkit/Serialisation/Converters/SemanticVersionConverter.cs
+++ b/src/StardewModdingAPI.Toolkit/Serialisation/Converters/SemanticVersionConverter.cs
@@ -70,7 +70,7 @@ namespace StardewModdingAPI.Toolkit.Serialisation.Converters
             if (build == "0")
                 build = null; // '0' from incorrect examples in old SMAPI documentation
 
-            return new SemanticVersion(major, minor, patch, build);
+            return new SemanticVersion(major, minor, patch, build, isLegacyFormat: true);
         }
 
         /// <summary>Read a JSON string.</summary>
-- 
cgit