Swift 6, package and doc updates

Author: RISCfuture

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: CI
+name: Build
 
 on:
   push:
@@ -12,16 +12,16 @@ concurrency:
 
 jobs:
   tests:
-    name: Build and Test
+    name: Build
+    runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        swift: ["5.10"]
-        os: [macos-14]
-    runs-on: ${{ matrix.os }}
+        os: [macos-14, macos-latest]
+        swift: ["6.0"]
     steps:
       - uses: actions/checkout@v4
-      - uses: swift-actions/setup-swift@v2
+      - uses: SwiftyLab/setup-swift@latest
         with:
           swift-version: ${{ matrix.swift }}
       - name: Build

Package.resolved

@@ -1,14 +1,15 @@
-// swift-tools-version: 5.10
+// swift-tools-version: 6.0
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
 
 let package = Package(
     name: "GameGenerator",
+    defaultLocalization: "en",
     platforms: [.macOS(.v14)],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.2.0"),
-        .package(url: "https://github.com/apple/swift-algorithms", from: "1.2.0"),
+        .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.5.0"),
+        .package(url: "https://github.com/apple/swift-algorithms.git", from: "1.2.0"),
         .package(url: "https://github.com/jkandzi/Progress.swift.git", from: "0.4.0")
     ],
     targets: [
@@ -22,5 +23,6 @@ let package = Package(
                 .product(name: "Progress", package: "Progress.swift")
             ]
         ),
-    ]
+    ],
+    swiftLanguageModes: [.v6]
 )

Package.swift

@@ -4,28 +4,34 @@ import ArgumentParser
 /// Entry point for the command-line tool.
 @main
 struct GameGenerator: AsyncParsableCommand {
-    static let configuration = CommandConfiguration(abstract: "Finds Fourtile games and streams the output as JSON, for use in the Fourtile web game.",
-                                                    discussion: """
-This game attempts to find as many Fourtile games as possible. Games are
-streamed in JSON format to stdout or a file. Games are found using a randomized
-heuristic, so there is no guarantee that every possible game will be found. This
-is why games are streamed to stdout as they are found: Finding each next game
-becomes computationally more expensive as more randomizations are required.
-
-It is the intention that the user will abort this script when the time to find
-the next game becomes unreasonable, and the user is satisfied with the number
-of games found. The only required step is then to clean up the end of the JSON
-file.
-
-When writing games to a file, stdout is used to show a progress indicator, which
-is normalized to the theoretical maximum number of possible games.
-""",
-                                                    version: "1.0.0")
-
-    @Option(name: .shortAndLong, help: "The text file containing dictionary words.", completion: .file(extensions: ["txt"]), transform: { URL(fileURLWithPath: $0) })
+    static let configuration = CommandConfiguration(
+        abstract: "Finds Fourtile games and streams the output as JSON, for use in the Fourtile web game.",
+        discussion: """
+            This game attempts to find as many Fourtile games as possible. Games are
+            streamed in JSON format to stdout or a file. Games are found using a randomized
+            heuristic, so there is no guarantee that every possible game will be found. This
+            is why games are streamed to stdout as they are found: Finding each next game
+            becomes computationally more expensive as more randomizations are required.
+
+            It is the intention that the user will abort this script when the time to find
+            the next game becomes unreasonable, and the user is satisfied with the number
+            of games found. The only required step is then to clean up the end of the JSON
+            file.
+
+            When writing games to a file, stdout is used to show a progress indicator, which
+            is normalized to the theoretical maximum number of possible games.
+            """,
+        version: "1.0.0")
+
+    @Option(name: .shortAndLong,
+            help: "The text file containing dictionary words.",
+            completion: .file(extensions: ["txt"]),
+            transform: { URL(filePath: $0, directoryHint: .notDirectory) })
     var dictionary: URL
 
-    @Option(name: .shortAndLong, help: "The JSON file to write game data to.", transform: { URL(fileURLWithPath: $0) })
+    @Option(name: .shortAndLong,
+            help: "The JSON file to write game data to.",
+            transform: { URL(filePath: $0, directoryHint: .notDirectory) })
     var output: URL? = nil
 
     /// Entry point for the command line tool.

Sources/GameGenerator.swift

@@ -11,7 +11,8 @@ import Dispatch
  - Exactly ``numFourtilesPerGame`` fourtiles are constructible.
  - No words are constructible with more than ``numTilesPerFourtile`` tiles.
  - Each word is constructible using only one combination of tiles.
- - At least ``minWordsPerGame`` are constructible using between ``minTilesPerWord`` and ``numTilesPerFourtile`` tiles.
+ - At least ``minWordsPerGame`` are constructible using between
+   ``minTilesPerWord`` and ``numTilesPerFourtile`` tiles.
 
  Fourtiles are defined as words constructible with ``numTilesPerFourtile``
  tiles, with each tile having between ``minCharactersPerTile`` and
@@ -22,8 +23,8 @@ import Dispatch
  streamed to a given file handle in JSON format. The process can be interrupted
  at any point, though you will have to add the closing `]` in the output JSON.
  */
-class GameFinder {
-    
+actor GameFinder {
+
     /// The minimum number of characters to use when splitting a word into tiles.
     static let minCharactersPerTile = 2