[SR-7053] Fix zsh completion script (#1514)

* [SR-7053] Fix zsh completion script by escaping [ and ] https://bugs.swift.org/browse/SR-7053 * Revert spaces to reduce diff * Revert unneeded changes
apple · Mar 3, 2018 · 9f67bee · 9f67bee
1 parent 92a82cb
commit 9f67bee
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/Sources/Utility/ArgumentParserShellCompletion.swift b/Sources/Utility/ArgumentParserShellCompletion.swift
@@ -252,6 +252,8 @@ extension ArgumentParser {
         let description = removeDefaultRegex
             .replace(in: argument.usage ?? "", with: "")
             .replacingOccurrences(of: "\"", with: "\\\"")
+            .replacingOccurrences(of: "[", with: "\\[")
+            .replacingOccurrences(of: "]", with: "\\]")
         stream <<< "[\(description)]"
 
         generateZshCompletion(argument, on: stream)

diff --git a/Tests/UtilityTests/ArgumentParserTests.swift b/Tests/UtilityTests/ArgumentParserTests.swift
@@ -450,7 +450,7 @@ class ArgumentParserTests: XCTestCase {
         let parser = ArgumentParser(commandName:"SomeBinary", usage: "sample parser", overview: "Sample overview")
 
         _ = parser.add(positional: "package name of the year", kind: String.self, optional: true, usage: "The name of the package")
-        _ = parser.add(option: "--revision", kind: String.self, usage: "The revision")
+        _ = parser.add(option: "--revision", kind: String.self, usage: "The revision[Experimental]")
 
         var output = BufferedOutputByteStream()
         parser.generateCompletionScript(for: .bash, on: output)
@@ -494,7 +494,7 @@ class ArgumentParserTests: XCTestCase {
             _SomeBinary() {
                 arguments=(
                     ":The name of the package: "
-                    "--revision[The revision]:The revision: "
+                    "--revision[The revision\\[Experimental\\]]:The revision[Experimental]: "
                 )
                 _arguments $arguments && return
             }