enable nullable annotations for manifests (#837)

3 files changed, 138 insertions, 41 deletions

diff --git a/src/SMAPI.Toolkit/Serialization/Models/Manifest.cs b/src/SMAPI.Toolkit/Serialization/Models/Manifest.cs
index a5dbf604..01010602 100644
--- a/src/SMAPI.Toolkit/Serialization/Models/Manifest.cs
+++ b/src/SMAPI.Toolkit/Serialization/Models/Manifest.cs
@@ -1,8 +1,6 @@
-#nullable disable
-
 using System;
 using System.Collections.Generic;
-using System.Runtime.Serialization;
+using System.Diagnostics.CodeAnalysis;
 using Newtonsoft.Json;
 using StardewModdingAPI.Toolkit.Serialization.Converters;
 
@@ -15,48 +13,45 @@ namespace StardewModdingAPI.Toolkit.Serialization.Models
         ** Accessors
         *********/
         /// <summary>The mod name.</summary>
-        public string Name { get; set; }
+        public string Name { get; }
 
         /// <summary>A brief description of the mod.</summary>
-        public string Description { get; set; }
+        public string Description { get; }
 
         /// <summary>The mod author's name.</summary>
-        public string Author { get; set; }
+        public string Author { get; }
 
         /// <summary>The mod version.</summary>
-        public ISemanticVersion Version { get; set; }
+        public ISemanticVersion Version { get; }
 
         /// <summary>The minimum SMAPI version required by this mod, if any.</summary>
-        public ISemanticVersion MinimumApiVersion { get; set; }
+        public ISemanticVersion? MinimumApiVersion { get; }
 
         /// <summary>The name of the DLL in the directory that has the <c>Entry</c> method. Mutually exclusive with <see cref="ContentPackFor"/>.</summary>
-        public string EntryDll { get; set; }
+        public string? EntryDll { get; }
 
         /// <summary>The mod which will read this as a content pack. Mutually exclusive with <see cref="Manifest.EntryDll"/>.</summary>
         [JsonConverter(typeof(ManifestContentPackForConverter))]
-        public IManifestContentPackFor ContentPackFor { get; set; }
+        public IManifestContentPackFor? ContentPackFor { get; }
 
         /// <summary>The other mods that must be loaded before this mod.</summary>
         [JsonConverter(typeof(ManifestDependencyArrayConverter))]
-        public IManifestDependency[] Dependencies { get; set; }
+        public IManifestDependency[] Dependencies { get; }
 
         /// <summary>The namespaced mod IDs to query for updates (like <c>Nexus:541</c>).</summary>
-        public string[] UpdateKeys { get; set; }
+        public string[] UpdateKeys { get; private set; }
 
         /// <summary>The unique mod ID.</summary>
-        public string UniqueID { get; set; }
+        public string UniqueID { get; }
 
         /// <summary>Any manifest fields which didn't match a valid field.</summary>
         [JsonExtensionData]
-        public IDictionary<string, object> ExtraFields { get; set; }
+        public IDictionary<string, object> ExtraFields { get; set; } = new Dictionary<string, object>();
 
 
         /*********
         ** Public methods
         *********/
-        /// <summary>Construct an instance.</summary>
-        public Manifest() { }
-
         /// <summary>Construct an instance for a transitional content pack.</summary>
         /// <param name="uniqueID">The unique mod ID.</param>
         /// <param name="name">The mod name.</param>
@@ -64,24 +59,71 @@ namespace StardewModdingAPI.Toolkit.Serialization.Models
         /// <param name="description">A brief description of the mod.</param>
         /// <param name="version">The mod version.</param>
         /// <param name="contentPackFor">The modID which will read this as a content pack.</param>
-        public Manifest(string uniqueID, string name, string author, string description, ISemanticVersion version, string contentPackFor = null)
+        public Manifest(string uniqueID, string name, string author, string description, ISemanticVersion version, string? contentPackFor = null)
+            : this(
+                uniqueId: uniqueID,
+                name: name,
+                author: author,
+                description: description,
+                version: version,
+                minimumApiVersion: null,
+                entryDll: null,
+                contentPackFor: contentPackFor != null
+                    ? new ManifestContentPackFor(contentPackFor, null)
+                    : null,
+                dependencies: null,
+                updateKeys: null
+            )
+        { }
+
+        /// <summary>Construct an instance for a transitional content pack.</summary>
+        /// <param name="uniqueId">The unique mod ID.</param>
+        /// <param name="name">The mod name.</param>
+        /// <param name="author">The mod author's name.</param>
+        /// <param name="description">A brief description of the mod.</param>
+        /// <param name="version">The mod version.</param>
+        /// <param name="minimumApiVersion">The minimum SMAPI version required by this mod, if any.</param>
+        /// <param name="entryDll">The name of the DLL in the directory that has the <c>Entry</c> method. Mutually exclusive with <see cref="ContentPackFor"/>.</param>
+        /// <param name="contentPackFor">The modID which will read this as a content pack.</param>
+        /// <param name="dependencies">The other mods that must be loaded before this mod.</param>
+        /// <param name="updateKeys">The namespaced mod IDs to query for updates (like <c>Nexus:541</c>).</param>
+        [JsonConstructor]
+        public Manifest(string uniqueId, string name, string author, string description, ISemanticVersion version, ISemanticVersion? minimumApiVersion, string? entryDll, IManifestContentPackFor? contentPackFor, IManifestDependency[]? dependencies, string[]? updateKeys)
         {
-            this.Name = name;
-            this.Author = author;
-            this.Description = description;
+            this.UniqueID = this.NormalizeWhitespace(uniqueId);
+            this.Name = this.NormalizeWhitespace(name);
+            this.Author = this.NormalizeWhitespace(author);
+            this.Description = this.NormalizeWhitespace(description);
             this.Version = version;
-            this.UniqueID = uniqueID;
-            this.UpdateKeys = Array.Empty<string>();
-            this.ContentPackFor = new ManifestContentPackFor { UniqueID = contentPackFor };
+            this.MinimumApiVersion = minimumApiVersion;
+            this.EntryDll = this.NormalizeWhitespace(entryDll);
+            this.ContentPackFor = contentPackFor;
+            this.Dependencies = dependencies ?? Array.Empty<IManifestDependency>();
+            this.UpdateKeys = updateKeys ?? Array.Empty<string>();
+        }
+
+        /// <summary>Override the update keys loaded from the mod info.</summary>
+        /// <param name="updateKeys">The new update keys to set.</param>
+        internal void OverrideUpdateKeys(params string[] updateKeys)
+        {
+            this.UpdateKeys = updateKeys;
         }
 
-        /// <summary>Normalize the model after it's deserialized.</summary>
-        /// <param name="context">The deserialization context.</param>
-        [OnDeserialized]
-        public void OnDeserialized(StreamingContext context)
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>Normalize whitespace in a raw string.</summary>
+        /// <param name="input">The input to strip.</param>
+#if NET5_0_OR_GREATER
+        [return: NotNullIfNotNull("input")]
+#endif
+        private string? NormalizeWhitespace(string? input)
         {
-            this.Dependencies ??= Array.Empty<IManifestDependency>();
-            this.UpdateKeys ??= Array.Empty<string>();
+            return input
+                ?.Trim()
+                .Replace("\r", "")
+                .Replace("\n", "");
         }
     }
 }
diff --git a/src/SMAPI.Toolkit/Serialization/Models/ManifestContentPackFor.cs b/src/SMAPI.Toolkit/Serialization/Models/ManifestContentPackFor.cs
index ea5f0e6c..f7dc8aa8 100644
--- a/src/SMAPI.Toolkit/Serialization/Models/ManifestContentPackFor.cs
+++ b/src/SMAPI.Toolkit/Serialization/Models/ManifestContentPackFor.cs
@@ -1,4 +1,4 @@
-#nullable disable
+using System.Diagnostics.CodeAnalysis;
 
 namespace StardewModdingAPI.Toolkit.Serialization.Models
 {
@@ -9,9 +9,36 @@ namespace StardewModdingAPI.Toolkit.Serialization.Models
         ** Accessors
         *********/
         /// <summary>The unique ID of the mod which can read this content pack.</summary>
-        public string UniqueID { get; set; }
+        public string UniqueID { get; }
 
         /// <summary>The minimum required version (if any).</summary>
-        public ISemanticVersion MinimumVersion { get; set; }
+        public ISemanticVersion? MinimumVersion { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="uniqueId">The unique ID of the mod which can read this content pack.</param>
+        /// <param name="minimumVersion">The minimum required version (if any).</param>
+        public ManifestContentPackFor(string uniqueId, ISemanticVersion? minimumVersion)
+        {
+            this.UniqueID = this.NormalizeWhitespace(uniqueId);
+            this.MinimumVersion = minimumVersion;
+        }
+
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>Normalize whitespace in a raw string.</summary>
+        /// <param name="input">The input to strip.</param>
+#if NET5_0_OR_GREATER
+        [return: NotNullIfNotNull("input")]
+#endif
+        private string? NormalizeWhitespace(string? input)
+        {
+            return input?.Trim();
+        }
     }
 }
diff --git a/src/SMAPI.Toolkit/Serialization/Models/ManifestDependency.cs b/src/SMAPI.Toolkit/Serialization/Models/ManifestDependency.cs
index f52dd5ee..e7acf71d 100644
--- a/src/SMAPI.Toolkit/Serialization/Models/ManifestDependency.cs
+++ b/src/SMAPI.Toolkit/Serialization/Models/ManifestDependency.cs
@@ -1,4 +1,5 @@
-#nullable disable
+using System.Diagnostics.CodeAnalysis;
+using Newtonsoft.Json;
 
 namespace StardewModdingAPI.Toolkit.Serialization.Models
 {
@@ -9,13 +10,13 @@ namespace StardewModdingAPI.Toolkit.Serialization.Models
         ** Accessors
         *********/
         /// <summary>The unique mod ID to require.</summary>
-        public string UniqueID { get; set; }
+        public string UniqueID { get; }
 
         /// <summary>The minimum required version (if any).</summary>
-        public ISemanticVersion MinimumVersion { get; set; }
+        public ISemanticVersion? MinimumVersion { get; }
 
         /// <summary>Whether the dependency must be installed to use the mod.</summary>
-        public bool IsRequired { get; set; }
+        public bool IsRequired { get; }
 
 
         /*********
@@ -26,12 +27,39 @@ namespace StardewModdingAPI.Toolkit.Serialization.Models
         /// <param name="minimumVersion">The minimum required version (if any).</param>
         /// <param name="required">Whether the dependency must be installed to use the mod.</param>
         public ManifestDependency(string uniqueID, string minimumVersion, bool required = true)
+            : this(
+                uniqueID: uniqueID,
+                minimumVersion: !string.IsNullOrWhiteSpace(minimumVersion)
+                    ? new SemanticVersion(minimumVersion)
+                    : null,
+                required: required
+            )
+        { }
+
+        /// <summary>Construct an instance.</summary>
+        /// <param name="uniqueID">The unique mod ID to require.</param>
+        /// <param name="minimumVersion">The minimum required version (if any).</param>
+        /// <param name="required">Whether the dependency must be installed to use the mod.</param>
+        [JsonConstructor]
+        public ManifestDependency(string uniqueID, ISemanticVersion? minimumVersion, bool required = true)
         {
-            this.UniqueID = uniqueID;
-            this.MinimumVersion = !string.IsNullOrWhiteSpace(minimumVersion)
-                ? new SemanticVersion(minimumVersion)
-                : null;
+            this.UniqueID = this.NormalizeWhitespace(uniqueID);
+            this.MinimumVersion = minimumVersion;
             this.IsRequired = required;
         }
+
+
+        /*********
+        ** Private methods
+        *********/
+        /// <summary>Normalize whitespace in a raw string.</summary>
+        /// <param name="input">The input to strip.</param>
+#if NET5_0_OR_GREATER
+        [return: NotNullIfNotNull("input")]
+#endif
+        private string? NormalizeWhitespace(string? input)
+        {
+            return input?.Trim();
+        }
     }
 }