Create Help Command and Refactor

src/Miunie.Avalonia/Miunie.Avalonia.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <OutputType>WinExe</OutputType>
-    <TargetFramework>netcoreapp3.0</TargetFramework>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
     <LangVersion>8.0</LangVersion>
     <CodeAnalysisRuleSet>../.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
@@ -16,9 +16,9 @@
     <AvaloniaResource Include="Assets\**" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Avalonia" Version="0.9.0" />
-    <PackageReference Include="Avalonia.Desktop" Version="0.9.0" />
-    <PackageReference Include="Avalonia.ReactiveUI" Version="0.9.0" />
+    <PackageReference Include="Avalonia" Version="0.9.3" />
+    <PackageReference Include="Avalonia.Desktop" Version="0.9.3" />
+    <PackageReference Include="Avalonia.ReactiveUI" Version="0.9.3" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.118">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>

src/Miunie.ConsoleApp/Miunie.ConsoleApp.csproj

@@ -3,13 +3,13 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp3.1</TargetFramework>
-    <LangVersion>latest</LangVersion>
+    <LangVersion>8.0</LangVersion>
     <CodeAnalysisRuleSet>../.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="Microsoft.AspNetCore" Version="2.2.0" />
-    <PackageReference Include="System.Configuration.ConfigurationManager" Version="4.5.0" />
+    <PackageReference Include="System.Configuration.ConfigurationManager" Version="4.7.0" />
   </ItemGroup>
 
   <ItemGroup>

src/Miunie.Core.XUnit.Tests/Miunie.Core.XUnit.Tests.csproj

@@ -2,17 +2,20 @@
 
   <PropertyGroup>
     <TargetFramework>netcoreapp3.1</TargetFramework>
-
     <IsPackable>false</IsPackable>
     <CodeAnalysisRuleSet>../.ruleset</CodeAnalysisRuleSet>
+    <LangVersion>8.0</LangVersion>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.9.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.5.0" />
     <PackageReference Include="Appveyor.TestLogger" Version="2.0.0" />
-    <PackageReference Include="Moq" Version="4.10.1" />
-    <PackageReference Include="xunit" Version="2.4.0" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.0" />
+    <PackageReference Include="Moq" Version="4.13.1" />
+    <PackageReference Include="xunit" Version="2.4.1" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.1">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.118">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>

src/Miunie.Core/Entities/PhraseKey.cs

@@ -23,6 +23,7 @@ public enum PhraseKey
         SHOW_REMOTE_REPO,
         USER_EMBED_TITLE,
         USER_EMBED_NAME_TITLE,
+        USER_EMBED_HELP_TITLE,
         USER_EMBED_IS_BOT,
         USER_EMBED_IS_HUMAN,
         USER_EMBED_REALNESS_TITLE,
@@ -54,6 +55,10 @@ public enum PhraseKey
         INCORRECT_VERB,
         REPUTATION_TAKEN_BOT,
         REPUTATION_GIVEN_BOT,
+        HELP_EXAMPLE_EMPTY,
+        HELP_EXAMPLE_TITLE,
+        HELP_SUMMARY_EMPTY,
+        HELP_SUMMARY_TITLE,
         GPL3_NOTICE
     }
 }

src/Miunie.Core/Strings.resx

@@ -158,6 +158,28 @@ Source code available at: {1}</value>
     <value>**ABOUT THIS SERVER**</value>
     <comment>No formatting options.</comment>
   </data>
+  <data name="HELP_EXAMPLE_EMPTY" xml:space="preserve">
+    <value>You'll figure it out.{{OR}}
+You know what? I've never used this command.{{OR}}
+Yeah, you're on your own with this one, buddy.{{OR}}
+I got nothing here.{{OR}}
+Just mess around with this, you'll figure it out eventually.</value>
+    <comment>No formatting options.</comment>
+  </data>
+  <data name="HELP_EXAMPLE_TITLE" xml:space="preserve">
+    <value>**Examples**: </value>
+    <comment>No formatting options.</comment>
+  </data>
+  <data name="HELP_SUMMARY_EMPTY" xml:space="preserve">
+    <value>This is kind of difficult to explain...{{OR}}
+How am I supposed to put this into words?{{OR}}
+It's a command, I think? Not sure.</value>
+    <comment>No formatting options.</comment>
+  </data>
+  <data name="HELP_SUMMARY_TITLE" xml:space="preserve">
+    <value>**Summary**: </value>
+    <comment>No formatting options.</comment>
+  </data>
   <data name="INCORRECT_VERB" xml:space="preserve">
     <value>You better start making sense with other than '{0}'{{OR}}
 Come again, I don't understand '{0}'{{OR}}
@@ -258,6 +280,10 @@ What are you trying to say with {0} {1}</value>
     <value>:calendar_spiral: Creation date</value>
     <comment>No formatting options.</comment>
   </data>
+  <data name="USER_EMBED_HELP_TITLE" xml:space="preserve">
+    <value>**HELP MENU**</value>
+    <comment>No formatting options.</comment>
+  </data>
   <data name="USER_EMBED_IS_BOT" xml:space="preserve">
     <value>_A software person._{{OR}}
 _A bot._ :robot:{{OR}}

src/Miunie.Discord/Adapters/DiscordMessagesAdapter.cs

@@ -14,7 +14,6 @@
 //  along with Miunie. If not, see <https://www.gnu.org/licenses/>.
 
 using Discord.WebSocket;
-using Miunie.Core;
 using Miunie.Core.Discord;
 using Miunie.Core.Entities;
 using Miunie.Core.Entities.Discord;

src/Miunie.Discord/Attributes/ExamplesAttribute.cs

@@ -0,0 +1,30 @@
+// This file is part of Miunie.
+//
+//  Miunie is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  Miunie is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with Miunie. If not, see <https://www.gnu.org/licenses/>.
+
+using System;
+
+namespace Miunie.Discord.Attributes
+{
+    [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
+    public class ExamplesAttribute : Attribute
+    {
+        public ExamplesAttribute(params string[] examples)
+        {
+            Examples = examples;
+        }
+
+        public string[] Examples { get; }
+    }
+}

src/Miunie.Discord/CommandHandler.cs

@@ -18,6 +18,7 @@
 using Miunie.Core.Configuration;
 using Miunie.Core.Entities.Discord;
 using Miunie.Core.Logging;
+using Miunie.Core.Providers;
 using Miunie.Discord.Convertors;
 using Miunie.Discord.TypeReaders;
 using System;
@@ -53,6 +54,9 @@ public async Task InitializeAsync()
             _ = await _commandService.AddModulesAsync(Assembly.GetExecutingAssembly(), _services);
         }
 
+        public HelpCommandProvider GetHelpProvider(ILanguageProvider lang)
+            => new HelpCommandProvider(_commandService, lang);
+
         private async Task HandleCommandAsync(SocketMessage s)
         {
             if (_botConfig.CommandsEnabled == false)

src/Miunie.Discord/CommandModules/HelpCommand.cs

@@ -0,0 +1,49 @@
+// This file is part of Miunie.
+//
+//  Miunie is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  Miunie is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with Miunie. If not, see <https://www.gnu.org/licenses/>.
+
+using Discord.Commands;
+using Miunie.Core.Providers;
+using Miunie.Discord.Attributes;
+using System.Threading.Tasks;
+
+namespace Miunie.Discord.CommandModules
+{
+    [Name("Help")]
+    public class HelpCommand : ModuleBase<SocketCommandContext>
+    {
+        private readonly HelpCommandProvider _helpService;
+
+        public HelpCommand(CommandHandler commandHandler, ILanguageProvider lang)
+        {
+            _helpService = commandHandler.GetHelpProvider(lang);
+        }
+
+        [Command("help")]
+        [Summary("I'm here for you.")]
+        [Examples("help")]
+        public async Task GetHelp()
+        {
+            await _helpService.ShowDefaultHelpAsync(Context.Channel);
+        }
+
+        [Command("help")]
+        [Summary("Gets help for a specified command.")]
+        [Examples("help repo")]
+        public async Task GetHelp([Remainder]string input)
+        {
+            await _helpService.ShowCommandHelpAsync(Context.Channel, input);
+        }
+    }
+}

src/Miunie.Discord/CommandModules/MiscCommands.cs

@@ -16,11 +16,13 @@
 using Discord.Commands;
 using Discord.WebSocket;
 using Miunie.Core;
+using Miunie.Discord.Attributes;
 using Miunie.Discord.Convertors;
 using System.Threading.Tasks;
 
 namespace Miunie.Discord.CommandModules
 {
+    [Name("Misc")]
     public class MiscCommands : ModuleBase<SocketCommandContext>
     {
         private readonly MiscService _service;
@@ -33,6 +35,8 @@ public MiscCommands(MiscService service, EntityConvertor entityConvertor)
         }
 
         [Command("what do you think?")]
+        [Summary("What do I think? I guess you'll have to find out~")]
+        [Examples("what do you think?")]
         public async Task SendRandomYesNoMaybeAnswer()
         {
             var c = _entityConvertor.ConvertChannel(Context.Channel as SocketGuildChannel);

src/Miunie.Discord/CommandModules/ProfileCommand.cs

@@ -17,11 +17,13 @@
 using Discord.WebSocket;
 using Miunie.Core;
 using Miunie.Core.Entities.Discord;
+using Miunie.Discord.Attributes;
 using Miunie.Discord.Convertors;
 using System.Threading.Tasks;
 
 namespace Miunie.Discord.CommandModules
 {
+    [Name("Profile")]
     public class ProfileCommand : ModuleBase<SocketCommandContext>
     {
         private readonly EntityConvertor _entityConvertor;
@@ -34,6 +36,8 @@ public ProfileCommand(EntityConvertor entityConvertor, ProfileService profileSer
         }
 
         [Command("profile")]
+        [Summary("Pull up a dank profile!")]
+        [Examples("profile", "profile @Miunie")]
         public async Task ShowProfileAsync(MiunieUser user = null)
         {
             if (user is null)
@@ -46,6 +50,8 @@ public async Task ShowProfileAsync(MiunieUser user = null)
         }
 
         [Command("rep log")]
+        [Summary("Pull up your current reputation log~")]
+        [Examples("rep log", "rep log 1")]
         public async Task ShowReputationLogAsync(int page = 1)
         {
             var source = _entityConvertor.ConvertUser(Context.User as SocketGuildUser);
@@ -54,6 +60,8 @@ public async Task ShowReputationLogAsync(int page = 1)
         }
 
         [Command("rep log for")]
+        [Summary("Pull up a reputation log for the specified user!")]
+        [Examples("rep log for @Miunie", "rep log for @Mackie 1")]
         public async Task ShowReputationLogAsync(MiunieUser user, int page = 1)
         {
             var source = _entityConvertor.ConvertUser(Context.User as SocketGuildUser);
@@ -62,6 +70,8 @@ public async Task ShowReputationLogAsync(MiunieUser user, int page = 1)
         }
 
         [Command("+rep")]
+        [Summary("Give a good ol' positive reputation for a user!")]
+        [Examples("+rep @Miunie")]
         public async Task AddReputationAsync(MiunieUser user)
         {
             var source = _entityConvertor.ConvertUser(Context.User as SocketGuildUser);
@@ -70,6 +80,8 @@ public async Task AddReputationAsync(MiunieUser user)
         }
 
         [Command("-rep")]
+        [Summary("Give a cold-blooded negative reputation for a user...")]
+        [Examples("-rep @You")]
         public async Task RemoveReputationAsync(MiunieUser user)
         {
             var source = _entityConvertor.ConvertUser(Context.User as SocketGuildUser);
@@ -78,6 +90,8 @@ public async Task RemoveReputationAsync(MiunieUser user)
         }
 
         [Command("guild")]
+        [Summary("Pull up information about this guild.")]
+        [Examples("guild")]
         public async Task ShowGuildInfoAsync()
         {
             var guild = _entityConvertor.ConvertGuild(Context.Guild);