valueName's containing colons are not escaped in completion scripts

[edigaryev]

Here's an example of an option from Tart, the option has a valueName that contains a colon:

@Option(help: ArgumentHelp("""
Additional disk attachments with an optional read-only and synchronization options (e.g. --disk="disk.bin", --disk="ubuntu.iso:ro", --disk="/dev/disk0", --disk "ghcr.io/cirruslabs/xcode:16.0:ro" or --disk="nbd://localhost:10809/myDisk:sync=none")
""", valueName: "path[:options]"))
var disk: [String] = []

This is a common notation for Unix-like CLI tools meaning that you can either specify a path, or additionally have options, but after a colon.

The resulting Zsh completion looks like this:

_tart_run() {
    local -i ret=1
    local -ar arg_specs=(
        [...]
        '*--disk[Additional disk attachments with an optional read-only and synchronization options (e.g. --disk="disk.bin", --disk="ubuntu.iso:ro", --disk="/dev/disk0", --disk "ghcr.io/cirruslabs/xcode:16.0:ro" or --disk="nbd://localhost:10809/myDisk:sync=none")]:path[:options]:'
        [...]
    )
    _arguments -w -s -S : "${arg_specs[@]}" && ret=0

    return "${ret}"
}

Here, the colon slips into the completion unescaped, so attempting to complete the tart run --disk results in the following Zsh error:

% tart run --disk _arguments:465: command not found: options]

Happens on the main branch of the ArgumentParser.

[rauhul]

@rgoldberg is this something you're interested in taking a look at?

[rgoldberg]

@edigaryev Have you tried it in 1.5.0 or just in main?

@rauhul I can look at it later tonight.

Note that the code in main does not purport to fix all the existing completion problems from 1.5.0, but hopefully there are no regressions from 1.5.0. If there is a regression, I'll fix it ASAP, but it would be easier to merge the following first before merging any fixes for this:

• Add 2 index arguments to custom shell completion calls #763

[edigaryev]

Have you tried it in 1.5.0 or just in main?

@rgoldberg I've tried 1.5.0 too.

The offending line seems to be this:

swift-argument-parser/Sources/ArgumentParser/Completions/ZshCompletionsGenerator.swift

Line 154 in 91af755

return ("'\(line):\(arg.valueName):\(argumentAction)'", setupScript)

[rgoldberg]

@edigaryev @rauhul @natecook1000 I have a fix that should work, but I need to test it. I'll submit it after I've checked it, presumably sometime tomorrow (Thursday). I'll only submit after #763 has been merged, but I've already submitted the requested warning message change & a spacing update for #763, so it presumably should be merged soon.