Expose the arguments list of the execute function

nyxx-discord · Feb 26, 2024 · 3b4a2f2 · 3b4a2f2
1 parent 363cb28
commit 3b4a2f2
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 9 deletions.
diff --git a/lib/nyxx_commands.dart b/lib/nyxx_commands.dart
@@ -29,15 +29,6 @@ export 'src/commands/message_command.dart' show MessageCommand;
 export 'src/commands/options.dart' show CommandOptions;
 export 'src/commands/user_command.dart' show UserCommand;
 export 'src/context/autocomplete_context.dart' show AutocompleteContext;
-export 'src/context/chat_context.dart'
-    show ChatContext, ChatContextData, InteractionChatContext, MessageChatContext;
-export 'src/context/component_context.dart'
-    show
-        ComponentContextData,
-        ComponentContext,
-        ButtonComponentContext,
-        SelectMenuContext;
-export 'src/context/context_manager.dart' show ContextManager;
 export 'src/context/base.dart'
     show
         CommandContext,
@@ -49,6 +40,11 @@ export 'src/context/base.dart'
         InteractionInteractiveContext,
         InteractiveContext,
         ResponseLevel;
+export 'src/context/chat_context.dart'
+    show ChatContext, ChatContextData, InteractionChatContext, MessageChatContext;
+export 'src/context/component_context.dart'
+    show ComponentContextData, ComponentContext, ButtonComponentContext, SelectMenuContext;
+export 'src/context/context_manager.dart' show ContextManager;
 export 'src/context/message_context.dart' show MessageContext;
 export 'src/context/modal_context.dart' show ModalContext;
 export 'src/context/user_context.dart' show UserContext;
@@ -83,6 +79,7 @@ export 'src/util/util.dart'
     show
         Autocomplete,
         Choices,
+        CommandArgument,
         ComponentId,
         ComponentIdStatus,
         Description,

diff --git a/lib/src/commands/chat_command.dart b/lib/src/commands/chat_command.dart
@@ -279,8 +279,12 @@ class ChatCommand
   final List<AbstractCheck> singleChecks = [];
 
   /// The types of the required and positional arguments of [execute], in the order they appear.
+  @Deprecated('Use arguments[].type instead')
   final List<RuntimeType<dynamic>> argumentTypes = [];
 
+  /// The arguments of [execute], in the order they appear.
+  final List<CommandArgument> arguments = [];
+
   @override
   final CommandOptions options;
 
@@ -368,7 +372,18 @@ class ChatCommand
         }
       }
 
+      // ignore: deprecated_member_use_from_same_package
       argumentTypes.add(parameter.type);
+      arguments.add(
+        CommandArgument(
+          name: parameter.name,
+          isOptional: parameter.isOptional,
+          type: parameter.type,
+          description: parameter.description,
+          localizedDescriptions: parameter.localizedDescriptions,
+          localizedNames: parameter.localizedNames,
+        ),
+      );
     }
   }
 

diff --git a/lib/src/util/util.dart b/lib/src/util/util.dart
@@ -649,3 +649,33 @@ Future<Permissions> computePermissions(
 
   return computeOverwrites(await computeBasePermissions());
 }
+
+/// Represents a command argument.
+class CommandArgument {
+  /// The name of this argument.
+  final String name;
+
+  /// The localized names of this argument.
+  final Map<Locale, String>? localizedNames;
+
+  /// The description of this argument.
+  final String? description;
+
+  /// The localized descriptions of this argument.
+  final Map<Locale, String>? localizedDescriptions;
+
+  /// The argument type.
+  final RuntimeType<dynamic>? type;
+
+  /// Whether this argument is optional.
+  final bool isOptional;
+
+  const CommandArgument({
+    required this.name,
+    required this.isOptional,
+    this.localizedNames,
+    this.description,
+    this.localizedDescriptions,
+    this.type,
+  });
+}