Merge branch 'main' into dev

Author: Chamepp

CHANGELOG.md

@@ -6,6 +6,10 @@ Add new items at the end of the relevant section under **Unreleased**.
 
 ## [Unreleased]
 
+---
+
+## [1.6.0] - 2025-06-30
+
 ### Additions
 
 - Options with `CaseIterable` types can now provide help descriptions on a per-value basis. ([#647])
@@ -16,6 +20,8 @@ Add new items at the end of the relevant section under **Unreleased**.
 
 - Testing and continuous integration improvements, including migrating to GitHub workflows.
   ([#692], [#693], [#696], [#698], [#699], [#700], [#701], [#708], [#711], [#718], [#716], [#714], [#712], [#732], [#730], [#746], [#747], [#760])
+- The associated closure for `CompletionKind.custom` now takes three parameters: the array of shell words currently in use for the completion request, the offset in that array for the word that completions are being requested for, and the prefix of that word that precedes the cursor. In addition, the associated closure can be `async`. The single-argument closure version of `CompletionKind.custom` is deprecated with this release. ([#763], [#770], [#782])
+- `ParsableArguments` and `ExpressibleByArgument` now conform to `SendableMetatype` when builing with a minimum Swift 6.2 compiler. ([#789])
 
 ### Fixes
 
@@ -30,6 +36,10 @@ Add new items at the end of the relevant section under **Unreleased**.
 - Better capturing of tool configuration in `ToolInfo`. ([#669], [#697])
 - Documentation improvements. ([#657], [#678], [#743])
 
+The 1.6.0 release includes contributions from [bripeticca], [cg-soft], [compnerd],
+[dshan4585], [heckj], [natecook1000], [rauhul], [rgoldberg], and [Steelskin].
+Thank you!
+
 ---
 
 ## [1.5.1] - 2025-05-28
@@ -943,7 +953,8 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
 
 <!-- Link references for releases -->
 
-[Unreleased]: https://github.com/apple/swift-argument-parser/compare/1.5.1...HEAD
+[Unreleased]: https://github.com/apple/swift-argument-parser/compare/1.6.0...HEAD
+[1.6.0]: https://github.com/apple/swift-argument-parser/compare/1.5.1...1.6.0
 [1.5.1]: https://github.com/apple/swift-argument-parser/compare/1.5.0...1.5.1
 [1.5.0]: https://github.com/apple/swift-argument-parser/compare/1.4.0...1.5.0
 [1.4.0]: https://github.com/apple/swift-argument-parser/compare/1.3.1...1.4.0
@@ -1130,7 +1141,9 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
 [#773]: https://github.com/apple/swift-argument-parser/pull/773
 [#775]: https://github.com/apple/swift-argument-parser/pull/775
 [#777]: https://github.com/apple/swift-argument-parser/pull/777
+[#782]: https://github.com/apple/swift-argument-parser/pull/782
 [#783]: https://github.com/apple/swift-argument-parser/pull/783
+[#789]: https://github.com/apple/swift-argument-parser/pull/789
 
 <!-- Link references for contributors -->
 
@@ -1144,7 +1157,9 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
 [atierian]: https://github.com/apple/swift-argument-parser/commits?author=atierian
 [Austinpayne]: https://github.com/apple/swift-argument-parser/commits?author=Austinpayne
 [BradLarson]: https://github.com/apple/swift-argument-parser/commits?author=BradLarson
+[bripeticca]: https://github.com/apple/swift-argument-parser/commits?author=bripeticca
 [buttaface]: https://github.com/apple/swift-argument-parser/commits?author=buttaface
+[cg-soft]: https://github.com/apple/swift-argument-parser/commits?author=cg-soft
 [Chamepp]: https://github.com/apple/swift-argument-parser/commits?author=Chamepp
 [clayellis]: https://github.com/apple/swift-argument-parser/commits?author=clayellis
 [CodaFi]: https://github.com/apple/swift-argument-parser/commits?author=CodaFi
@@ -1159,6 +1174,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
 [dirtyhabits97]: https://github.com/apple/swift-argument-parser/commits?author=dirtyhabits97
 [DougGregor]: https://github.com/apple/swift-argument-parser/commits?author=DougGregor
 [drewmccormack]: https://github.com/apple/swift-argument-parser/commits?author=drewmccormack
+[dshan4585]: https://github.com/apple/swift-argument-parser/commits?author=dshan4585
 [elliottwilliams]: https://github.com/apple/swift-argument-parser/commits?author=elliottwilliams
 [erica]: https://github.com/apple/swift-argument-parser/commits?author=erica
 [finagolfin]: https://github.com/apple/swift-argument-parser/commits?author=finagolfin
@@ -1169,6 +1185,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
 [gmittert]: https://github.com/apple/swift-argument-parser/commits?author=gmittert
 [griffin-stewie]: https://github.com/apple/swift-argument-parser/commits?author=griffin-stewie
 [gwynne]: https://github.com/apple/swift-argument-parser/commits?author=gwynne
+[heckj]: https://github.com/apple/swift-argument-parser/commits?author=heckj
 [iainsmith]: https://github.com/apple/swift-argument-parser/commits?author=iainsmith
 [ian-twilightcoder]: https://github.com/apple/swift-argument-parser/commits?author=ian-twilightcoder
 [ibrahimoktay]: https://github.com/apple/swift-argument-parser/commits?author=ibrahimoktay
@@ -1206,6 +1223,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
 [randomeizer]: https://github.com/apple/swift-argument-parser/commits?author=randomeizer
 [rauhul]: https://github.com/apple/swift-argument-parser/commits?author=rauhul
 [revolter]: https://github.com/apple/swift-argument-parser/commits?author=revolter
+[rgoldberg]: https://github.com/apple/swift-argument-parser/commits?author=rgoldberg
 [rickrizzo]: https://github.com/apple/swift-argument-parser/commits?author=rickrizzo
 [rjstelling]: https://github.com/apple/swift-argument-parser/commits?author=rjstelling
 [robertmryan]: https://github.com/apple/swift-argument-parser/commits?author=robertmryan
@@ -1215,6 +1233,7 @@ This changelog's format is based on [Keep a Changelog](https://keepachangelog.co
 [sgl0v]: https://github.com/apple/swift-argument-parser/commits?author=sgl0v
 [sharplet]: https://github.com/apple/swift-argument-parser/commits?author=sharplet
 [sjavora]: https://github.com/apple/swift-argument-parser/commits?author=sjavora
+[Steelskin]: https://github.com/apple/swift-argument-parser/commits?author=Steelskin
 [stuartcarnie]: https://github.com/apple/swift-argument-parser/commits?author=stuartcarnie
 [thomasvl]: https://github.com/apple/swift-argument-parser/commits?author=thomasvl
 [TiagoMaiaL]: https://github.com/apple/swift-argument-parser/commits?author=TiagoMaiaL

Sources/ArgumentParser/CMakeLists.txt

@@ -46,6 +46,7 @@ add_library(ArgumentParser
   Utilities/Platform.swift
   Utilities/SequenceExtensions.swift
   Utilities/StringExtensions.swift
+  Utilities/SwiftExtensions.swift
   Utilities/Tree.swift
 
   Validators/CodingKeyValidator.swift

Sources/ArgumentParser/Parsable Types/ExpressibleByArgument.swift

@@ -10,7 +10,7 @@
 //===----------------------------------------------------------------------===//
 
 /// A type that can be expressed as a command-line argument.
-public protocol ExpressibleByArgument {
+public protocol ExpressibleByArgument: _SendableMetatype {
   /// Creates a new instance of this type from a command-line-specified
   /// argument.
   init?(argument: String)

Sources/ArgumentParser/Parsable Types/ParsableArguments.swift

@@ -13,7 +13,7 @@
 ///
 /// When you implement a `ParsableArguments` type, all properties must be declared with
 /// one of the four property wrappers provided by the `ArgumentParser` library.
-public protocol ParsableArguments: Decodable {
+public protocol ParsableArguments: Decodable, _SendableMetatype {
   /// Creates an instance of this parsable type using the definitions
   /// given by each property's wrapper.
   init()

Sources/ArgumentParser/Utilities/SwiftExtensions.swift

@@ -0,0 +1,17 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift Argument Parser open source project
+//
+// Copyright (c) 2020 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+//
+//===----------------------------------------------------------------------===//
+
+#if compiler(>=6.2)
+/// Designates a type as having a sendable metatype.
+public protocol _SendableMetatype: SendableMetatype {}
+#else
+public protocol _SendableMetatype {}
+#endif

Tests/ArgumentParserEndToEndTests/CustomParsingEndToEndTests.swift

@@ -35,17 +35,19 @@ extension Array where Element == Name {
 // MARK: -
 
 private struct Foo: ParsableCommand {
-  enum Subgroup: Equatable {
+  enum Subgroup: Equatable, Sendable {
     case first(Int)
     case second(Int)
 
+    @Sendable
     static func makeFirst(_ str: String) throws -> Subgroup {
       guard let value = Int(str) else {
         throw ValidationError("Not a valid integer for 'first'")
       }
       return .first(value)
     }
 
+    @Sendable
     static func makeSecond(_ str: String) throws -> Subgroup {
       guard let value = Int(str) else {
         throw ValidationError("Not a valid integer for 'second'")

Tests/ArgumentParserUnitTests/HelpGenerationTests.swift

@@ -148,6 +148,8 @@ extension HelpGenerationTests {
   enum OptionFlags: String, EnumerableFlag { case optional, required }
   enum Degree {
     case bachelor, graduate, doctorate
+
+    @Sendable
     static func degreeTransform(_ string: String) throws -> Degree {
       switch string {
       case "bachelor":

Tests/ArgumentParserUnitTests/UsageGenerationTests.swift

@@ -132,6 +132,7 @@ extension UsageGenerationTests {
     enum Color {
       case red, blue
 
+      @Sendable
       static func transform(_ string: String) throws -> Color {
         switch string {
         case "red":