feat (command)!: update command builder with modifiers

BREAKING CHANGE: certain option parameters are no longer passed as arguments to init but as modifiers instead

Author: cryptoAlgorithm

Sources/DiscordKitBot/ApplicationCommand/Option/BooleanOption.swift

@@ -12,12 +12,11 @@ import DiscordKitCore
 ///
 /// To be used with the ``OptionBuilder`` from the ``NewAppCommand`` initialiser
 public struct BooleanOption: CommandOption {
-    public init(_ name: String, description: String, `required`: Bool? = nil) {
+    public init(_ name: String, description: String) {
         type = .boolean
 
         self.name = name
         self.description = description
-        self.required = `required`
     }
 
     public let type: CommandOptionType
@@ -26,5 +25,5 @@ public struct BooleanOption: CommandOption {
 
     public let description: String
 
-    public let required: Bool?
+    public var required: Bool?
 }

Sources/DiscordKitBot/ApplicationCommand/Option/CommandOption.swift

@@ -23,12 +23,21 @@ public protocol CommandOption: Encodable {
     /// > Important: Must be 1-100 characters long
     var description: String { get }
     /// If this command is required
-    var required: Bool? { get }
+    var required: Bool? { get set }
 
     /// Channel types to restrict visibility of command to
     // var channel_types: ChannelType? { get }
 }
 
+// MARK: Modifiers
+public extension CommandOption {
+    func required() -> Self {
+        var opt = self
+        opt.required = true
+        return opt
+    }
+}
+
 public struct AppCommandOptionChoice: Encodable {
     public init(name: String, value: Interaction.Data.AppCommandData.OptionData.Value) {
         self.name = name

Sources/DiscordKitBot/ApplicationCommand/Option/IntegerOption.swift

@@ -12,15 +12,12 @@ import DiscordKitCore
 ///
 /// To be used with the ``OptionBuilder`` from the ``NewAppCommand`` initialiser
 public struct IntegerOption: CommandOption {
-    public init(_ name: String, description: String, `required`: Bool? = nil, choices: [AppCommandOptionChoice]? = nil, min: Int? = nil, max: Int? = nil, autocomplete: Bool? = nil) {
+    public init(_ name: String, description: String, choices: [AppCommandOptionChoice]? = nil, autocomplete: Bool? = nil) {
         type = .integer
 
         self.name = name
         self.description = description
-        self.required = `required`
         self.choices = choices
-        self.min_value = min
-        self.max_value = max
         self.autocomplete = autocomplete
     }
 
@@ -30,18 +27,34 @@ public struct IntegerOption: CommandOption {
 
     public let description: String
 
-    public let required: Bool?
+    public var required: Bool?
 
     /// Choices for the user to pick from
     ///
     /// > Important: There can be a max of 25 choices.
     public let choices: [AppCommandOptionChoice]?
 
     /// Minimium value permitted for this option
-    public let min_value: Int?
+    fileprivate(set) var min_value: Int?
     /// Maximum value permitted for this option
-    public let max_value: Int?
+    fileprivate(set) var max_value: Int?
 
     /// If autocomplete interactions are enabled for this option
     public let autocomplete: Bool?
 }
+
+extension IntegerOption {
+    /// Require the value of this option to be greater than or equal to this value
+    public func min(_ min: Int) -> Self {
+        var opt = self
+        opt.min_value = min
+        return opt
+    }
+
+    /// Require the value of this option to be smaller than or equal to this value
+    public func max(_ max: Int) -> Self {
+        var opt = self
+        opt.max_value = max
+        return opt
+    }
+}

Sources/DiscordKitBot/ApplicationCommand/Option/NumberOption.swift

@@ -12,12 +12,11 @@ import DiscordKitCore
 ///
 /// To be used with the ``OptionBuilder`` from the ``NewAppCommand`` initialiser
 public struct NumberOption: CommandOption {
-    public init(_ name: String, description: String, `required`: Bool? = nil, choices: [AppCommandOptionChoice]? = nil, min: Double? = nil, max: Double? = nil, autocomplete: Bool? = nil) {
+    public init(_ name: String, description: String, choices: [AppCommandOptionChoice]? = nil, min: Double? = nil, max: Double? = nil, autocomplete: Bool? = nil) {
         type = .number
 
         self.name = name
         self.description = description
-        self.required = `required`
         self.choices = choices
         self.min_value = min
         self.max_value = max
@@ -30,7 +29,7 @@ public struct NumberOption: CommandOption {
 
     public let description: String
 
-    public let required: Bool?
+    public var required: Bool?
 
     /// Choices for the user to pick from
     ///

Sources/DiscordKitBot/ApplicationCommand/Option/SubCommand.swift

@@ -10,18 +10,17 @@ import DiscordKitCore
 
 public struct SubCommand: CommandOption {
     /// Create a sub-command, optionally with an array of options
-    public init(_ name: String, description: String, required: Bool? = nil, options: [CommandOption]? = nil) {
+    public init(_ name: String, description: String, options: [CommandOption]? = nil) {
         type = .subCommand
 
         self.name = name
         self.description = description
-        self.required = required
         self.options = options
     }
 
     /// Create a sub-command with options built by an ``OptionBuilder``
-    public init(_ name: String, description: String, required: Bool? = nil, @OptionBuilder options: () -> [CommandOption]) {
-        self.init(name, description: description, required: required, options: options())
+    public init(_ name: String, description: String, @OptionBuilder options: () -> [CommandOption]) {
+        self.init(name, description: description, options: options())
     }
 
     public let type: CommandOptionType
@@ -30,7 +29,7 @@ public struct SubCommand: CommandOption {
 
     public let description: String
 
-    public let required: Bool?
+    public var required: Bool?
 
     /// If this command is a subcommand or subcommand group type, these nested options will be its parameters
     public let options: [CommandOption]?