Permit asynchronous code to be given to the custom completion type

[thafner0]

At the moment the custom case of the CompletionKind enumeration supports being given a custom closure to generate completions on the command line. However, since the provided closure must be synchronous, it is difficult to incorporate functionality that requires swift's concurrency features. The lack of this functionality prevents certain tasks from being possible with these completions and causes other tasks to be possible, but only in a non-thread safe way. Examples of this include working with databases (such as those managed by Apple's Core Data framework).

Example:

struct SomeCommand: AsyncParseableCommand {

@Argument(help: "<Helpful help>", completion: .custom({ arguments in
return try? await completionGenerator(arguments: arguments) ?? []
}))
var argument: String

mutating func run() async throws {
// Code that makes the command Run
}
}

@MainActor
private func completionGenerator(arguments: [String]) async throws -> [String] {
// Code that generates completions that has some asynchronous system in use and/or must be run on the main actor.
}

[luispadron]

This would be great, along with completion we could really use this for transform.

@natecook1000 is this something you think would be wanted? I could work on this if you don't think it's too complicated as a first task

[rgoldberg]

@natecook1000 @rauhul Is this issue on the roadmap for imminent development? Would it be difficult to implement?

Is there any public roadmap for what issues will be worked on soon?

Thanks for any info.

[rgoldberg]

I have code that implements this that I will submit as a PR after #770 has been merged.