#336: Text commands clean ups

~ Rename references of interactions to commands.
Drop need for summary attribute on command arguments as it is unused within the stack.
~ Clean up constructors of some handlers removing uneeded arguments.

Author: nikita-petko

services/grid-bot/lib/commands/Modules/Commands/ExecuteScript.cs

@@ -31,7 +31,7 @@ namespace Grid.Bot.Commands.Public;
 using ClientJob = Client.Job;
 
 /// <summary>
-/// Interaction handler for executing Luau code.
+/// Command handler for executing Luau code.
 /// </summary>
 /// <remarks>
 /// Construct a new instance of <see cref="ExecuteScript"/>.
@@ -301,10 +301,7 @@ private async Task<bool> ParseLuaAsync(string input)
     /// </summary>
     /// <param name="script">The script to execute.</param>
     [Command("execute"), Summary("Execute a script via raw text."), Alias("ex", "exc", "x")]
-    public async Task ExecuteScriptFromTextAsync(
-        [Summary("The script to execute."), Remainder]
-        string script = ""
-    )
+    public async Task ExecuteScriptFromTextAsync([Remainder] string script = "")
     {
         using var _ = Context.Channel.EnterTypingState();
 

services/grid-bot/lib/commands/Modules/Commands/Render.cs

@@ -12,7 +12,7 @@ namespace Grid.Bot.Commands.Public;
 using Extensions;
 
 /// <summary>
-/// Interaction handler for rendering a Roblox character.
+/// Command handler for rendering a Roblox character.
 /// </summary>
 /// <remarks>
 /// Construct a new instance of <see cref="Render"/>.
@@ -74,10 +74,7 @@ protected override async Task BeforeExecuteAsync(CommandInfo command)
     /// </summary>
     /// <param name="userNameOrId">The ID of the Roblox user.</param>
     [Command("render"), Summary("Renders a Roblox character by Roblox user ID."), Alias("r")]
-    public async Task DoRenderAsync(
-        [Summary("The ID or the user name of the Roblox user.")]
-        string userNameOrId
-    )
+    public async Task DoRenderAsync(string userNameOrId)
     {
         using var _ = Context.Channel.EnterTypingState();
 

services/grid-bot/lib/commands/PrivateModules/Commands/ClientSettings.cs

@@ -20,7 +20,7 @@ namespace Grid.Bot.Commands.Private;
 using Extensions;
 
 /// <summary>
-/// Represents the interaction for ClientSettings.
+/// Represents the command for ClientSettings.
 /// </summary>
 /// <remarks>
 /// Construct a new instance of <see cref="ClientSettingsModule"/>.
@@ -67,13 +67,7 @@ public enum ClientSettingType
     /// <param name="useApiKey">Should the API key be used? This will allow the application to be returned from the client settings API even if $allowed on the backend is false.</param>
     [Command("get_all"), Summary("Gets all client settings for the specified application.")]
     [Alias("getall", "all")]
-    public async Task GetAllAsync(
-        [Summary("The name of the application to get the client settings for.")]
-        string applicationName,
-
-        [Summary("Should the API key be used? This will allow the application to be returned from the client settings API even if $allowed on the backend is false.")]
-        bool useApiKey = false
-    )
+    public async Task GetAllAsync(string applicationName, bool useApiKey = false)
     {
         using var _ = Context.Channel.EnterTypingState();
 
@@ -111,19 +105,7 @@ await this.ReplyWithReferenceAsync(
     /// <param name="reference">The reference for the application.</param>
     /// <param name="isAllowedFromApi">Is the application allowed to be written to from the API?</param>
     [Command("import"), Summary("Imports the client settings for the specified application.")]
-    public async Task ImportAsync(
-        [Summary("The name of the application to import the client settings for.")]
-        string applicationName,
-
-        [Summary("The dependencies for the application.")]
-        string dependencies = null,
-
-        [Summary("The reference for the application.")]
-        string reference = null,
-
-        [Summary("Is the application allowed to be written to from the API?")]
-        bool isAllowedFromApi = false
-    )
+    public async Task ImportAsync(string applicationName, string dependencies = null, string reference = null, bool isAllowedFromApi = false)
     {
         var applicationSettings = Context.Message.Attachments.FirstOrDefault();
         if (applicationSettings is null)
@@ -170,16 +152,10 @@ await this.ReplyWithReferenceAsync(
     /// <param name="applicationName">The name of the application.</param>
     /// <param name="settingName">The name of the setting.</param>
     [Command("get"), Summary("Gets a client setting for the specified application.")]
-    public async Task GetAsync(
-        [Summary("The name of the application to get the client setting for.")]
-        string applicationName,
-
-        [Summary("The name of the setting to get.")]
-        string settingName
-    )
+    public async Task GetAsync(string applicationName, string settingName)
     {
         if (string.IsNullOrWhiteSpace(applicationName))
-        {
+        { 
             await this.ReplyWithReferenceAsync(
                 text: "Please specify an application name."
             );
@@ -233,19 +209,7 @@ await this.ReplyWithReferenceAsync(
     /// <param name="settingType">The type of the setting.</param>
     /// <param name="settingValue">The value of the setting.</param>
     [Command("set"), Summary("Sets a client setting for the specified application.")]
-    public async Task SetAsync(
-        [Summary("The name of the application to set the client setting for.")]
-        string applicationName,
-
-        [Summary("The name of the setting to set.")]
-        string settingName,
-
-        [Summary("The type of the setting to set.")]
-        ClientSettingType settingType = ClientSettingType.String,
-
-        [Summary("The value of the setting to set.")]
-        string settingValue = ""
-    )
+    public async Task SetAsync(string applicationName, string settingName, ClientSettingType settingType = ClientSettingType.String, string settingValue = "")
     {
         if (string.IsNullOrWhiteSpace(applicationName))
         {

services/grid-bot/lib/commands/PrivateModules/Commands/Maintenance.cs

@@ -12,7 +12,7 @@ namespace Grid.Bot.Commands.Private;
 using Extensions;
 
 /// <summary>
-/// Interaction handler for the maintenance commands.
+/// Command handler for the maintenance commands.
 /// </summary>
 /// <remarks>
 /// Construct a new instance of <see cref="Maintenance"/>.
@@ -46,10 +46,7 @@ private static string GetStatusText(string updateText)
     /// </summary>
     /// <param name="statusText">The status text to set.</param>
     [Command("enable"), Summary("Enables maintenance mode.")]
-    public async Task EnableMaintenanceAsync(
-        [Summary("The status text to set."), Remainder]
-        string statusText = null
-    )
+    public async Task EnableMaintenanceAsync([Remainder] string statusText = null)
     {
         if (_maintenanceSettings.MaintenanceEnabled)
         {
@@ -107,10 +104,7 @@ public async Task DisableMaintenanceAsync()
     /// </summary>
     /// <param name="statusText">The status text to set.</param>
     [Command("update"), Summary("Updates the maintenance status text.")]
-    public async Task UpdateMaintenanceStatusTextAsync(
-        [Summary("The status text to set."), Remainder]
-        string statusText = null
-    )
+    public async Task UpdateMaintenanceStatusTextAsync([Remainder] string statusText = null)
     {
         if (!_maintenanceSettings.MaintenanceEnabled)
         {

services/grid-bot/lib/commands/PrivateModules/Commands/Roles.cs

@@ -11,26 +11,18 @@ namespace Grid.Bot.Commands.Private;
 using Extensions;
 
 /// <summary>
-/// Interaction handler for updating user bot roles.
+/// Command handler for updating user bot roles.
 /// </summary>
 /// <remarks>
 /// Construct a new instance of <see cref="Roles"/>.
 /// </remarks>
-/// <param name="discordRolesSettings">The <see cref="DiscordRolesSettings"/>.</param>
 /// <param name="adminUtility">The <see cref="IAdminUtility"/>.</param>
-/// <exception cref="ArgumentNullException">
-/// - <paramref name="discordRolesSettings"/> cannot be null.
-/// - <paramref name="adminUtility"/> cannot be null.
-/// </exception>
+/// <exception cref="ArgumentNullException"><paramref name="adminUtility"/> cannot be null.</exception>
 [LockDownCommand(BotRole.Administrator)]
 [RequireBotRole(BotRole.Administrator)]
 [Group("role"), Summary("Commands used for updating user bot roles."), Alias("roles")]
-public class Roles(
-    DiscordRolesSettings discordRolesSettings,
-    IAdminUtility adminUtility
-) : ModuleBase
+public class Roles(IAdminUtility adminUtility) : ModuleBase
 {
-    private readonly DiscordRolesSettings _discordRolesSettings = discordRolesSettings ?? throw new ArgumentNullException(nameof(discordRolesSettings));
     private readonly IAdminUtility _adminUtility = adminUtility ?? throw new ArgumentNullException(nameof(adminUtility));
 
 
@@ -40,12 +32,7 @@ IAdminUtility adminUtility
     /// <param name="user">The user to update.</param>
     /// <param name="role">The role to update to.</param>
     [Command("update"), Summary("Updates the user's bot role.")]
-    public async Task UpdateRoleAsync(
-        [Summary("The user to update.")]
-        IUser user,
-        [Summary("The role to update to.")]
-        BotRole role = BotRole.Default
-    )
+    public async Task UpdateRoleAsync(IUser user, BotRole role = BotRole.Default)
     {
         if (user.IsBot)
         {
@@ -94,10 +81,7 @@ public async Task UpdateRoleAsync(
     /// </summary>
     /// <param name="user">The user to blacklist.</param>
     [Command("blacklist"), Summary("Blacklists the user.")]
-    public async Task BlacklistUserAsync(
-        [Summary("The user to blacklist.")]
-        IUser user
-    )
+    public async Task BlacklistUserAsync(IUser user)
     {
         if (user.IsBot)
         {
@@ -130,10 +114,7 @@ IUser user
     /// </summary>
     /// <param name="user">The user to unblacklist.</param>
     [Command("unblacklist"), Summary("Unblacklists the user.")]
-    public async Task UnblacklistUserAsync(
-        [Summary("The user to unblacklist.")]
-        IUser user
-    )
+    public async Task UnblacklistUserAsync(IUser user)
     {
         if (user.IsBot)
         {