Replace zsh END_MARKER pseudo-completion with a space to ease migration.

rgoldberg · rgoldberg · commit 937977ab7c96 · 2025-02-14T03:03:14.000-05:00
Document why &amp; how this pseudo-completion is used.

Do not trim whitespace in testing, as that breaks with the space pseudo-completion.

Testing should be as exact as possible; trimming whitespace makes it less exact.

Signed-off-by: Ross Goldberg &lt;484615+rgoldberg@users.noreply.github.com&gt;
diff --git a/Sources/ArgumentParser/Completions/CompletionsGenerator.swift b/Sources/ArgumentParser/Completions/CompletionsGenerator.swift
@@ -102,7 +102,10 @@ public struct CompletionShell: RawRepresentable, Hashable, CaseIterable {
   func format(completions: [String]) -> String {
     var completions = completions
     if self == .zsh {
-      completions.append("END_MARKER")
+      // This pseudo-completion is removed by the zsh completion script.
+      // It allows trailing empty string completions to work in zsh.
+      // zsh completion scripts generated by older SAP versions ignore spaces.
+      completions.append(" ")
     }
     return completions.joined(separator: "\n")
   }
diff --git a/Sources/ArgumentParserTestHelpers/TestHelpers.swift b/Sources/ArgumentParserTestHelpers/TestHelpers.swift
@@ -379,11 +379,9 @@ extension XCTest {
 
     let outputData = output.fileHandleForReading.readDataToEndOfFile()
     let outputActual = String(data: outputData, encoding: .utf8)!
-      .trimmingCharacters(in: .whitespacesAndNewlines)
 
     let errorData = error.fileHandleForReading.readDataToEndOfFile()
     let errorActual = String(data: errorData, encoding: .utf8)!
-      .trimmingCharacters(in: .whitespacesAndNewlines)
 
     if let expected = expected {
       AssertEqualStrings(
@@ -407,8 +405,8 @@ extension XCTest {
     file: StaticString = #filePath, line: UInt = #line
   ) throws {
     AssertEqualStrings(
-      actual: actual.trimmingCharacters(in: .whitespacesAndNewlines),
-      expected: expected.trimmingCharacters(in: .whitespacesAndNewlines),
+      actual: actual,
+      expected: expected,
       file: file,
       line: line)
 
@@ -463,7 +461,7 @@ extension XCTest {
       let expected = try String(contentsOf: snapshotFileURL, encoding: .utf8)
       AssertEqualStrings(
         actual: actual,
-        expected: expected.trimmingCharacters(in: .newlines),
+        expected: expected,
         file: file,
         line: line)
       return expected
diff --git a/Tests/ArgumentParserExampleTests/CountLinesExampleTests.swift b/Tests/ArgumentParserExampleTests/CountLinesExampleTests.swift
@@ -26,9 +26,9 @@ final class CountLinesExampleTests: XCTestCase {
     let testFile = try XCTUnwrap(
       Bundle.module.url(forResource: "CountLinesTest", withExtension: "txt"))
     try AssertExecuteCommand(
-      command: "count-lines \(testFile.path)", expected: "20")
+      command: "count-lines \(testFile.path)", expected: "20\n")
     try AssertExecuteCommand(
-      command: "count-lines \(testFile.path) --prefix al", expected: "4")
+      command: "count-lines \(testFile.path) --prefix al", expected: "4\n")
   }
 
   func testCountLinesHelp() throws {
@@ -44,6 +44,8 @@ final class CountLinesExampleTests: XCTestCase {
         --prefix <prefix>       Only count lines with this prefix.
         --verbose               Include extra information in the output.
         -h, --help              Show help information.
+
+
       """
     try AssertExecuteCommand(command: "count-lines -h", expected: helpText)
   }
diff --git a/Tests/ArgumentParserExampleTests/MathExampleTests.swift b/Tests/ArgumentParserExampleTests/MathExampleTests.swift
@@ -27,9 +27,9 @@ final class MathExampleTests: XCTestCase {
   }
 
   func testMath_Simple() throws {
-    try AssertExecuteCommand(command: "math 1 2 3 4 5", expected: "15")
+    try AssertExecuteCommand(command: "math 1 2 3 4 5", expected: "15\n")
     try AssertExecuteCommand(
-      command: "math multiply 1 2 3 4 5", expected: "120")
+      command: "math multiply 1 2 3 4 5", expected: "120\n")
   }
 
   func testMath_Help() throws {
@@ -48,6 +48,7 @@ final class MathExampleTests: XCTestCase {
         stats                   Calculate descriptive statistics.
 
         See 'math help <subcommand>' for detailed help.
+
       """
 
     try AssertExecuteCommand(command: "math -h", expected: helpText)
@@ -68,6 +69,8 @@ final class MathExampleTests: XCTestCase {
         -x, --hex-output        Use hexadecimal notation for the result.
         --version               Show the version.
         -h, --help              Show help information.
+
+
       """
 
     try AssertExecuteCommand(command: "math add -h", expected: helpText)
@@ -95,6 +98,8 @@ final class MathExampleTests: XCTestCase {
                                 median, mode; default: mean)
         --version               Show the version.
         -h, --help              Show help information.
+
+
       """
 
     try AssertExecuteCommand(
@@ -123,6 +128,8 @@ final class MathExampleTests: XCTestCase {
         --custom <custom>
         --version               Show the version.
         -h, --help              Show help information.
+
+
       """
 
     // The "quantiles" subcommand's run() method is unimplemented, so it
@@ -145,20 +152,21 @@ final class MathExampleTests: XCTestCase {
         Error: Please provide at least one value to calculate the mode.
         Usage: math stats average [--kind <kind>] [<values> ...]
           See 'math stats average --help' for more information.
+
         """,
       exitCode: .validationFailure)
   }
 
   func testMath_Versions() throws {
     try AssertExecuteCommand(
       command: "math --version",
-      expected: "1.0.0")
+      expected: "1.0.0\n")
     try AssertExecuteCommand(
       command: "math stats --version",
-      expected: "1.0.0")
+      expected: "1.0.0\n")
     try AssertExecuteCommand(
       command: "math stats average --version",
-      expected: "1.5.0-alpha")
+      expected: "1.5.0-alpha\n")
   }
 
   func testMath_ExitCodes() throws {
@@ -187,6 +195,7 @@ final class MathExampleTests: XCTestCase {
         Error: Unknown option '--foo'
         Usage: math add [--hex-output] [<values> ...]
           See 'math add --help' for more information.
+
         """,
       exitCode: .validationFailure)
 
@@ -197,6 +206,7 @@ final class MathExampleTests: XCTestCase {
         Help:  <values>  A group of integers to operate on.
         Usage: math add [--hex-output] [<values> ...]
           See 'math add --help' for more information.
+
         """,
       exitCode: .validationFailure)
   }
@@ -246,7 +256,7 @@ extension MathExampleTests {
         "hello",
         "helicopter",
         "heliotrope",
-      ]),
+      ]) + "\n",
       environment: [
         CompletionShell.shellEnvironmentVariableName: shell.rawValue
       ]
@@ -258,7 +268,7 @@ extension MathExampleTests {
         "hello",
         "helicopter",
         "heliotrope",
-      ]),
+      ]) + "\n",
       environment: [
         CompletionShell.shellEnvironmentVariableName: shell.rawValue
       ]
@@ -269,7 +279,7 @@ extension MathExampleTests {
       expected: shell.format(completions: [
         "aardvark",
         "aaaaalbert",
-      ]),
+      ]) + "\n",
       environment: [
         CompletionShell.shellEnvironmentVariableName: shell.rawValue
       ]
diff --git a/Tests/ArgumentParserExampleTests/RepeatExampleTests.swift b/Tests/ArgumentParserExampleTests/RepeatExampleTests.swift
@@ -25,6 +25,7 @@ final class RepeatExampleTests: XCTestCase {
       expected: """
         hello
         hello
+
         """)
   }
 
@@ -34,6 +35,7 @@ final class RepeatExampleTests: XCTestCase {
       expected: """
         1: hello
         2: hello
+
         """)
   }
 
@@ -47,6 +49,7 @@ final class RepeatExampleTests: XCTestCase {
         hello
         hello
         hello
+
         """)
   }
 
@@ -61,6 +64,8 @@ final class RepeatExampleTests: XCTestCase {
         --count <count>         The number of times to repeat 'phrase'.
         --include-counter       Include a counter with each repetition.
         -h, --help              Show help information.
+
+
       """
 
     try AssertExecuteCommand(command: "repeat -h", expected: helpText)
@@ -82,6 +87,8 @@ final class RepeatExampleTests: XCTestCase {
           --count <count>         The number of times to repeat 'phrase'.
           --include-counter       Include a counter with each repetition.
           -h, --help              Show help information.
+
+
         """,
       exitCode: .validationFailure)
 
@@ -92,6 +99,7 @@ final class RepeatExampleTests: XCTestCase {
         Help:  --count <count>  The number of times to repeat 'phrase'.
         Usage: repeat [--count <count>] [--include-counter] <phrase>
           See 'repeat --help' for more information.
+
         """,
       exitCode: .validationFailure)
 
@@ -102,6 +110,7 @@ final class RepeatExampleTests: XCTestCase {
         Help:  --count <count>  The number of times to repeat 'phrase'.
         Usage: repeat [--count <count>] [--include-counter] <phrase>
           See 'repeat --help' for more information.
+
         """,
       exitCode: .validationFailure)
 
@@ -111,6 +120,7 @@ final class RepeatExampleTests: XCTestCase {
         Error: Unknown option '--version'
         Usage: repeat [--count <count>] [--include-counter] <phrase>
           See 'repeat --help' for more information.
+
         """,
       exitCode: .validationFailure)
   }
diff --git a/Tests/ArgumentParserExampleTests/RollDiceExampleTests.swift b/Tests/ArgumentParserExampleTests/RollDiceExampleTests.swift
@@ -34,6 +34,8 @@ final class RollDiceExampleTests: XCTestCase {
         --seed <seed>           A seed to use for repeatable random generation.
         -v, --verbose           Show all roll results.
         -h, --help              Show help information.
+
+
       """
 
     try AssertExecuteCommand(command: "roll -h", expected: helpText)
@@ -48,6 +50,7 @@ final class RollDiceExampleTests: XCTestCase {
         Help:  --times <n>  Rolls the dice <n> times.
         Usage: roll [--times <n>] [--sides <m>] [--seed <seed>] [--verbose]
           See 'roll --help' for more information.
+
         """,
       exitCode: .validationFailure)
 
@@ -58,6 +61,7 @@ final class RollDiceExampleTests: XCTestCase {
         Help:  --times <n>  Rolls the dice <n> times.
         Usage: roll [--times <n>] [--sides <m>] [--seed <seed>] [--verbose]
           See 'roll --help' for more information.
+
         """,
       exitCode: .validationFailure)
   }
diff --git a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testColorDoccReference().md b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testColorDoccReference().md
@@ -32,3 +32,8 @@ color help [<subcommands>...]
 ```
 
 **subcommands:**
+
+
+
+
+
diff --git a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testCountLinesDoccReference().md b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testCountLinesDoccReference().md
@@ -35,3 +35,8 @@ count-lines help [<subcommands>...]
 ```
 
 **subcommands:**
+
+
+
+
+
diff --git a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testMathDoccReference().md b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testMathDoccReference().md
@@ -205,3 +205,8 @@ math help [<subcommands>...]
 ```
 
 **subcommands:**
+
+
+
+
+
diff --git a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testRepeatDoccReference().md b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testRepeatDoccReference().md
@@ -35,3 +35,8 @@ repeat help [<subcommands>...]
 ```
 
 **subcommands:**
+
+
+
+
+
diff --git a/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testRollDoccReference().md b/Tests/ArgumentParserGenerateDoccReferenceTests/Snapshots/testRollDoccReference().md
@@ -42,3 +42,8 @@ roll help [<subcommands>...]
 ```
 
 **subcommands:**
+
+
+
+
+
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testADumpHelp().json b/Tests/ArgumentParserUnitTests/Snapshots/testADumpHelp().json
@@ -213,4 +213,4 @@
     ]
   },
   "serializationVersion" : 0
-}
+}
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testBDumpHelp().json b/Tests/ArgumentParserUnitTests/Snapshots/testBDumpHelp().json
@@ -108,4 +108,4 @@
     ]
   },
   "serializationVersion" : 0
-}
+}
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testBase_Bash().bash b/Tests/ArgumentParserUnitTests/Snapshots/testBase_Bash().bash
@@ -105,4 +105,4 @@ _base_test_help() {
 }
 
 
-complete -F _base_test base-test
+complete -F _base_test base-test
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testBase_Fish().fish b/Tests/ArgumentParserUnitTests/Snapshots/testBase_Fish().fish
@@ -58,4 +58,4 @@ complete -c base-test -n '_swift_base-test_using_command "base-test" "sub-comman
 complete -c base-test -n '_swift_base-test_using_command "base-test" "sub-command escaped-command help"' -s h -l help -d 'Show help information.'
 complete -c base-test -n '_swift_base-test_using_command "base-test" "sub-command escaped-command help"' -f -a 'sub-command' -d ''
 complete -c base-test -n '_swift_base-test_using_command "base-test" "sub-command escaped-command help"' -f -a 'escaped-command' -d ''
-complete -c base-test -n '_swift_base-test_using_command "base-test" "sub-command escaped-command help"' -f -a 'help' -d 'Show subcommand help information.'
+complete -c base-test -n '_swift_base-test_using_command "base-test" "sub-command escaped-command help"' -f -a 'help' -d 'Show subcommand help information.'
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testBase_Zsh().zsh b/Tests/ArgumentParserUnitTests/Snapshots/testBase_Zsh().zsh
@@ -107,4 +107,4 @@ _base-test_help() {
     return "${ret}"
 }
 
-_base-test
+_base-test
diff --git a/Tests/ArgumentParserUnitTests/Snapshots/testCDumpHelp().json b/Tests/ArgumentParserUnitTests/Snapshots/testCDumpHelp().json
@@ -239,4 +239,4 @@
     ]
   },
   "serializationVersion" : 0
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,10 @@ public struct CompletionShell: RawRepresentable, Hashable, CaseIterable {`
`102`	`102`	`func format(completions: [String]) -> String {`
`103`	`103`	`var completions = completions`
`104`	`104`	`if self == .zsh {`
`105`		`- completions.append("END_MARKER")`
	`105`	`+ // This pseudo-completion is removed by the zsh completion script.`
	`106`	`+ // It allows trailing empty string completions to work in zsh.`
	`107`	`+ // zsh completion scripts generated by older SAP versions ignore spaces.`
	`108`	`+ completions.append(" ")`
`106`	`109`	`}`
`107`	`110`	`return completions.joined(separator: "\n")`
`108`	`111`	`}`
-Original file line number
+Diff line change
 ```
 **subcommands:**
++
++
++
++
++