print deprecation messages in batches for easier reading

5 files changed, 80 insertions, 19 deletions

diff --git a/src/SMAPI/Framework/DeprecationManager.cs b/src/SMAPI/Framework/DeprecationManager.cs
index 7a824a05..0fde67ee 100644
--- a/src/SMAPI/Framework/DeprecationManager.cs
+++ b/src/SMAPI/Framework/DeprecationManager.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace StardewModdingAPI.Framework
 {
@@ -18,6 +19,9 @@ namespace StardewModdingAPI.Framework
         /// <summary>Tracks the installed mods.</summary>
         private readonly ModRegistry ModRegistry;
 
+        /// <summary>The queued deprecation warnings to display.</summary>
+        private readonly IList<DeprecationWarning> QueuedWarnings = new List<DeprecationWarning>();
+
 
         /*********
         ** Public methods
@@ -51,29 +55,40 @@ namespace StardewModdingAPI.Framework
             if (!this.MarkWarned(source ?? "<unknown>", nounPhrase, version))
                 return;
 
-            // build message
-            string message = $"{source ?? "An unknown mod"} uses deprecated code ({nounPhrase} is deprecated since SMAPI {version}).";
-            if (source == null)
-                message += $"{Environment.NewLine}{Environment.StackTrace}";
+            // queue warning
+            this.QueuedWarnings.Add(new DeprecationWarning(source, nounPhrase, version, severity));
+        }
 
-            // log message
-            switch (severity)
+        /// <summary>Print any queued messages.</summary>
+        public void PrintQueued()
+        {
+            foreach (DeprecationWarning warning in this.QueuedWarnings.OrderBy(p => p.ModName).ThenBy(p => p.NounPhrase))
             {
-                case DeprecationLevel.Notice:
-                    this.Monitor.Log(message, LogLevel.Trace);
-                    break;
+                // build message
+                string message = $"{warning.ModName ?? "An unknown mod"} uses deprecated code ({warning.NounPhrase} is deprecated since SMAPI {warning.Version}).";
+                if (warning.ModName == null)
+                    message += $"{Environment.NewLine}{Environment.StackTrace}";
+
+                // log message
+                switch (warning.Level)
+                {
+                    case DeprecationLevel.Notice:
+                        this.Monitor.Log(message, LogLevel.Trace);
+                        break;
 
-                case DeprecationLevel.Info:
-                    this.Monitor.Log(message, LogLevel.Debug);
-                    break;
+                    case DeprecationLevel.Info:
+                        this.Monitor.Log(message, LogLevel.Debug);
+                        break;
 
-                case DeprecationLevel.PendingRemoval:
-                    this.Monitor.Log(message, LogLevel.Warn);
-                    break;
+                    case DeprecationLevel.PendingRemoval:
+                        this.Monitor.Log(message, LogLevel.Warn);
+                        break;
 
-                default:
-                    throw new NotSupportedException($"Unknown deprecation level '{severity}'");
+                    default:
+                        throw new NotSupportedException($"Unknown deprecation level '{warning.Level}'.");
+                }
             }
+            this.QueuedWarnings.Clear();
         }
 
         /// <summary>Mark a deprecation warning as already logged.</summary>
diff --git a/src/SMAPI/Framework/DeprecationWarning.cs b/src/SMAPI/Framework/DeprecationWarning.cs
new file mode 100644
index 00000000..25415012
--- /dev/null
+++ b/src/SMAPI/Framework/DeprecationWarning.cs
@@ -0,0 +1,38 @@
+namespace StardewModdingAPI.Framework
+{
+    /// <summary>A deprecation warning for a mod.</summary>
+    internal class DeprecationWarning
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The affected mod's display name.</summary>
+        public string ModName { get; }
+
+        /// <summary>A noun phrase describing what is deprecated.</summary>
+        public string NounPhrase { get; }
+
+        /// <summary>The SMAPI version which deprecated it.</summary>
+        public string Version { get; }
+
+        /// <summary>The deprecation level for the affected code.</summary>
+        public DeprecationLevel Level { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="modName">The affected mod's display name.</param>
+        /// <param name="nounPhrase">A noun phrase describing what is deprecated.</param>
+        /// <param name="version">The SMAPI version which deprecated it.</param>
+        /// <param name="level">The deprecation level for the affected code.</param>
+        public DeprecationWarning(string modName, string nounPhrase, string version, DeprecationLevel level)
+        {
+            this.ModName = modName;
+            this.NounPhrase = nounPhrase;
+            this.Version = version;
+            this.Level = level;
+        }
+    }
+}
diff --git a/src/SMAPI/Framework/SCore.cs b/src/SMAPI/Framework/SCore.cs
index 7567c6db..ee175a1b 100644
--- a/src/SMAPI/Framework/SCore.cs
+++ b/src/SMAPI/Framework/SCore.cs
@@ -213,7 +213,7 @@ namespace StardewModdingAPI.Framework
 
                 // override game
                 SGame.ConstructorHack = new SGameConstructorHack(this.Monitor, this.Reflection, this.Toolkit.JsonHelper);
-                this.GameInstance = new SGame(this.Monitor, this.MonitorForGame, this.Reflection, this.EventManager, this.Toolkit.JsonHelper, this.ModRegistry, this.InitialiseAfterGameStart, this.Dispose, this.Settings.VerboseLogging);
+                this.GameInstance = new SGame(this.Monitor, this.MonitorForGame, this.Reflection, this.EventManager, this.Toolkit.JsonHelper, this.ModRegistry, this.DeprecationManager, this.InitialiseAfterGameStart, this.Dispose, this.Settings.VerboseLogging);
                 StardewValley.Program.gamePtr = this.GameInstance;
 
                 // add exit handler
diff --git a/src/SMAPI/Framework/SGame.cs b/src/SMAPI/Framework/SGame.cs
index c7f5962f..04db9632 100644
--- a/src/SMAPI/Framework/SGame.cs
+++ b/src/SMAPI/Framework/SGame.cs
@@ -54,6 +54,9 @@ namespace StardewModdingAPI.Framework
         /// <summary>Tracks the installed mods.</summary>
         private readonly ModRegistry ModRegistry;
 
+        /// <summary>Manages deprecation warnings.</summary>
+        private readonly DeprecationManager DeprecationManager;
+
         /// <summary>Whether SMAPI should log more information about the game context.</summary>
         private readonly bool VerboseLogging;
 
@@ -137,10 +140,11 @@ namespace StardewModdingAPI.Framework
         /// <param name="eventManager">Manages SMAPI events for mods.</param>
         /// <param name="jsonHelper">Encapsulates SMAPI's JSON file parsing.</param>
         /// <param name="modRegistry">Tracks the installed mods.</param>
+        /// <param name="deprecationManager">Manages deprecation warnings.</param>
         /// <param name="onGameInitialised">A callback to invoke after the game finishes initialising.</param>
         /// <param name="onGameExiting">A callback to invoke when the game exits.</param>
         /// <param name="verboseLogging">Whether SMAPI should log more information about the game context.</param>
-        internal SGame(IMonitor monitor, IMonitor monitorForGame, Reflector reflection, EventManager eventManager, JsonHelper jsonHelper, ModRegistry modRegistry, Action onGameInitialised, Action onGameExiting, bool verboseLogging)
+        internal SGame(IMonitor monitor, IMonitor monitorForGame, Reflector reflection, EventManager eventManager, JsonHelper jsonHelper, ModRegistry modRegistry, DeprecationManager deprecationManager, Action onGameInitialised, Action onGameExiting, bool verboseLogging)
         {
             SGame.ConstructorHack = null;
 
@@ -157,6 +161,7 @@ namespace StardewModdingAPI.Framework
             this.Events = eventManager;
             this.ModRegistry = modRegistry;
             this.Reflection = reflection;
+            this.DeprecationManager = deprecationManager;
             this.OnGameInitialised = onGameInitialised;
             this.OnGameExiting = onGameExiting;
             this.VerboseLogging = verboseLogging;
@@ -237,6 +242,8 @@ namespace StardewModdingAPI.Framework
         {
             try
             {
+                this.DeprecationManager.PrintQueued();
+
                 /*********
                 ** Special cases
                 *********/
diff --git a/src/SMAPI/StardewModdingAPI.csproj b/src/SMAPI/StardewModdingAPI.csproj
index f606ef44..7f6444d1 100644
--- a/src/SMAPI/StardewModdingAPI.csproj
+++ b/src/SMAPI/StardewModdingAPI.csproj
@@ -163,6 +163,7 @@
     <Compile Include="Events\UpdateTickingEventArgs.cs" />
     <Compile Include="Events\WarpedEventArgs.cs" />
     <Compile Include="Events\WindowResizedEventArgs.cs" />
+    <Compile Include="Framework\DeprecationWarning.cs" />
     <Compile Include="Framework\Events\EventManager.cs" />
     <Compile Include="Framework\Events\ManagedEvent.cs" />
     <Compile Include="Framework\Events\ManagedEventBase.cs" />