From 55f3ca2f7b6f22cba5be5e196bed482bb7db3533 Mon Sep 17 00:00:00 2001 From: "T. R. Bernstein" Date: Mon, 16 Mar 2026 16:37:15 +0100 Subject: [PATCH] Temporary fix of SwiftPM Bug using task.sh SwiftPM has currently a bug, that products or targets of dependencies are taken into consideration when resolving names, regardless if they're used or not by the root package. This stops Swift PM from working on packages, that declare this package as a dependency and define their own TaskCLI target, as they collide with the definitions of this package. This is resolved, by prefixing TaskCLI with the package name. The product collision - which causes swift run - to run this package's task executable is resolved, by adding that product only temporarily during task execution using task.sh. See https://github.com/swiftlang/swift-package-manager/issues/8482 --- .github/workflows/docs.yml | 4 +- Package.swift | 9 +-- README.md | 7 ++- Sources/TaskCLI/DoccFinder.swift | 26 +++------ .../GenerateDocumentation Command.swift | 31 ++++++++-- Sources/TaskCLI/TaskCLI.docc/TaskCLI.md | 10 +++- task.sh | 58 +++++++++++++++++++ 7 files changed, 109 insertions(+), 36 deletions(-) create mode 100755 task.sh diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 226d478..ab813b6 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -30,7 +30,7 @@ jobs: - name: Generate Docs run: | swift package add-dependency --from 1.4.0 "https://github.com/apple/swift-docc-plugin.git" - for target in Inotify TaskCLI; do + for target in Inotify InotifyTaskCLI; do lower="${target,,}" mkdir -p "./public/$lower" swift package --allow-writing-to-directory "./public/$lower" \ @@ -44,7 +44,7 @@ jobs: cp ./.github/workflows/index.tpl.html public/index.html sed -i -e 's/{{project.name}}/Swift Inotify/g' public/index.html sed -i -e 's/{{project.tagline}}/🗂️ Monitor filesystem events on Linux using modern Swift concurrency/g' public/index.html - sed -i -e 's|{{project.links}}|
  • Inotify: The actual library.
  • TaskCLI: The project build command.
    • |g' public/index.html + sed -i -e 's|{{project.links}}|
  • Inotify: The actual library.
  • TaskCLI: The project build command.
    • |g' public/index.html - name: Upload artifact uses: actions/upload-pages-artifact@v4 with: diff --git a/Package.swift b/Package.swift index daeb350..134488d 100644 --- a/Package.swift +++ b/Package.swift @@ -8,10 +8,6 @@ let package = Package( .library( name: "Inotify", targets: ["Inotify"] - ), - .executable( - name: "task", - targets: ["TaskCLI"] ) ], dependencies: [ @@ -42,7 +38,7 @@ let package = Package( ], ), .executableTarget( - name: "TaskCLI", + name: "InotifyTaskCLI", dependencies: [ .product(name: "ArgumentParser", package: "swift-argument-parser"), .product(name: "AsyncAlgorithms", package: "swift-async-algorithms"), @@ -50,7 +46,8 @@ let package = Package( .product(name: "_NIOFileSystem", package: "swift-nio"), .product(name: "Subprocess", package: "swift-subprocess"), .product(name: "Noora", package: "Noora") - ] + ], + path: "Sources/TaskCLI" ) ] ) diff --git a/README.md b/README.md index dfcbb99..4acbad2 100644 --- a/README.md +++ b/README.md @@ -132,11 +132,14 @@ try inotify.removeWatch(wd) ## Build Tool The package ships with a `task` executable (the `TaskCLI` target) that serves as the project's build tool. It automates running tests and generating documentation inside Linux Docker containers, so you can validate everything on the correct platform even when developing on macOS. +Because of a Swift Package Manager Bug in the [package dependency resolution][swiftpm-bug], the executable needs to be run using the `task.sh` shell script. + +[swiftpm-bug]: https://github.com/swiftlang/swift-package-manager/issues/8482 ### Tests ```bash -swift run task test +./task.sh test ``` Use `-v`, `-vv`, or `-vvv` to increase log verbosity. The command runs two passes: first all tests except `InotifyLimitTests`, then only `InotifyLimitTests` (which manipulate system-level inotify limits and need to run in isolation). @@ -148,7 +151,7 @@ Docker must be installed and running on your machine. Full API documentation is available as DocC catalogs bundled with the package. Generate them locally with: ```bash -swift run task generate-docs +./task.sh generate-docs ``` Then open the files in the newly created `public` folder. diff --git a/Sources/TaskCLI/DoccFinder.swift b/Sources/TaskCLI/DoccFinder.swift index d2bfa57..2e23102 100644 --- a/Sources/TaskCLI/DoccFinder.swift +++ b/Sources/TaskCLI/DoccFinder.swift @@ -3,27 +3,15 @@ import _NIOFileSystem public struct DoccFinder { static let fileManager = FileSystem.shared - public static func getTargetsWithDocumentation(at paths: String...) async throws -> [String] { - try await Self.getTargetsWithDocumentation(at: paths) - } + public static func hasDoccFolder(at path: String) async throws -> Bool { + let itemPath = FilePath(path) + var hasDoccFolder = false - static func getTargetsWithDocumentation(at paths: [String]) async throws -> [String] { - var resolved: [String] = [] - - for path in paths { - let itemPath = FilePath(path) - - try await withSubdirectories(at: itemPath) { targetPath in - print("Target path is", targetPath.description) - try await withSubdirectories(at: targetPath) { subdirectory in - guard subdirectory.description.hasSuffix(".docc") else { return } - guard let target = targetPath.lastComponent?.description else { return } - resolved.append(target) - } - } + try await withSubdirectories(at: itemPath) { subdirectory in + guard subdirectory.description.hasSuffix(".docc") else { return } + hasDoccFolder = true } - - return resolved + return hasDoccFolder } private static func withSubdirectories(at path: FilePath, body: (FilePath) async throws -> Void) async throws { diff --git a/Sources/TaskCLI/GenerateDocumentation Command.swift b/Sources/TaskCLI/GenerateDocumentation Command.swift index d9acf63..8f5c2aa 100644 --- a/Sources/TaskCLI/GenerateDocumentation Command.swift +++ b/Sources/TaskCLI/GenerateDocumentation Command.swift @@ -90,7 +90,7 @@ struct GenerateDocumentationCommand: AsyncParsableCommand { ("{{project.tagline}}", "🗂️ Monitor filesystem events on Linux using modern Swift concurrency"), ("{{project.links}}", """
  • Inotify: The actual library.
    • \ -
  • TaskCLI: The project build command.
    • +
  • TaskCLI: The project build command.
    • """), ] @@ -106,9 +106,32 @@ struct GenerateDocumentationCommand: AsyncParsableCommand { } private static func targets(for projectDirectory: URL) async throws -> [String] { - let sourcesDirectory = projectDirectory.appending(path: "Sources").path - let testsDirectory = projectDirectory.appending(path: "Tests").path - return try await DoccFinder.getTargetsWithDocumentation(at: sourcesDirectory, testsDirectory) + let packages = try await Self.packageTargets() + var packagesWithDoccFolder: [(name: String, path: String)] = [] + for package in packages { + guard try await DoccFinder.hasDoccFolder(at: package.path) else { continue } + packagesWithDoccFolder.append(package) + } + return packagesWithDoccFolder.map { $0.name } + } + + private static func packageTargets() async throws -> [(name: String, path: String)] { + let packageDescription = try await Subprocess.run( + .name("swift"), + arguments: ["package", "describe", "--type", "json"], + output: .data(limit: 20_000) + ) + + struct PackageDescription: Codable { + let targets: [Target] + } + struct Target: Codable { + let name: String + let path: String + } + + let package = try JSONDecoder().decode(PackageDescription.self, from: packageDescription.standardOutput) + return package.targets.map { ($0.name, $0.path) } } private static func makeRunScript(for targets: [String]) -> String { diff --git a/Sources/TaskCLI/TaskCLI.docc/TaskCLI.md b/Sources/TaskCLI/TaskCLI.docc/TaskCLI.md index d3fe160..58efb5a 100644 --- a/Sources/TaskCLI/TaskCLI.docc/TaskCLI.md +++ b/Sources/TaskCLI/TaskCLI.docc/TaskCLI.md @@ -1,4 +1,4 @@ -# ``TaskCLI`` +# ``InotifyTaskCLI`` The build tool for the Swift Inotify project. @@ -6,10 +6,14 @@ The build tool for the Swift Inotify project. `TaskCLI` is a small command-line executable (exposed as `task` in `Package.swift`) that automates project-level workflows. Its primary purpose is running integration tests and generating documentation inside Linux Docker containers, so you can validate inotify-dependent code on the correct platform even when developing on macOS. +Because of a Swift Package Manager Bug in the [package dependency resolution][swiftpm-bug], the executable needs to be run using the `task.sh` shell script. + +[swiftpm-bug]: https://github.com/swiftlang/swift-package-manager/issues/8482 + ### Running the Tests ```bash -swift run task test +./task.sh test ``` This launches a `swift:latest` Docker container with the repository mounted at `/code`, then executes two test passes: @@ -22,7 +26,7 @@ The container is started with `--security-opt systempaths=unconfined` so that th ### Generating Documentation ```bash -swift run task generate-documentation +./task.sh generate-documentation ``` This copies the project to a temporary directory, injects the `swift-docc-plugin` dependency via `swift package add-dependency` (if absent), and runs documentation generation inside a `swift:latest` Docker container. The resulting static sites are written to `./public/inotify/` and `./public/taskcli/`, ready for deployment to GitHub Pages. diff --git a/task.sh b/task.sh new file mode 100755 index 0000000..e40fb94 --- /dev/null +++ b/task.sh @@ -0,0 +1,58 @@ +#!/usr/bin/env zsh + +# task - Run the package's TaskCLI target via a transient "task" product. +# +# Works around https://github.com/swiftlang/swift-package-manager/issues/8482 +# by temporarily adding an executable product named "task" to Package.swift, +# running it with `swift run`, and restoring the original manifest afterwards. +# +# Usage: task [arguments...] +# +# The script auto-detects the package name from Package.swift and expects an +# executable target named "TaskCLI" to exist. + +set -euo pipefail + +# --- Resolve the package root (search upward for Package.swift) ----------- + +package_root="${PWD}" +while [[ ! -f "${package_root}/Package.swift" ]]; do + package_root="${package_root:h}" # zsh dirname + if [[ "${package_root}" == "/" ]]; then + echo "error: Could not find Package.swift in any parent directory." >&2 + exit 1 + fi +done + +manifest="${package_root}/Package.swift" +backup="${manifest}.task-backup" + +# --- Extract the package name --------------------------------------------- + +package_name=$(sed -n 's/^.*name:[[:space:]]*"\([^"]*\)".*/\1/p' "${manifest}" | head -1) +if [[ -z "${package_name}" ]]; then + echo "error: Could not determine package name from ${manifest}." >&2 + exit 1 +fi + +target_name="${package_name}TaskCLI" + +# --- Cleanup trap (runs on EXIT — covers success, failure, signals) ------- + +function cleanup { + if [[ -f "${backup}" ]]; then + mv -f "${backup}" "${manifest}" + fi +} +trap cleanup EXIT + +# --- Inject the transient "task" product ---------------------------------- + +cp -f "${manifest}" "${backup}" + +swift package --package-path "${package_root}" \ + add-product task --type executable --targets "${target_name}" + +# --- Run it (forward all script arguments) -------------------------------- + +swift run --package-path "${package_root}" task "$@"