From 0b48c1748b354458059c7607415288de072b01e9 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Tue, 12 Apr 2022 19:15:39 -0400
Subject: enable nullable annotations in the web project & related code (#837)

---
 src/SMAPI.Web/Framework/Caching/Wiki/IWikiCacheRepository.cs  |  9 ++++-----
 .../Framework/Caching/Wiki/WikiCacheMemoryRepository.cs       | 11 +++++------
 src/SMAPI.Web/Framework/Caching/Wiki/WikiMetadata.cs          | 11 +++--------
 3 files changed, 12 insertions(+), 19 deletions(-)

(limited to 'src/SMAPI.Web/Framework/Caching/Wiki')

diff --git a/src/SMAPI.Web/Framework/Caching/Wiki/IWikiCacheRepository.cs b/src/SMAPI.Web/Framework/Caching/Wiki/IWikiCacheRepository.cs
index 6edafddc..b8a0df34 100644
--- a/src/SMAPI.Web/Framework/Caching/Wiki/IWikiCacheRepository.cs
+++ b/src/SMAPI.Web/Framework/Caching/Wiki/IWikiCacheRepository.cs
@@ -1,7 +1,6 @@
-#nullable disable
-
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using StardewModdingAPI.Toolkit.Framework.Clients.Wiki;
 
 namespace StardewModdingAPI.Web.Framework.Caching.Wiki
@@ -14,16 +13,16 @@ namespace StardewModdingAPI.Web.Framework.Caching.Wiki
         *********/
         /// <summary>Get the cached wiki metadata.</summary>
         /// <param name="metadata">The fetched metadata.</param>
-        bool TryGetWikiMetadata(out Cached<WikiMetadata> metadata);
+        bool TryGetWikiMetadata([NotNullWhen(true)] out Cached<WikiMetadata>? metadata);
 
         /// <summary>Get the cached wiki mods.</summary>
         /// <param name="filter">A filter to apply, if any.</param>
-        IEnumerable<Cached<WikiModEntry>> GetWikiMods(Func<WikiModEntry, bool> filter = null);
+        IEnumerable<Cached<WikiModEntry>> GetWikiMods(Func<WikiModEntry, bool>? filter = null);
 
         /// <summary>Save data fetched from the wiki compatibility list.</summary>
         /// <param name="stableVersion">The current stable Stardew Valley version.</param>
         /// <param name="betaVersion">The current beta Stardew Valley version.</param>
         /// <param name="mods">The mod data.</param>
-        void SaveWikiData(string stableVersion, string betaVersion, IEnumerable<WikiModEntry> mods);
+        void SaveWikiData(string? stableVersion, string? betaVersion, IEnumerable<WikiModEntry> mods);
     }
 }
diff --git a/src/SMAPI.Web/Framework/Caching/Wiki/WikiCacheMemoryRepository.cs b/src/SMAPI.Web/Framework/Caching/Wiki/WikiCacheMemoryRepository.cs
index d1ccb9c7..8b4338e2 100644
--- a/src/SMAPI.Web/Framework/Caching/Wiki/WikiCacheMemoryRepository.cs
+++ b/src/SMAPI.Web/Framework/Caching/Wiki/WikiCacheMemoryRepository.cs
@@ -1,7 +1,6 @@
-#nullable disable
-
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using StardewModdingAPI.Toolkit.Framework.Clients.Wiki;
 
@@ -14,7 +13,7 @@ namespace StardewModdingAPI.Web.Framework.Caching.Wiki
         ** Fields
         *********/
         /// <summary>The saved wiki metadata.</summary>
-        private Cached<WikiMetadata> Metadata;
+        private Cached<WikiMetadata>? Metadata;
 
         /// <summary>The cached wiki data.</summary>
         private Cached<WikiModEntry>[] Mods = Array.Empty<Cached<WikiModEntry>>();
@@ -25,7 +24,7 @@ namespace StardewModdingAPI.Web.Framework.Caching.Wiki
         *********/
         /// <summary>Get the cached wiki metadata.</summary>
         /// <param name="metadata">The fetched metadata.</param>
-        public bool TryGetWikiMetadata(out Cached<WikiMetadata> metadata)
+        public bool TryGetWikiMetadata([NotNullWhen(true)] out Cached<WikiMetadata>? metadata)
         {
             metadata = this.Metadata;
             return metadata != null;
@@ -33,7 +32,7 @@ namespace StardewModdingAPI.Web.Framework.Caching.Wiki
 
         /// <summary>Get the cached wiki mods.</summary>
         /// <param name="filter">A filter to apply, if any.</param>
-        public IEnumerable<Cached<WikiModEntry>> GetWikiMods(Func<WikiModEntry, bool> filter = null)
+        public IEnumerable<Cached<WikiModEntry>> GetWikiMods(Func<WikiModEntry, bool>? filter = null)
         {
             foreach (var mod in this.Mods)
             {
@@ -46,7 +45,7 @@ namespace StardewModdingAPI.Web.Framework.Caching.Wiki
         /// <param name="stableVersion">The current stable Stardew Valley version.</param>
         /// <param name="betaVersion">The current beta Stardew Valley version.</param>
         /// <param name="mods">The mod data.</param>
-        public void SaveWikiData(string stableVersion, string betaVersion, IEnumerable<WikiModEntry> mods)
+        public void SaveWikiData(string? stableVersion, string? betaVersion, IEnumerable<WikiModEntry> mods)
         {
             this.Metadata = new Cached<WikiMetadata>(new WikiMetadata(stableVersion, betaVersion));
             this.Mods = mods.Select(mod => new Cached<WikiModEntry>(mod)).ToArray();
diff --git a/src/SMAPI.Web/Framework/Caching/Wiki/WikiMetadata.cs b/src/SMAPI.Web/Framework/Caching/Wiki/WikiMetadata.cs
index 6ae42488..f53ea201 100644
--- a/src/SMAPI.Web/Framework/Caching/Wiki/WikiMetadata.cs
+++ b/src/SMAPI.Web/Framework/Caching/Wiki/WikiMetadata.cs
@@ -1,5 +1,3 @@
-#nullable disable
-
 namespace StardewModdingAPI.Web.Framework.Caching.Wiki
 {
     /// <summary>The model for cached wiki metadata.</summary>
@@ -9,22 +7,19 @@ namespace StardewModdingAPI.Web.Framework.Caching.Wiki
         ** Accessors
         *********/
         /// <summary>The current stable Stardew Valley version.</summary>
-        public string StableVersion { get; set; }
+        public string? StableVersion { get; }
 
         /// <summary>The current beta Stardew Valley version.</summary>
-        public string BetaVersion { get; set; }
+        public string? BetaVersion { get; }
 
 
         /*********
         ** Public methods
         *********/
-        /// <summary>Construct an instance.</summary>
-        public WikiMetadata() { }
-
         /// <summary>Construct an instance.</summary>
         /// <param name="stableVersion">The current stable Stardew Valley version.</param>
         /// <param name="betaVersion">The current beta Stardew Valley version.</param>
-        public WikiMetadata(string stableVersion, string betaVersion)
+        public WikiMetadata(string? stableVersion, string? betaVersion)
         {
             this.StableVersion = stableVersion;
             this.BetaVersion = betaVersion;
-- 
cgit