add merge function to command groups

Sources/ConsoleKit/Command/AnyCommand.swift

@@ -1,8 +1,8 @@
 /// A type-erased `Command`.
-public protocol AnyCommand: Sendable {
+public protocol AnyCommand: Sendable, AnyAsyncCommand {
     /// Text that will be displayed when `--help` is passed.
     var help: String { get }
-    
+
     /// Runs the command against the supplied input.
     func run(using context: inout CommandContext) throws
     func outputAutoComplete(using context: inout CommandContext) throws
@@ -24,4 +24,13 @@ extension AnyCommand {
     public func renderCompletionFunctions(using context: CommandContext, shell: Shell) -> String {
         return ""
     }
+
+    // we need to have a sync environment so the compiler uses the sync run method over the async version
+    private func syncRun(using context: inout CommandContext) throws {
+        try self.run(using: &context)
+    }
+
+    public func run(using context: inout CommandContext) async throws {
+        try self.syncRun(using: &context)
+    }
 }

Sources/ConsoleKit/Command/Async/AsyncCommand.swift

@@ -78,7 +78,7 @@
 ///                     U  ||----w |
 ///                        ||     ||
 ///
-public protocol AsyncCommand: AnyAsyncCommand {
+public protocol AsyncCommand: Sendable, AnyAsyncCommand {
     associatedtype Signature: CommandSignature
     func run(using context: CommandContext, signature: Signature) async throws
 }
@@ -90,7 +90,7 @@ extension AsyncCommand {
             let input = context.input.arguments.joined(separator: " ")
             throw ConsoleError.init(identifier: "unknownInput", reason: "Input not recognized: \(input)")
         }
-      try await self.run(using: context, signature: signature)
+        try await self.run(using: context, signature: signature)
     }
 
     public func outputAutoComplete(using context: inout CommandContext) {
@@ -101,7 +101,10 @@ extension AsyncCommand {
     }
 
     public func outputHelp(using context: inout CommandContext) {
-        context.console.output("Usage: ".consoleText(.info) + context.input.executable.consoleText() + " ", newLine: false)
+        context.console.output(
+            "Usage: ".consoleText(.info) + context.input.executable.consoleText() + " ",
+            newLine: false
+        )
         Signature.reference.outputHelp(help: self.help, using: &context)
     }
 }

Sources/ConsoleKit/Command/Async/AsyncCommandGroup.swift

@@ -16,11 +16,41 @@
 public protocol AsyncCommandGroup: AnyAsyncCommand {
     var commands: [String: any AnyAsyncCommand] { get }
     var defaultCommand: (any AnyAsyncCommand)? { get }
+
+    /// Merges this group with another group.
+    /// - Parameters:
+    ///   - group: The group to merge with.
+    ///   - defaultCommand: The new default command to use.
+    ///   - help: The help message to use for the merged group.
+    /// - Returns: A new `AsyncCommandGroup` with the merged commands.
+    func merge(
+        with group: any AsyncCommandGroup,
+        defaultCommand: (any AnyAsyncCommand)?,
+        help: String
+    ) -> any AsyncCommandGroup
+}
+
+public struct MergedAsyncCommandGroup: AsyncCommandGroup {
+    public let commands: [String: any AnyAsyncCommand]
+    public let defaultCommand: (any AnyAsyncCommand)?
+    public var help: String
 }
 
 extension AsyncCommandGroup {
-    public var defaultCommand: (any AnyAsyncCommand)? {
-        return nil
+    public var defaultCommand: (any AnyAsyncCommand)? { nil }
+
+    public func merge(
+        with group: any AsyncCommandGroup,
+        defaultCommand: (any AnyAsyncCommand)?,
+        help: String
+    ) -> any AsyncCommandGroup {
+        var mergedCommands = self.commands
+        mergedCommands.merge(group.commands, uniquingKeysWith: { (_, new) in new })
+        return MergedAsyncCommandGroup(
+            commands: mergedCommands,
+            defaultCommand: defaultCommand,
+            help: help
+        )
     }
 }
 

Sources/ConsoleKit/Command/Async/AsyncCommands.swift

@@ -1,5 +1,5 @@
 /// Represents a top-level group of configured commands. This is usually created by calling `resolve(for:)` on `AsyncCommands`.
-public struct AsyncCommands {
+public struct AsyncCommands: Sendable {
     /// Top-level available commands, stored by unique name.
     public var commands: [String: any AnyAsyncCommand]
 
@@ -38,7 +38,7 @@ public struct AsyncCommands {
         self.defaultCommand = defaultCommand
         self.enableAutocomplete = enableAutocomplete
     }
-    
+
     /// Adds an `AsyncCommand` instance to the config.
     ///
     ///     var config = AsyncCommands()

Sources/ConsoleKit/Command/CommandContext.swift

@@ -1,13 +1,13 @@
 /// A type-erased `CommandContext`
-public struct CommandContext {
+public struct CommandContext: Sendable {
     /// The `Console` this command was run on.
     public var console: any Console
-    
+
     /// The parsed arguments (according to declared signature).
     public var input: CommandInput
 
-    public var userInfo: [AnyHashable: Any]
-    
+    public var userInfo: [AnySendableHashable: any Sendable]
+
     /// Create a new `AnyCommandContext`.
     public init(
         console: any Console,

Sources/ConsoleKit/Command/CommandGroup.swift

@@ -13,7 +13,7 @@
 ///     try console.run(group, with: context)
 ///
 /// You can create your own `CommandGroup` if you want to support custom `CommandOptions`.
-public protocol CommandGroup: AnyCommand {
+public protocol CommandGroup: AnyCommand, AsyncCommandGroup {
     var commands: [String: any AnyCommand] { get }
     var defaultCommand: (any AnyCommand)? { get }
 }
@@ -22,6 +22,12 @@ extension CommandGroup {
     public var defaultCommand: (any AnyCommand)? {
         return nil
     }
+
+    public var commands: [String: any AnyAsyncCommand] {
+        // make the compiler happy
+        let castedCommands: [String: any AnyCommand] = commands
+        return castedCommands
+    }
 }
 
 extension CommandGroup {