From c24946c3993c0680153bbf9e536593cc80fc16f0 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Fri, 22 Feb 2019 21:50:09 -0500
Subject: make it clear that mods will break in SMAPI 3.0 (#606)

---
 src/SMAPI/Framework/DeprecationManager.cs | 29 ++++++++++++++++++++++++++---
 1 file changed, 26 insertions(+), 3 deletions(-)

(limited to 'src')

diff --git a/src/SMAPI/Framework/DeprecationManager.cs b/src/SMAPI/Framework/DeprecationManager.cs
index 78cf62c2..3153bbb4 100644
--- a/src/SMAPI/Framework/DeprecationManager.cs
+++ b/src/SMAPI/Framework/DeprecationManager.cs
@@ -14,7 +14,11 @@ namespace StardewModdingAPI.Framework
         private readonly HashSet<string> LoggedDeprecations = new HashSet<string>(StringComparer.InvariantCultureIgnoreCase);
 
         /// <summary>Encapsulates monitoring and logging for a given module.</summary>
+#if !SMAPI_3_0_STRICT
+        private readonly Monitor Monitor;
+#else
         private readonly IMonitor Monitor;
+#endif
 
         /// <summary>Tracks the installed mods.</summary>
         private readonly ModRegistry ModRegistry;
@@ -22,6 +26,11 @@ namespace StardewModdingAPI.Framework
         /// <summary>The queued deprecation warnings to display.</summary>
         private readonly IList<DeprecationWarning> QueuedWarnings = new List<DeprecationWarning>();
 
+#if !SMAPI_3_0_STRICT
+        /// <summary>Whether the one-time deprecation message has been shown.</summary>
+        private bool DeprecationHeaderShown = false;
+#endif
+
 
         /*********
         ** Public methods
@@ -29,7 +38,11 @@ namespace StardewModdingAPI.Framework
         /// <summary>Construct an instance.</summary>
         /// <param name="monitor">Encapsulates monitoring and logging for a given module.</param>
         /// <param name="modRegistry">Tracks the installed mods.</param>
+#if !SMAPI_3_0_STRICT
+        public DeprecationManager(Monitor monitor, ModRegistry modRegistry)
+#else
         public DeprecationManager(IMonitor monitor, ModRegistry modRegistry)
+#endif
         {
             this.Monitor = monitor;
             this.ModRegistry = modRegistry;
@@ -68,15 +81,25 @@ namespace StardewModdingAPI.Framework
         /// <summary>Print any queued messages.</summary>
         public void PrintQueued()
         {
+#if !SMAPI_3_0_STRICT
+            if (!this.DeprecationHeaderShown && this.QueuedWarnings.Any())
+            {
+                this.Monitor.Newline();
+                this.Monitor.Log("Some of your mods will break in the upcoming SMAPI 3.0. Please update your mods now, or notify the author if no update is available. See https://mods.smapi.io for links to the latest versions.", LogLevel.Warn);
+                this.Monitor.Newline();
+                this.DeprecationHeaderShown = true;
+            }
+#endif
+
             foreach (DeprecationWarning warning in this.QueuedWarnings.OrderBy(p => p.ModName).ThenBy(p => p.NounPhrase))
             {
                 // build message
 #if SMAPI_3_0_STRICT
-                string message = $"{warning.ModName ?? "An unknown mod"} uses deprecated code ({warning.NounPhrase} is deprecated since SMAPI {warning.Version}).";
+                string message = $"{warning.ModName} uses deprecated code ({warning.NounPhrase} is deprecated since SMAPI {warning.Version}).";
 #else
                 string message = warning.NounPhrase == "legacy events"
-                    ? $"{warning.ModName ?? "An unknown mod"} uses deprecated code (legacy events are deprecated since SMAPI {warning.Version})."
-                    : $"{warning.ModName ?? "An unknown mod"} uses deprecated code ({warning.NounPhrase} is deprecated since SMAPI {warning.Version}).";
+                    ? $"{warning.ModName ?? "An unknown mod"} will break in the upcoming SMAPI 3.0 (legacy events are deprecated since SMAPI {warning.Version})."
+                    : $"{warning.ModName ?? "An unknown mod"} will break in the upcoming SMAPI 3.0 ({warning.NounPhrase} is deprecated since SMAPI {warning.Version}).";
 #endif
 
                 // get log level
-- 
cgit