enable nullable annotations for most of the SMAPI toolkit (#837)

6 files changed, 11 insertions, 19 deletions

diff --git a/src/SMAPI/Framework/Serialization/ColorConverter.cs b/src/SMAPI/Framework/Serialization/ColorConverter.cs
index 8fb6cd9c..3b3720b5 100644
--- a/src/SMAPI/Framework/Serialization/ColorConverter.cs
+++ b/src/SMAPI/Framework/Serialization/ColorConverter.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using System;
 using Microsoft.Xna.Framework;
 using Newtonsoft.Json.Linq;
diff --git a/src/SMAPI/Framework/Serialization/KeybindConverter.cs b/src/SMAPI/Framework/Serialization/KeybindConverter.cs
index 9cf52228..f3bab20d 100644
--- a/src/SMAPI/Framework/Serialization/KeybindConverter.cs
+++ b/src/SMAPI/Framework/Serialization/KeybindConverter.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using System;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
@@ -38,7 +36,7 @@ namespace StardewModdingAPI.Framework.Serialization
         /// <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)
+        public override object ReadJson(JsonReader reader, Type objectType, object? existingValue, JsonSerializer serializer)
         {
             string path = reader.Path;
 
@@ -76,7 +74,7 @@ namespace StardewModdingAPI.Framework.Serialization
         /// <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)
+        public override void WriteJson(JsonWriter writer, object? value, JsonSerializer serializer)
         {
             writer.WriteValue(value?.ToString());
         }
diff --git a/src/SMAPI/Framework/Serialization/PointConverter.cs b/src/SMAPI/Framework/Serialization/PointConverter.cs
index b48d757a..21d1f845 100644
--- a/src/SMAPI/Framework/Serialization/PointConverter.cs
+++ b/src/SMAPI/Framework/Serialization/PointConverter.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using System;
 using Microsoft.Xna.Framework;
 using Newtonsoft.Json.Linq;
diff --git a/src/SMAPI/Framework/Serialization/RectangleConverter.cs b/src/SMAPI/Framework/Serialization/RectangleConverter.cs
index 7f060e3a..31f3ad77 100644
--- a/src/SMAPI/Framework/Serialization/RectangleConverter.cs
+++ b/src/SMAPI/Framework/Serialization/RectangleConverter.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using System;
 using System.Text.RegularExpressions;
 using Microsoft.Xna.Framework;
diff --git a/src/SMAPI/Framework/Serialization/Vector2Converter.cs b/src/SMAPI/Framework/Serialization/Vector2Converter.cs
index bcd483d3..589febf8 100644
--- a/src/SMAPI/Framework/Serialization/Vector2Converter.cs
+++ b/src/SMAPI/Framework/Serialization/Vector2Converter.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 using System;
 using Microsoft.Xna.Framework;
 using Newtonsoft.Json.Linq;
diff --git a/src/SMAPI/Utilities/PathUtilities.cs b/src/SMAPI/Utilities/PathUtilities.cs
index e8ab9645..4350f441 100644
--- a/src/SMAPI/Utilities/PathUtilities.cs
+++ b/src/SMAPI/Utilities/PathUtilities.cs
@@ -1,5 +1,4 @@
-#nullable disable
-
+using System.Diagnostics.CodeAnalysis;
 using System.Diagnostics.Contracts;
 using ToolkitPathUtilities = StardewModdingAPI.Toolkit.Utilities.PathUtilities;
 
@@ -22,14 +21,16 @@ namespace StardewModdingAPI.Utilities
         /// <param name="path">The path to split.</param>
         /// <param name="limit">The number of segments to match. Any additional segments will be merged into the last returned part.</param>
         [Pure]
-        public static string[] GetSegments(string path, int? limit = null)
+        public static string[] GetSegments(string? path, int? limit = null)
         {
             return ToolkitPathUtilities.GetSegments(path, limit);
         }
 
         /// <summary>Normalize an asset name to match how MonoGame's content APIs would normalize and cache it.</summary>
         /// <param name="assetName">The asset name to normalize.</param>
-        public static string NormalizeAssetName(string assetName)
+        [Pure]
+        [return: NotNullIfNotNull("assetName")]
+        public static string? NormalizeAssetName(string? assetName)
         {
             return ToolkitPathUtilities.NormalizeAssetName(assetName);
         }
@@ -38,7 +39,8 @@ namespace StardewModdingAPI.Utilities
         /// <param name="path">The file path to normalize.</param>
         /// <remarks>This should only be used for file paths. For asset names, use <see cref="NormalizeAssetName"/> instead.</remarks>
         [Pure]
-        public static string NormalizePath(string path)
+        [return: NotNullIfNotNull("path")]
+        public static string? NormalizePath(string? path)
         {
             return ToolkitPathUtilities.NormalizePath(path);
         }
@@ -46,7 +48,7 @@ namespace StardewModdingAPI.Utilities
         /// <summary>Get whether a path is relative and doesn't try to climb out of its containing folder (e.g. doesn't contain <c>../</c>).</summary>
         /// <param name="path">The path to check.</param>
         [Pure]
-        public static bool IsSafeRelativePath(string path)
+        public static bool IsSafeRelativePath(string? path)
         {
             return ToolkitPathUtilities.IsSafeRelativePath(path);
         }
@@ -54,7 +56,7 @@ namespace StardewModdingAPI.Utilities
         /// <summary>Get whether a string is a valid 'slug', containing only basic characters that are safe in all contexts (e.g. filenames, URLs, etc).</summary>
         /// <param name="str">The string to check.</param>
         [Pure]
-        public static bool IsSlug(string str)
+        public static bool IsSlug(string? str)
         {
             return ToolkitPathUtilities.IsSlug(str);
         }