Updates to support Swift 6 language version (#650)

Some minor NFC changes to resolve strict concurrency checking
warnings/errors and the warning about the change in meaning for
`#file`.

Author: natecook1000

Sources/ArgumentParser/Utilities/Platform.swift

@@ -13,22 +13,19 @@ extension CommandLine {
   /// Accesses the command line arguments in a concurrency-safe way.
   ///
   /// Workaround for https://github.com/apple/swift/issues/66213
-  static let _staticArguments: [String] =
-    UnsafeBufferPointer(start: unsafeArgv, count: Int(argc))
-      .compactMap { String(validatingUTF8: $0!)
-  }
+  static let _staticArguments: [String] = Self.arguments
 }
 
 #if canImport(Glibc)
-import Glibc
+@preconcurrency import Glibc
 #elseif canImport(Musl)
-import Musl
+@preconcurrency import Musl
 #elseif canImport(Darwin)
 import Darwin
 #elseif canImport(CRT)
-import CRT
+@preconcurrency import CRT
 #elseif canImport(WASILibc)
-import WASILibc
+@preconcurrency import WASILibc
 #endif
 
 enum Platform {}

Sources/ArgumentParserTestHelpers/TestHelpers.swift

@@ -77,7 +77,7 @@ extension XCTestExpectation {
 public func AssertResultFailure<T, U: Error>(
   _ expression: @autoclosure () -> Result<T, U>,
   _ message: @autoclosure () -> String = "",
-  file: StaticString = #file,
+  file: StaticString = #filePath,
   line: UInt = #line)
 {
   switch expression() {
@@ -89,7 +89,7 @@ public func AssertResultFailure<T, U: Error>(
   }
 }
 
-public func AssertErrorMessage<A>(_ type: A.Type, _ arguments: [String], _ errorMessage: String, file: StaticString = #file, line: UInt = #line) where A: ParsableArguments {
+public func AssertErrorMessage<A>(_ type: A.Type, _ arguments: [String], _ errorMessage: String, file: StaticString = #filePath, line: UInt = #line) where A: ParsableArguments {
   do {
     _ = try A.parse(arguments)
     XCTFail("Parsing should have failed.", file: file, line: line)
@@ -99,7 +99,7 @@ public func AssertErrorMessage<A>(_ type: A.Type, _ arguments: [String], _ error
   }
 }
 
-public func AssertFullErrorMessage<A>(_ type: A.Type, _ arguments: [String], _ errorMessage: String, file: StaticString = #file, line: UInt = #line) where A: ParsableArguments {
+public func AssertFullErrorMessage<A>(_ type: A.Type, _ arguments: [String], _ errorMessage: String, file: StaticString = #filePath, line: UInt = #line) where A: ParsableArguments {
   do {
     _ = try A.parse(arguments)
     XCTFail("Parsing should have failed.", file: (file), line: line)
@@ -109,7 +109,7 @@ public func AssertFullErrorMessage<A>(_ type: A.Type, _ arguments: [String], _ e
   }
 }
 
-public func AssertParse<A>(_ type: A.Type, _ arguments: [String], file: StaticString = #file, line: UInt = #line, closure: (A) throws -> Void) where A: ParsableArguments {
+public func AssertParse<A>(_ type: A.Type, _ arguments: [String], file: StaticString = #filePath, line: UInt = #line, closure: (A) throws -> Void) where A: ParsableArguments {
   do {
     let parsed = try type.parse(arguments)
     try closure(parsed)
@@ -119,7 +119,7 @@ public func AssertParse<A>(_ type: A.Type, _ arguments: [String], file: StaticSt
   }
 }
 
-public func AssertParseCommand<A: ParsableCommand>(_ rootCommand: ParsableCommand.Type, _ type: A.Type, _ arguments: [String], file: StaticString = #file, line: UInt = #line, closure: (A) throws -> Void) {
+public func AssertParseCommand<A: ParsableCommand>(_ rootCommand: ParsableCommand.Type, _ type: A.Type, _ arguments: [String], file: StaticString = #filePath, line: UInt = #line, closure: (A) throws -> Void) {
   do {
     let command = try rootCommand.parseAsRoot(arguments)
     guard let aCommand = command as? A else {
@@ -136,7 +136,7 @@ public func AssertParseCommand<A: ParsableCommand>(_ rootCommand: ParsableComman
 public func AssertEqualStrings(
   actual: String,
   expected: String,
-  file: StaticString = #file,
+  file: StaticString = #filePath,
   line: UInt = #line
 ) {
   // If the input strings are not equal, create a simple diff for debugging...
@@ -207,7 +207,7 @@ public func AssertHelp<T: ParsableArguments>(
   for _: T.Type,
   columns: Int? = 80,
   equals expected: String,
-  file: StaticString = #file,
+  file: StaticString = #filePath,
   line: UInt = #line
 ) {
   let flag: String
@@ -246,7 +246,7 @@ public func AssertHelp<T: ParsableCommand, U: ParsableCommand>(
   root _: U.Type,
   columns: Int? = 80,
   equals expected: String,
-  file: StaticString = #file,
+  file: StaticString = #filePath,
   line: UInt = #line
 ) {
   let includeHidden: Bool
@@ -271,7 +271,7 @@ public func AssertHelp<T: ParsableCommand, U: ParsableCommand>(
 
 public func AssertDump<T: ParsableArguments>(
   for _: T.Type, equals expected: String,
-  file: StaticString = #file, line: UInt = #line
+  file: StaticString = #filePath, line: UInt = #line
 ) throws {
   do {
     _ = try T.parse(["--experimental-dump-help"])
@@ -284,7 +284,7 @@ public func AssertDump<T: ParsableArguments>(
   try AssertJSONEqualFromString(actual: T._dumpHelp(), expected: expected, for: ToolInfoV0.self, file: file, line: line)
 }
 
-public func AssertJSONEqualFromString<T: Codable & Equatable>(actual: String, expected: String, for type: T.Type, file: StaticString = #file, line: UInt = #line) throws {
+public func AssertJSONEqualFromString<T: Codable & Equatable>(actual: String, expected: String, for type: T.Type, file: StaticString = #filePath, line: UInt = #line) throws {
   if #available(macOS 10.13, iOS 11.0, tvOS 11.0, watchOS 4.0, *) {
     AssertEqualStrings(actual: actual, expected: expected, file: file, line: line)
   }
@@ -309,7 +309,7 @@ extension XCTest {
     command: String,
     expected: String? = nil,
     exitCode: ExitCode = .success,
-    file: StaticString = #file, line: UInt = #line) throws
+    file: StaticString = #filePath, line: UInt = #line) throws
   {
     try AssertExecuteCommand(
       command: command.split(separator: " ").map(String.init),
@@ -323,7 +323,7 @@ extension XCTest {
     command: [String],
     expected: String? = nil,
     exitCode: ExitCode = .success,
-    file: StaticString = #file, line: UInt = #line) throws
+    file: StaticString = #filePath, line: UInt = #line) throws
   {
     #if os(Windows)
     throw XCTSkip("Unsupported on this platform")
@@ -385,7 +385,7 @@ extension XCTest {
   public func AssertJSONOutputEqual(
     command: String,
     expected: String,
-    file: StaticString = #file,
+    file: StaticString = #filePath,
     line: UInt = #line
   ) throws {
     #if os(Windows)
@@ -439,7 +439,7 @@ extension XCTest {
     multiPage: Bool,
     command: String,
     expected: String,
-    file: StaticString = #file,
+    file: StaticString = #filePath,
     line: UInt = #line
   ) throws {
     #if os(Windows)

Tests/ArgumentParserEndToEndTests/AsyncCommandEndToEndTests.swift

@@ -32,6 +32,7 @@ actor AsyncStatusCheck {
   }
 }
 
+@MainActor
 var statusCheck = AsyncStatusCheck()
 
 // MARK: AsyncParsableCommand.main() testing

Tests/ArgumentParserEndToEndTests/NestedCommandEndToEndTests.swift

@@ -54,7 +54,7 @@ fileprivate struct Foo: ParsableCommand {
   }
 }
 
-fileprivate func AssertParseFooCommand<A>(_ type: A.Type, _ arguments: [String], file: StaticString = #file, line: UInt = #line, closure: (A) throws -> Void) where A: ParsableCommand {
+fileprivate func AssertParseFooCommand<A>(_ type: A.Type, _ arguments: [String], file: StaticString = #filePath, line: UInt = #line, closure: (A) throws -> Void) where A: ParsableCommand {
   AssertParseCommand(Foo.self, type, arguments, file: file, line: line, closure: closure)
 }
 

Tests/ArgumentParserEndToEndTests/SubcommandEndToEndTests.swift

@@ -110,8 +110,6 @@ extension SubcommandEndToEndTests {
   }
 }
 
-fileprivate var mathDidRun = false
-
 fileprivate struct Math: ParsableCommand {
   enum Operation: String, ExpressibleByArgument {
     case add
@@ -127,20 +125,22 @@ fileprivate struct Math: ParsableCommand {
   @Argument(help: "The first operand")
   var operands: [Int] = []
 
+  var didRun = false
+
   mutating func run() {
     XCTAssertEqual(operation, .multiply)
     XCTAssertTrue(verbose)
     XCTAssertEqual(operands, [5, 11])
-    mathDidRun = true
+    didRun = true
   }
 }
 
 extension SubcommandEndToEndTests {
   func testParsing_SingleCommand() throws {
-    var mathCommand = try Math.parseAsRoot(["--operation", "multiply", "-v", "5", "11"])
-    XCTAssertFalse(mathDidRun)
-    try mathCommand.run()
-    XCTAssertTrue(mathDidRun)
+    var mathCommand = try Math.parseAsRoot(["--operation", "multiply", "-v", "5", "11"]) as! Math
+    XCTAssertFalse(mathCommand.didRun)
+    mathCommand.run()
+    XCTAssertTrue(mathCommand.didRun)
   }
 }
 

Tests/ArgumentParserEndToEndTests/TransformEndToEndTests.swift

@@ -36,11 +36,11 @@ extension Convert {
 
 fileprivate struct FooOption: Convert, ParsableArguments {
 
-  static var usageString: String = """
+  static let usageString: String = """
   Usage: foo_option --string <int_str>
     See 'foo_option --help' for more information.
   """
-  static var help: String = "Help:  --string <int_str>  Convert string to integer\n"
+  static let help: String = "Help:  --string <int_str>  Convert string to integer\n"
 
   @Option(help: ArgumentHelp("Convert string to integer", valueName: "int_str"),
           transform: { try convert($0) })
@@ -49,11 +49,11 @@ fileprivate struct FooOption: Convert, ParsableArguments {
 
 fileprivate struct BarOption: Convert, ParsableCommand {
 
-  static var usageString: String = """
+  static let usageString: String = """
   Usage: bar-option [--strings <int_str> ...]
     See 'bar-option --help' for more information.
   """
-  static var help: String = "Help:  --strings <int_str>  Convert a list of strings to an array of integers\n"
+  static let help: String = "Help:  --strings <int_str>  Convert a list of strings to an array of integers\n"
 
   @Option(help: ArgumentHelp("Convert a list of strings to an array of integers", valueName: "int_str"),
           transform: { try convert($0) })
@@ -99,11 +99,11 @@ extension TransformEndToEndTests {
 
 fileprivate struct FooArgument: Convert, ParsableArguments {
 
-  static var usageString: String = """
+  static let usageString: String = """
   Usage: foo_argument <int_str>
     See 'foo_argument --help' for more information.
   """
-  static var help: String = "Help:  <int_str>  Convert string to integer\n"
+  static let help: String = "Help:  <int_str>  Convert string to integer\n"
 
   enum FooError: Error {
       case outOfBounds
@@ -116,11 +116,11 @@ fileprivate struct FooArgument: Convert, ParsableArguments {
 
 fileprivate struct BarArgument: Convert, ParsableCommand {
 
-  static var usageString: String = """
+  static let usageString: String = """
   Usage: bar-argument [<int_str> ...]
     See 'bar-argument --help' for more information.
   """
-  static var help: String = "Help:  <int_str>  Convert a list of strings to an array of integers\n"
+  static let help: String = "Help:  <int_str>  Convert a list of strings to an array of integers\n"
 
   @Argument(help: ArgumentHelp("Convert a list of strings to an array of integers", valueName: "int_str"),
             transform: { try convert($0) })

Tests/ArgumentParserEndToEndTests/ValidationEndToEndTests.swift

@@ -28,12 +28,12 @@ fileprivate enum UserValidationError: LocalizedError {
 }
 
 fileprivate struct Foo: ParsableArguments {
-  static var usageString: String = """
+  static let usageString: String = """
     Usage: foo [--count <count>] [<names> ...] [--version] [--throw]
       See 'foo --help' for more information.
     """
 
-  static var helpString: String = """
+  static let helpString: String = """
     USAGE: foo [--count <count>] [<names> ...] [--version] [--throw]
 
     ARGUMENTS:

Tests/ArgumentParserPackageManagerTests/HelpTests.swift

@@ -168,7 +168,7 @@ struct Simple: ParsableArguments {
   @Option() var min: Int?
   @Argument() var max: Int
 
-  static var helpText = """
+  static let helpText = """
         USAGE: simple [--verbose] [--min <min>] <max>
 
         ARGUMENTS:

Tests/ArgumentParserPackageManagerTests/PackageManager/Config.swift

@@ -17,7 +17,7 @@ extension Package {
 }
 
 extension Package.Config {
-  public static var configuration = CommandConfiguration(
+  public static let configuration = CommandConfiguration(
     subcommands: [GetMirror.self, SetMirror.self, UnsetMirror.self])
 
   /// Print mirror configuration for the given package dependency

Tests/ArgumentParserUnitTests/CompletionScriptTests.swift

@@ -131,7 +131,7 @@ extension CompletionScriptTests {
   func verifyCustomOutput(
     _ arg: String,
     expectedOutput: String,
-    file: StaticString = #file, line: UInt = #line
+    file: StaticString = #filePath, line: UInt = #line
   ) throws {
     do {
       _ = try Custom.parse(["---completion", "--", arg])