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
Implement watch exclusion lists
2026-03-20 21:10:01 +01:00 · 2026-03-15 22:46:59 +01:00 · 2026-03-15 22:46:59 +01:00 · 2026-03-15 22:46:59 +01:00 · 2026-03-15 22:46:59 +01:00 · 2026-03-15 22:46:59 +01:00
17 changed files with 387 additions and 137 deletions
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -26,50 +26,25 @@ jobs:
    - name: Set up Swift
      uses: swift-actions/setup-swift@v3
      with:
-        swift-version: '6.2.4'
-    - name: Inject DocC Plugin Dependency
-      run: |
-        if ! grep -q 'swift-docc-plugin' Package.swift; then
-          awk 'BEGIN{done=0} /dependencies: \[/ && done==0 {print; print "\t\t.package(url: \"https://github.com/apple/swift-docc-plugin.git\", from: \"1.4.0\"),"; done=1; next}1' Package.swift > Package.swift.tmp
-          mv Package.swift.tmp Package.swift
-        fi
+        skip-verify-signature: true
    - name: Generate Docs
      run: |
-        swift package generate-documentation --target Inotify
-        swift package generate-documentation --target TaskCLI
-    - name: Transform for Static Hosting
+        swift package add-dependency --from 1.4.0 "https://github.com/apple/swift-docc-plugin.git"
+        for target in Inotify InotifyTaskCLI; do
+          lower="${target,,}"
+          mkdir -p "./public/$lower"
+          swift package --allow-writing-to-directory "./public/$lower" \
+            generate-documentation --disable-indexing --transform-for-static-hosting \
+            --target "$target" \
+            --hosting-base-path "swift-inotify/$lower" \
+            --output-path "./public/$lower"
+        done
+    - name: Copy Index Page
      run: |
-        OUTPUTS=.build/plugins/Swift-DocC/outputs
-
-        mkdir -p ./public/inotify ./public/taskcli
-
-        docc process-archive transform-for-static-hosting \
-          "$OUTPUTS/Inotify.doccarchive" \
-          --output-path ./public/inotify \
-          --hosting-base-path swift-inotify/inotify
-
-        docc process-archive transform-for-static-hosting \
-          "$OUTPUTS/TaskCLI.doccarchive" \
-          --output-path ./public/taskcli \
-          --hosting-base-path swift-inotify/taskcli
-    - name: Create Index Page
-      run: |
-        cat > ./public/index.html <<'HTML'
-        <!DOCTYPE html>
-        <html lang="en">
-        <head>
-          <meta charset="utf-8">
-          <title>Swift Inotify – Documentation</title>
-        </head>
-        <body>
-          <h1>Swift Inotify – Documentation</h1>
-          <ul>
-            <li><a href="inotify/documentation/inotify/">Inotify: The actual library.</a></li>
-            <li><a href="taskcli/documentation/taskcli/">TaskCLI: The project build command.</a></li>
-          </ul>
-        </body>
-        </html>
-        HTML
+        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}}|<li><a href="inotify/documentation/inotify/">Inotify</a>: The actual library.</li><li><a href="inotifytaskcli/documentation/inotifytaskcli/">TaskCLI</a>: The project build command.</li>|g' public/index.html
    - name: Upload artifact
      uses: actions/upload-pages-artifact@v4
      with:
--- a/.github/workflows/index.tpl.html
+++ b/.github/workflows/index.tpl.html
@@ -0,0 +1,72 @@
+<!doctype html>
+<html>
+	<head>
+		<title>Astzweig | Swift Inotify</title>
+		<meta name="description" content="Monitor filesystem events on Linux using modern Swift concurrency.">
+		<meta name="viewport" content="width=device-width, initial-scale=1.0">
+		<meta charset="utf-8">
+		<style>
+			:root {
+			  color-scheme: light dark;
+			}
+
+			html, body {
+				font-family: system-ui, sans-serif;
+				background-color: ligh-dark(#ffffff, #000000);
+				color: ligh-dark(#000000, #ffffff);
+			}
+
+			main {
+				max-width: min(40em, 100vw);
+				min-height: 80vh;
+				margin: 1rem auto;
+				display: flex;
+				flex-direction: column;
+				align-items: center;
+			}
+
+			svg {
+				max-width: 12em;
+				margin: 1rem;
+			}
+
+			footer {
+				max-width: min(60em, 100vw);
+				margin: 1rem auto;
+				font-size: .7rem;
+				font-family: ui-monospace, monospace;
+				
+				h1 {
+					font-size: 1rem;
+				}
+			}
+		</style>
+	</head>
+	<body>
+		<main>
+			<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 531 118"><g fill-rule="evenodd"><style>g { fill: #000; } @media (prefers-color-scheme: dark) { g { fill: #fff; } }</style><g fill-rule="nonzero"><path d="M147.81 96.877q-6.907 0-13.474-1.579t-10.55-4.009l5.703-12.975q3.777 2.3 8.88 3.662t10.034 1.362q4.752 0 6.621-1.01t1.87-2.77q0-1.541-1.732-2.308t-4.578-1.176a920 920 0 0 0-6.258-.874q-3.411-.465-6.859-1.35t-6.293-2.623-4.577-4.71-1.731-7.64q0-5.14 3.057-9.184t8.95-6.424 14.379-2.38q5.783 0 11.612 1.147 5.83 1.147 9.881 3.416l-5.703 12.976q-4.046-2.3-8.033-3.15-3.99-.85-7.58-.85-4.799 0-6.782 1.11-1.984 1.11-1.984 2.7 0 1.602 1.73 2.42 1.732.819 4.578 1.258 2.846.438 6.259.904 3.413.465 6.824 1.385 3.411.918 6.258 2.641t4.578 4.68 1.73 7.594q0 4.932-3.037 8.98t-9.012 6.413-14.76 2.364m59.104 0q-10.4 0-16.173-5.125-5.772-5.124-5.772-15.555V29.652h19v46.314q0 2.966 1.567 4.614t4.126 1.648q3.334 0 5.752-1.748l4.748 13.28q-2.476 1.591-5.97 2.354-3.495.763-7.278.763m-29.88-38.87V43.835h39.252v14.174zM224.539 96V84.831l30.465-35.037 3.203 6.144h-32.931V41.766h48.283v11.168l-30.466 35.038-3.265-6.144h34.739V96zM294.751 96l-19.217-54.234h17.988l15.268 45.362h-8.625l15.969-45.362h16.128l15.363 45.362h-8.417l15.768-45.362h16.697L352.425 96h-18.432l-12.957-37.528h5.543L313.184 96zM404.332 96.877q-9.597 0-16.768-3.639-7.17-3.638-11.115-9.995t-3.946-14.395q0-8.175 3.88-14.498t10.65-9.891q6.77-3.57 15.261-3.57 8.007 0 14.593 3.278t10.504 9.547q3.917 6.27 3.917 15.258 0 1.046-.084 2.34a87 87 0 0 1-.185 2.37H388.1v-9.968h32.863l-7.228 2.806q.031-3.697-1.414-6.397t-3.957-4.213-5.932-1.513-5.983 1.513-3.957 4.23-1.395 6.474v2.903q0 3.966 1.68 6.885t4.776 4.448 7.355 1.53q4.049 0 6.902-1.156t5.584-3.496l10 10.41q-3.876 4.268-9.587 6.503-5.71 2.236-13.475 2.236M439.997 96V41.8h19V96zm9.5-60.2q-5.199 0-8.4-2.9-3.2-2.9-3.2-7.2t3.2-7.2q3.201-2.9 8.4-2.9 5.2 0 8.4 2.75t3.2 7.05q0 4.5-3.15 7.45t-8.45 2.95m48.242 80.477q-7.852 0-14.92-1.779-7.07-1.778-11.985-5.301l6.888-13.26q3.324 2.655 8.413 4.215t9.893 1.559q7.651 0 11.04-3.338t3.388-9.77v-6.369l1-15.23-.087-15.263v-9.975h18.087v44.328q0 15.403-8.304 22.793t-23.413 7.39m-3.376-23.06q-7.18 0-13.226-3.25t-9.7-9.119-3.654-13.845q0-7.975 3.654-13.844 3.654-5.87 9.7-9.07t13.226-3.2q6.976 0 11.836 2.77t7.433 8.572 2.573 14.772q0 8.97-2.573 14.773-2.573 5.804-7.433 8.622-4.86 2.82-11.836 2.82m4.51-15.117q3.444 0 6.103-1.395t4.17-3.907q1.51-2.512 1.51-5.795 0-3.351-1.51-5.829-1.512-2.477-4.17-3.822-2.66-1.344-6.102-1.344-3.346 0-6.054 1.344-2.71 1.345-4.253 3.822-1.545 2.478-1.545 5.83 0 3.282 1.545 5.794 1.544 2.513 4.253 3.907 2.707 1.395 6.054 1.395"/></g><path d="M102.666 13.772h-.014v20.424q2.888.297 5.777.823l.886.167a3.66 3.66 0 0 1 2.96 3.592v53.253a3.66 3.66 0 0 1-2.96 3.595A74 74 0 0 1 95.137 97a75 75 0 0 1-14.267-1.38 3.66 3.66 0 0 1-2.963-3.59V73.025L48.733 58.685l-16.18 12.641a3.66 3.66 0 0 1-4.743-.198 89 89 0 0 1-6.423-6.61V76.41a.84.84 0 0 1-.839.84H9.625v-6.275h5.462V62.61H6.684v5.437H.383V57.175c0-.463.375-.839.838-.839h13.816a90 90 0 0 1-4.592-7.441 3.66 3.66 0 0 1 .95-4.653L55.14 10.064a3.66 3.66 0 0 1 4.743.206 92 92 0 0 1 4.114 4.076L80.529 2.338l-.011-.015c7.448-5.467 22.318-.83 22.148 11.45m-20.448 8.263-7.713 5.812a90 90 0 0 1 2.747 4.647 3.66 3.66 0 0 1-.951 4.654L63.132 47.436l14.773 7.362V38.785a3.66 3.66 0 0 1 2.969-3.596 78 78 0 0 1 4.593-.744v-9.294h-.008v-.387c-.012-1.379-.215-4.408-3.085-2.818zm.946-9.41-12.606 9.497a88 88 0 0 1 2.437 3.42l7.589-5.718-.005-.008.067-.065c1.184-1.096 7.144-4.065 7.558 4.454l.013.324q.01.303.01.622h-.01v8.984q2.065-.194 4.124-.273V19.77h-.036c-.113-7.551-3.735-10.214-8.96-7.25zm-1.004-8.07-16.292 11.83a88 88 0 0 1 3.007 3.563l12.505-9.423-.022-.028q.314-.25.662-.48l.248-.16c4.557-2.813 12.944-2.85 12.838 9.914h-.016l.001 14.038h.045q2.384 0 4.767.155V13.772h-.013c.142-7.384-9.941-14.798-17.73-9.216"/></g></svg>
+			<hgroup>
+				<h1>{{project.name}}</h1>
+				<p>{{project.tagline}}</p>
+			</hgroup>
+			<h2>Documentations</h2>
+			<ul>
+				{{project.links}}
+			</ul>
+		</main>
+		<footer vocab="https://schema.org/" typeof="Organization">
+			© <span property="legalName">Astzweig GmbH &amp; Co. KG</span>,
+			based in
+			<span property="location">Freiburg i. Br.</span>,
+			entered in the commercial register of the Freiburg Local Court under number HRA 703853 and VAT ID number:
+			<span property="vatID">DE297037836</span>.
+			The general partner is
+			<span property="parentOrganization" typeof="Organization">
+				<span property="legalName">Astzweig Verwaltungsgesellschaft mbH</span>
+				based in <span property="location">Freiburg i.Br.</span>,
+				entered in the commercial register of the same court under number HRB 718037 and with a capital of €25,000.00, represented by the managing director
+				<span property="employee" type="Person"><span property="givenName">Thomas R.</span> <span property="familyName">Bernstein</span>.</span>
+			</span>
+		</footer>
+	</body>
+</html>
--- a/.spi.yml
+++ b/.spi.yml
@@ -2,3 +2,4 @@ version: 1
 builder:
  configs:
    - documentation_targets: [Inotify, TaskCLI]
+      platform: Linux
--- 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,14 +38,16 @@ let package = Package(
 			],
 		),
 		.executableTarget(
-			name: "TaskCLI",
+			name: "InotifyTaskCLI",
 			dependencies: [
 				.product(name: "ArgumentParser", package: "swift-argument-parser"),
 				.product(name: "AsyncAlgorithms", package: "swift-async-algorithms"),
 				.product(name: "Logging", package: "swift-log"),
+				.product(name: "_NIOFileSystem", package: "swift-nio"),
 				.product(name: "Subprocess", package: "swift-subprocess"),
 				.product(name: "Noora", package: "Noora")
-			]
+			],
+			path: "Sources/TaskCLI"
 		)
 	]
 )
--- a/README.md
+++ b/README.md
@@ -75,6 +75,24 @@ try await inotify.addWatchWithAutomaticSubtreeWatching(

 This is the most convenient option when you need full coverage of a growing directory tree.

+## Excluding Items
+
+You can tell the `Inotify` actor to ignore certain file or directory names. Excluded names are skipped during recursive directory resolution (so no watch is installed on them) and silently dropped from the event stream:
+
+```swift
+let inotify = try Inotify()
+
+// Ignore version-control and build directories
+await inotify.exclude(names: ".git", "node_modules", ".build")
+
+try await inotify.addWatchWithAutomaticSubtreeWatching(
+    forDirectory: "/home/user/project",
+    mask: [.create, .modify, .delete]
+)
+```
+
+Use `isExcluded(_:)` to check whether a name is currently on the exclusion list.
+
 ## Event Masks

 `InotifyEventMask` is an `OptionSet` that mirrors the native inotify flags. You can combine them freely.
@@ -113,28 +131,30 @@ 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 spins up a Docker container running `swift:latest` on Linux and executes the full test suite inside it, so you can validate everything on the correct platform even when developing on macOS.
+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).

 Docker must be installed and running on your machine.

-## Documentation
+### Documentation

 Full API documentation is available as DocC catalogs bundled with the package. Generate them locally with:

 ```bash
-# Inotify library
-swift package generate-documentation --target Inotify
-
-# Task build tool
-swift package generate-documentation --target TaskCLI
+./task.sh generate-docs
 ```

+Then open the files in the newly created `public` folder.
 Or preview in Xcode by selecting **Product > Build Documentation**.

 ## Requirements
--- a/Sources/Inotify/DirectoryResolver.swift
+++ b/Sources/Inotify/DirectoryResolver.swift
@@ -3,42 +3,35 @@ import _NIOFileSystem
 public struct DirectoryResolver {
 	static let fileManager = FileSystem.shared

-	public static func resolve(_ paths: String...) async throws -> [FilePath] {
-		try await Self.resolve(paths)
+	public static func resolve(_ paths: String..., excluding itemNames: Set<String> = []) async throws -> [FilePath] {
+		try await Self.resolve(paths, excluding: itemNames)
 	}

-	static func resolve(_ paths: [String]) async throws -> [FilePath] {
+	static func resolve(_ paths: [String], excluding itemNames: Set<String> = []) async throws -> [FilePath] {
 		var resolved: [FilePath] = []

 		for path in paths {
-			let itemPath = FilePath(path)
-			try await Self.ensure(itemPath, is: .directory)
-
-			let allDirectoriesIncludingSelf = try await getAllSubdirectoriesAndSelf(at: itemPath)
-			resolved.append(contentsOf: allDirectoriesIncludingSelf)
+			let path = FilePath(path)
+			resolved.append(path)
+			try await withSubdirectories(at: path, recursive: true) { subdirectoryPath in
+				guard let basename = subdirectoryPath.lastComponent?.description else { return }
+				guard !itemNames.contains(basename) else { return }
+				resolved.append(subdirectoryPath)
+			}
 		}

 		return resolved
 	}

-	private static func ensure(_ path: FilePath, is fileType: FileType) async throws {
-		guard let fileInfo = try await fileManager.info(forFileAt: path) else {
-			throw DirectoryResolverError.pathNotFound(path)
-		}
-
-		guard fileInfo.type == fileType else {
-			throw DirectoryResolverError.pathIsNoDirectory(path)
-		}
-	}
-
-	private static func getAllSubdirectoriesAndSelf(at path: FilePath) async throws -> [FilePath] {
-		var result: [FilePath] = []
+	private static func withSubdirectories(at path: FilePath, recursive: Bool = false, body: (FilePath) async throws -> Void) async throws {
 		let directoryHandle = try await fileManager.openDirectory(atPath: path)
-		for try await childContent in directoryHandle.listContents(recursive: true) {
+		for try await childContent in directoryHandle.listContents() {
 			guard childContent.type == .directory else { continue }
-			result.append(childContent.path)
+			try await body(childContent.path)
+			if recursive {
+				try await withSubdirectories(at: childContent.path, recursive: recursive, body: body)
+			}
 		}
 		try await directoryHandle.close()
-		return result
 	}
 }
--- a/Sources/Inotify/Inotify.docc/Inotify.md
+++ b/Sources/Inotify/Inotify.docc/Inotify.md
@@ -20,6 +20,8 @@ Beyond single-directory watches, the library provides two higher-level methods f
 - ``Inotify/Inotify/addRecursiveWatch(forDirectory:mask:)`` installs watches on every existing subdirectory at setup time.
 - ``Inotify/Inotify/addWatchWithAutomaticSubtreeWatching(forDirectory:mask:)`` does the same **and** automatically watches subdirectories that are created after setup.

+You can also exclude certain file or directory names so that they are skipped during directory resolution and silently dropped from the event stream. See ``Inotify/Inotify/exclude(names:)`` and <doc:WatchingDirectoryTrees> for details.
+
 All public types conform to `Sendable`, so they can be safely passed across concurrency boundaries.

 ## Topics
@@ -30,6 +32,10 @@ All public types conform to `Sendable`, so they can be safely passed across conc
 - ``InotifyEvent``
 - ``InotifyEventMask``

+### Articles
+
+- <doc:WatchingDirectoryTrees>
+
 ### Errors

 - ``InotifyError``
--- a/Sources/Inotify/Inotify.docc/WatchingDirectoryTrees.md
+++ b/Sources/Inotify/Inotify.docc/WatchingDirectoryTrees.md
@@ -33,6 +33,22 @@ let descriptors = try await inotify.addWatchWithAutomaticSubtreeWatching(

 Internally this listens for `CREATE` events carrying the ``InotifyEventMask/isDir`` flag and installs a new watch with the same mask whenever a subdirectory appears.

+### Excluding Directories
+
+When watching large trees you often want to skip certain subdirectories entirely — version-control metadata, build artefacts, dependency caches, and so on. Call ``Inotify/Inotify/exclude(names:)`` **before** adding a recursive or automatic-subtree watch:
+
+```swift
+let inotify = try Inotify()
+await inotify.exclude(names: ".git", "node_modules", ".build")
+
+try await inotify.addWatchWithAutomaticSubtreeWatching(
+    forDirectory: "/home/user/project",
+    mask: .allEvents
+)
+```
+
+Excluded names are matched against the last path component of each directory during resolution and are also filtered from the event stream, so you never receive events for items whose name is on the exclusion list.
+
 ### Choosing the Right Method

 | Method | Covers existing subdirectories | Covers new subdirectories |
--- a/Sources/Inotify/Inotify.swift
+++ b/Sources/Inotify/Inotify.swift
@@ -3,6 +3,7 @@ import CInotify

 public actor Inotify {
 	private let fd: CInt
+	private var excludedItemNames: Set<String> = []
 	private var watches = InotifyWatchManager()
 	private var eventReader: any DispatchSourceRead
 	private var eventStream: AsyncStream<RawInotifyEvent>
@@ -18,6 +19,24 @@ public actor Inotify {
 		(self.eventReader, self.eventStream) = Self.createEventReader(forFileDescriptor: fd)
 	}

+	public func isExcluded(_ name: String) -> Bool {
+		self.excludedItemNames.contains(name)
+	}
+
+	public func exclude(name: String) {
+		self.excludedItemNames.insert(name)
+	}
+
+	public func exclude(names: String...) {
+		self.exclude(names: names)
+	}
+
+	public func exclude(names: [String]) {
+		for name in names {
+			self.excludedItemNames.insert(name)
+		}
+	}
+
 	@discardableResult
 	public func addWatch(path: String, mask: InotifyEventMask) throws -> CInt {
 		let wd = inotify_add_watch(self.fd, path, mask.rawValue)
@@ -30,7 +49,7 @@ public actor Inotify {

 	@discardableResult
 	public func addRecursiveWatch(forDirectory path: String, mask: InotifyEventMask) async throws -> [CInt] {
-		let directoryPaths = try await DirectoryResolver.resolve(path)
+		let directoryPaths = try await DirectoryResolver.resolve(path, excluding: self.excludedItemNames)
 		var result: [CInt] = []
 		for path in directoryPaths {
 			let wd = try self.addWatch(path: path.string, mask: mask)
@@ -59,6 +78,7 @@ public actor Inotify {

 	private func transform(_ rawEvent: RawInotifyEvent) async -> InotifyEvent? {
 		guard let path = self.watches.path(forId: rawEvent.watchDescriptor) else { return nil }
+		guard !self.excludedItemNames.contains(rawEvent.name) else { return nil }
 		let event = InotifyEvent.init(from: rawEvent, inDirectory: path)
 		await self.addWatchInCaseOfAutomaticSubtreeWatching(event)
 		return InotifyEvent.init(from: rawEvent, inDirectory: path)
--- a/Sources/TaskCLI/Command.swift
+++ b/Sources/TaskCLI/Command.swift
@@ -4,6 +4,6 @@ import ArgumentParser
 struct Command: AsyncParsableCommand {
 	static let configuration = CommandConfiguration(
 		abstract: "Project tasks of Astzweig's Swift Inotify project.",
-		subcommands: [TestCommand.self, GenerateDocsCommand.self]
+		subcommands: [TestCommand.self, GenerateDocumentationCommand.self]
 	)
 }
--- a/Sources/TaskCLI/DoccFinder.swift
+++ b/Sources/TaskCLI/DoccFinder.swift
@@ -0,0 +1,25 @@
+import _NIOFileSystem
+
+public struct DoccFinder {
+	static let fileManager = FileSystem.shared
+
+	public static func hasDoccFolder(at path: String) async throws -> Bool {
+		let itemPath = FilePath(path)
+		var hasDoccFolder = false
+
+		try await withSubdirectories(at: itemPath) { subdirectory in
+			guard subdirectory.description.hasSuffix(".docc") else { return }
+			hasDoccFolder = true
+		}
+		return hasDoccFolder
+	}
+
+	private static func withSubdirectories(at path: FilePath, body: (FilePath) async throws -> Void) async throws {
+		let directoryHandle = try await fileManager.openDirectory(atPath: path)
+		for try await childContent in directoryHandle.listContents() {
+			guard childContent.type == .directory else { continue }
+			try await body(childContent.path)
+		}
+		try await directoryHandle.close()
+	}
+}
--- a/Sources/TaskCLI/GenerateDocumentation
+++ b/Sources/TaskCLI/GenerateDocumentation
@@ -5,10 +5,10 @@ import Logging
 import Noora
 import Subprocess

-struct GenerateDocsCommand: AsyncParsableCommand {
+struct GenerateDocumentationCommand: AsyncParsableCommand {
 	static let configuration = CommandConfiguration(
-		commandName: "generate-docs",
-		abstract: "Generate DocC documentation inside a Linux container.",
+		commandName: "generate-documentation",
+		abstract: "Generate DocC documentation of all targets inside a Linux container.",
 		aliases: ["gd"],
 	)

@@ -16,20 +16,20 @@ struct GenerateDocsCommand: AsyncParsableCommand {

 	private static let doccPluginURL = "https://github.com/apple/swift-docc-plugin.git"
 	private static let doccPluginMinVersion = "1.4.0"
-	private static let targets = ["Inotify", "TaskCLI"]
-	private static let hostingBasePath = "swift-inotify"
 	private static let skipItems: Set<String> = [".git", ".build", ".swiftpm", "public"]

 	// MARK: - Run

 	func run() async throws {
 		let noora = Noora()
-		let logger = global.makeLogger(labeled: "swift-inotify.cli.task.generate-docs")
+		let logger = global.makeLogger(labeled: "swift-inotify.cli.task.generate-documentation")
 		let fileManager = FileManager.default
 		let projectDirectory = URL(fileURLWithPath: fileManager.currentDirectoryPath)

+		let targets = try await Self.targets(for: projectDirectory)
+
 		noora.info("Generating DocC documentation on Linux.")
-		logger.debug("Current directory", metadata: ["current-directory": "\(projectDirectory.path(percentEncoded: false))"])
+		logger.debug("Current directory", metadata: ["current-directory": "\(projectDirectory.path(percentEncoded: false))", "targets": "\(targets.joined(separator: ", "))"])

 		let tempDirectory = try copyProject(from: projectDirectory)
 		logger.info("Copied project to temporary directory.", metadata: ["path": "\(tempDirectory.path(percentEncoded: false))"])
@@ -40,7 +40,7 @@ struct GenerateDocsCommand: AsyncParsableCommand {
 		}

 		try await injectDoccPluginDependency(in: tempDirectory, logger: logger)
-		let script = Self.makeRunScript()
+		let script = Self.makeRunScript(for: targets)

 		logger.debug("Container script", metadata: ["script": "\(script)"])
 		let dockerResult = try await Subprocess.run(
@@ -70,45 +70,79 @@ struct GenerateDocsCommand: AsyncParsableCommand {
 		}

 		try copyResults(from: tempDirectory, to: projectDirectory)
+		try Self.generateIndexHTML(
+			templateURL: projectDirectory.appending(path: ".github/workflows/index.tpl.html"),
+			outputURL: projectDirectory.appending(path: "public/index.html")
+		)

 		noora.success(
 			.alert("Documentation generated successfully.",
-				takeaways: Self.targets.map {
-					"./public/\($0.lowercased())/"
-				}
+				takeaways: ["Start a local web server with ./public as document root, i.e. with python3 -m http.server to browse the documentation."]
 			)
 		)
 	}
 	
-	private static func generateDocsCommand() -> String {
-		Self.targets.map {
-			"swift package generate-documentation --target \($0)"
-		}.joined(separator: " && ")
-	}
-	
-	private static func transformDocsForStaticHostingCommand() -> String {
-		Self.targets.map { target in
-			let lowercased = target.lowercased()
-			return "docc process-archive transform-for-static-hosting" +
-				" $OUTPUTS/\(target).doccarchive" +
-				" --output-path ./public/\(lowercased)" +
-				" --hosting-base-path \(Self.hostingBasePath)/\(lowercased)"
-		}.joined(separator: " && ")
-	}
-	
-	private static func outputPathsForDocTargets() -> String {
-		Self.targets.map { "./public/\($0.lowercased())" }.joined(separator: " ")
-	}
-	
-	private static func makeRunScript() -> String {
-		let generateDocs = Self.generateDocsCommand()
-		let transformDocs = Self.transformDocsForStaticHostingCommand()
-		let outputDirs = Self.outputPathsForDocTargets()
+	private static func generateIndexHTML(templateURL: URL, outputURL: URL) throws {
+		var content = try String(contentsOf: templateURL, encoding: .utf8)

-		return "set -euo pipefail && \(generateDocs)" +
-		" && OUTPUTS=.build/plugins/Swift-DocC/outputs" +
-		" && mkdir -p \(outputDirs)" +
-		" && \(transformDocs)"
+		let replacements: [(String, String)] = [
+			("{{project.name}}", "Swift Inotify"),
+			("{{project.tagline}}", "🗂️ Monitor filesystem events on Linux using modern Swift concurrency"),
+			("{{project.links}}", """
+				<li><a href="inotify/documentation/inotify/">Inotify</a>: The actual library.</li>\
+				<li><a href="inotifytaskcli/documentation/inotifytaskcli/">TaskCLI</a>: The project build command.</li>
+				"""),
+		]
+
+		for (placeholder, value) in replacements {
+			content = content.replacingOccurrences(of: placeholder, with: value)
+		}
+
+		try FileManager.default.createDirectory(
+			at: outputURL.deletingLastPathComponent(),
+			withIntermediateDirectories: true
+		)
+		try content.write(to: outputURL, atomically: true, encoding: .utf8)
+	}
+
+	private static func targets(for projectDirectory: URL) async throws -> [String] {
+		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 {
+		targets.map {
+			"mkdir -p \"./public/\($0.localizedLowercase)\" && " +
+			"swift package --allow-writing-to-directory \"\($0.localizedLowercase)\" " +
+			"generate-documentation --disable-indexing --transform-for-static-hosting " +
+			"--target \"\($0)\" " +
+			"--hosting-base-path \"\($0.localizedLowercase)\" " +
+			"--output-path \"./public/\($0.localizedLowercase)\""
+		}.joined(separator: " && ")
 	}

 	// MARK: - Project Copy
@@ -141,32 +175,23 @@ struct GenerateDocsCommand: AsyncParsableCommand {
 	// MARK: - Dependency Injection

 	private func injectDoccPluginDependency(in directory: URL, logger: Logger) async throws {
-		let packageSwiftURL = directory.appending(path: "Package.swift")
-		let contents = try String(contentsOf: packageSwiftURL, encoding: .utf8)
-
-		guard !contents.contains("swift-docc-plugin") else {
-			logger.info("swift-docc-plugin dependency already present.")
-			return
-		}
-
 		let result = try await Subprocess.run(
 			.name("swift"),
 			arguments: [
 				"package", "--package-path", directory.path(percentEncoded: false),
-				"add-dependency", Self.doccPluginURL,
-				"--from", Self.doccPluginMinVersion,
+				"add-dependency", "--from", Self.doccPluginMinVersion, Self.doccPluginURL
 			],
 		) { _ in }

 		guard result.terminationStatus.isSuccess else {
-			throw GenerateDocsError.dependencyInjectionFailed
+			throw GenerateDocumentationError.dependencyInjectionFailed
 		}

 		logger.info("Injected swift-docc-plugin dependency.")
 	}
 }

-enum GenerateDocsError: Error, CustomStringConvertible {
+enum GenerateDocumentationError: Error, CustomStringConvertible {
 	case dependencyInjectionFailed

 	var description: String {
--- 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-docs
+./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.
@@ -50,7 +54,7 @@ Docker must be installed and running on the host machine. The container uses the

 - ``Command``
 - ``TestCommand``
- ``GenerateDocsCommand``
+- ``GenerateDocumentationCommand``

 ### Configuration

@@ -58,4 +62,4 @@ Docker must be installed and running on the host machine. The container uses the

 ### Errors

- ``GenerateDocsError``
+- ``GenerateDocumentationError``
--- a/Tests/InotifyIntegrationTests/DirectoryResolverTests.swift
+++ b/Tests/InotifyIntegrationTests/DirectoryResolverTests.swift
@@ -0,0 +1,17 @@
+import Foundation
+import Testing
+@testable import Inotify
+
+@Suite("Directory Resolver")
+struct DirectoryResolverTests {
+	@Test func listsDirectoryTree() async throws {
+		try await withTempDir { dir in
+			let subDirectory = "\(dir)/Subfolder/Folder 01"
+			try FileManager.default.createDirectory(atPath: subDirectory, withIntermediateDirectories: true)
+			let directories = try await DirectoryResolver.resolve(dir)
+
+			#expect(directories.count == 3)
+			#expect(directories.map { $0.description } == [dir, "\(dir)/Subfolder", subDirectory])
+		}
+	}
+}
--- a/Tests/InotifyIntegrationTests/RecursiveEventTests.swift
+++ b/Tests/InotifyIntegrationTests/RecursiveEventTests.swift
@@ -21,6 +21,24 @@ struct RecursiveEventTests {
 		}
 	}

+	@Test func ignoresFileCreationInIgnoredSubfolder() async throws {
+		try await withTempDir { dir in
+			let subDirectory = "\(dir)/Subfolder"
+			let filepath = "\(subDirectory)/modify-target.txt"
+			try FileManager.default.createDirectory(atPath: subDirectory, withIntermediateDirectories: true)
+
+			let events = try await getEventsForTrigger(
+				in: dir,
+				mask: [.create],
+				recursive: .recursive,
+				exclude: ["Subfolder"]
+			) { _ in try createFile(at: "\(filepath)", contents: "hello") }
+
+			let createEvent = events.first { $0.mask.contains(.create) && $0.path.string == filepath }
+			#expect(createEvent == nil, "Did not expect CREATE for '\(filepath)', got: \(events)")
+		}
+	}
+
 	@Test func newSubfoldersOfRecursiveWatchAreAutomaticallyWatchedToo() async throws {
 		try await withTempDir { dir in
 			let subDirectory = "\(dir)/Subfolder"
@@ -32,7 +50,7 @@ struct RecursiveEventTests {
 				recursive: .withAutomaticSubtreeWatching
 			) { _ in
 				try FileManager.default.createDirectory(atPath: subDirectory, withIntermediateDirectories: true)
-				try await Task.sleep(for: .milliseconds(200))
+				try await Task.sleep(for: .milliseconds(400))
 				try createFile(at: "\(filepath)", contents: "hello")
 			}

--- a/Tests/InotifyIntegrationTests/Utilities/getEventsForTrigger.swift
+++ b/Tests/InotifyIntegrationTests/Utilities/getEventsForTrigger.swift
@@ -10,9 +10,11 @@ func getEventsForTrigger(
 	in dir: String,
 	mask: InotifyEventMask,
 	recursive: RecursivKind = .nonrecursive,
+	exclude: [String] = [],
 	trigger: @escaping (String) async throws -> Void,
 ) async throws -> [InotifyEvent] {
 	let watcher = try Inotify()
+	await watcher.exclude(names: exclude)
 	switch recursive {
 	case .nonrecursive:
 		try await watcher.addWatch(path: dir, mask: mask)
--- a/task.sh
+++ 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 "<PackageName>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 "$@"
Author	SHA1	Message	Date
T. R. Bernstein	55f3ca2f7b	Temporary fix of SwiftPM Bug using task.sh Some checks failed Docs / docs (push) Has been cancelled Details Docs / deploy (push) Has been cancelled Details 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	2026-03-20 21:10:01 +01:00
T. R. Bernstein	134e4e152d	Implement watch exclusion lists Some checks failed Docs / docs (push) Has been cancelled Details Docs / deploy (push) Has been cancelled Details Allow exclusion of directories when watching recursively.	2026-03-15 22:46:59 +01:00
T. R. Bernstein	c87099e4a7	Add SwiftPackageIndex configuration file	2026-03-15 22:46:59 +01:00
T. R. Bernstein	914bbe3153	Add GitHub workflow file to generate docs	2026-03-15 22:46:59 +01:00
T. R. Bernstein	a30e954737	Update README section about docs generation Show how to generate the Docc docs using task CLI instead of faning out to swift package docc plugin.	2026-03-15 22:46:59 +01:00
T. R. Bernstein	e2bfb8280b	Add generate-docs command to build task The Swift Docc has to run in a Linux container to be able to build the documentation, as it needs access to the inotify.h header files.	2026-03-15 22:46:59 +01:00
T. R. Bernstein	e78e2c082d	Add open source documentation files	2026-03-15 22:46:55 +01:00