initial player_add changes

src/SMAPI.Mods.ConsoleCommands/Framework/Commands/Player/AddCommand.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using StardewModdingAPI.Mods.ConsoleCommands.Framework.ItemData;
 using StardewValley;
@@ -30,24 +31,25 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
         /// <param name="args">The command arguments.</param>
         public override void Handle(IMonitor monitor, string command, ArgumentParser args)
         {
-            // read arguments
+            SearchableItem match;
-            if (!args.TryGet(0, "item type", out string rawType, oneOf: Enum.GetNames(typeof(ItemType))))
+            int optionalArgStartIndex;
-                return;
-            if (!args.TryGetInt(1, "item ID", out int id, min: 0))
-                return;
-            if (!args.TryGetInt(2, "count", out int count, min: 1, required: false))
-                count = 1;
-            if (!args.TryGetInt(3, "quality", out int quality, min: Object.lowQuality, max: Object.bestQuality, required: false))
-                quality = Object.lowQuality;
-            ItemType type = (ItemType)Enum.Parse(typeof(ItemType), rawType, ignoreCase: true);
 
-            // find matching item
+            if (!args.TryGet(0, "item type or name", out string typeOrName, required: true))
-            SearchableItem match = this.Items.GetAll().FirstOrDefault(p => p.Type == type && p.ID == id);
-            if (match == null)
-            {
-                monitor.Log($"There's no {type} item with ID {id}.", LogLevel.Error);
                 return;
-            }
+
+            // read arguments
+            if (Enum.GetNames(typeof(ItemType)).Contains(typeOrName, StringComparer.InvariantCultureIgnoreCase))
+                this.FindItemByTypeAndId(monitor, args, typeOrName, out optionalArgStartIndex, out match);
+            else
+                this.FindItemByName(monitor, args, typeOrName, out optionalArgStartIndex, out match);
+          
+            if (match == null)
+                return;
+
+            if (!args.TryGetInt(optionalArgStartIndex, "count", out int count, min: 1, required: false))
+                count = 1;
+            if (!args.TryGetInt(optionalArgStartIndex + 1, "quality", out int quality, min: Object.lowQuality, max: Object.bestQuality, required: false))
+                quality = Object.lowQuality;
 
             // apply count
             match.Item.Stack = count;
@@ -63,6 +65,69 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
             monitor.Log($"OK, added {match.Name} ({match.Type} #{match.ID}) to your inventory.", LogLevel.Info);
         }
 
+        /// <summary>
+        /// Finds a matching item by item type and id.
+        /// </summary>
+        /// <param name="monitor">Writes messages to the console and log file.</param>
+        /// <param name="args">The command arguments.</param>
+        /// <param name="rawType">The raw item type.</param>
+        /// <param name="nextArgIndex">The index of subsequent arguments.</param>
+        /// <param name="match">The matching item.</param>
+        private void FindItemByTypeAndId(IMonitor monitor, ArgumentParser args, string rawType, out int nextArgIndex, out SearchableItem match)
+        {
+            match = null;
+            nextArgIndex = 2;
+
+            // read arguments
+            if (!args.TryGetInt(1, "item ID", out int id, min: 0))
+                return;
+
+            ItemType type = (ItemType)Enum.Parse(typeof(ItemType), rawType, ignoreCase: true);
+
+            // find matching item
+            match = this.Items.GetAll().FirstOrDefault(p => p.Type == type && p.ID == id);
+
+            if (match == null)
+            {
+                monitor.Log($"There's no {type} item with ID {id}.", LogLevel.Error);
+            }
+        }
+
+        /// <summary>
+        /// Finds a matching item by name.
+        /// </summary>
+        /// <param name="monitor">Writes messages to the console and log file.</param>
+        /// <param name="args">The command arguments.</param>
+        /// <param name="name">The item name.</param>
+        /// <param name="nextArgIndex">The index of subsequent arguments.</param>
+        /// <param name="match">The matching item.</param>
+        private void FindItemByName(IMonitor monitor, ArgumentParser args, string name, out int nextArgIndex, out SearchableItem match)
+        {
+            match = null;
+            nextArgIndex = 1;
+
+            // interpret names with underscores as spaces
+            name = name.Replace('_', ' ');
+
+            // find matching items
+            IEnumerable<SearchableItem> matching = this.Items.GetAll().Where(p => p.DisplayName.Equals(name, StringComparison.CurrentCultureIgnoreCase));
+            int numberOfMatches = matching.Count();
+
+            // handle unique requirement
+            if (numberOfMatches == 0)
+            {
+                monitor.Log($"There's no item with name {name}.", LogLevel.Error);
+            }
+            else if (numberOfMatches == 1)
+            {
+                match = matching.ElementAt(0);
+            }
+            else
+            {
+                monitor.Log($"There are {numberOfMatches} items with name {name}. Try specifying a type and id instead.", LogLevel.Error);
+            }
+        }
+
         /*********
         ** Private methods
         *********/
@@ -71,9 +136,10 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
             string[] typeValues = Enum.GetNames(typeof(ItemType));
             return "Gives the player an item.\n"
                 + "\n"
-                + "Usage: player_add <type> <item> [count] [quality]\n"
+                + "Usage: player_add (<type> <item>|<name>) [count] [quality]\n"
                 + $"- type: the item type (one of {string.Join(", ", typeValues)}).\n"
                 + "- item: the item ID (use the 'list_items' command to see a list).\n"
+                + "- name: the display name of the item (only if there is exactly one such item).\n"
                 + "- count (optional): how many of the item to give.\n"
                 + $"- quality (optional): one of {Object.lowQuality} (normal), {Object.medQuality} (silver), {Object.highQuality} (gold), or {Object.bestQuality} (iridium).\n"
                 + "\n"