Add GitHub workflow file to generate docs

Add SwiftPackageIndex configuration file
Add open source documentation files
2026-03-12 16:07:50 +01:00 · 2026-03-12 16:07:30 +01:00 · 2026-03-12 15:31:10 +01:00 · 2026-03-12 14:52:33 +01:00 · 2026-03-12 12:04:08 +01:00 · 2026-03-12 11:32:29 +01:00
27 changed files with 1295 additions and 30 deletions
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,83 @@
 name: Docs
 on:
  push:
    branches:
    - main
  workflow_dispatch:
 permissions:
  contents: read
  pages: write
  id-token: write
 concurrency:
  group: "pages"
  cancel-in-progress: true
 jobs:
  docs:
    runs-on: macos-latest
    steps:
    - uses: actions/checkout@v6
    - name: Set up Pages
      uses: actions/configure-pages@v5
    - name: Set up Swift
      uses: swift-actions/setup-swift@v3
      with:
        swift-version: '6.1'
    - 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
    - name: Generate Inotify Docs
      uses: fwcd/swift-docc-action@v1
      with:
        target: Inotify
        output: ./public/inotify
        transform-for-static-hosting: 'true'
        disable-indexing: 'true'
        hosting-base-path: swift-inotify/inotify
    - name: Generate TaskCLI Docs
      uses: fwcd/swift-docc-action@v1
      with:
        target: TaskCLI
        output: ./public/taskcli
        transform-for-static-hosting: 'true'
        disable-indexing: 'true'
        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
    - name: Upload artifact
      uses: actions/upload-pages-artifact@v4
      with:
        path: ./public
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: docs
    steps:
    - name: Deploy Docs
      uses: actions/deploy-pages@v4
--- a/.spi.yml
+++ b/.spi.yml
@@ -0,0 +1,4 @@
 version: 1
 builder:
  configs:
    - documentation_targets: [Inotify, TaskCLI]
--- a/287
+++ b/287
@@ -0,0 +1,287 @@
 					  EUROPEAN UNION PUBLIC LICENCE v. 1.2
 					  EUPL © the European Union 2007, 2016
 This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined
 below) which is provided under the terms of this Licence. Any use of the Work,
 other than as authorised under this Licence is prohibited (to the extent such
 use is covered by a right of the copyright holder of the Work).
 The Work is provided under the terms of this Licence when the Licensor (as
 defined below) has placed the following notice immediately following the
 copyright notice for the Work:
 		Licensed under the EUPL
 or has expressed by any other means his willingness to license under the EUPL.
 1. Definitions
 In this Licence, the following terms have the following meaning:
 - ‘The Licence’: this Licence.
 - ‘The Original Work’: the work or software distributed or communicated by the
  Licensor under this Licence, available as Source Code and also as Executable
  Code as the case may be.
 - ‘Derivative Works’: the works or software that could be created by the
  Licensee, based upon the Original Work or modifications thereof. This Licence
  does not define the extent of modification or dependence on the Original Work
  required in order to classify a work as a Derivative Work; this extent is
  determined by copyright law applicable in the country mentioned in Article 15.
 - ‘The Work’: the Original Work or its Derivative Works.
 - ‘The Source Code’: the human-readable form of the Work which is the most
  convenient for people to study and modify.
 - ‘The Executable Code’: any code which has generally been compiled and which is
  meant to be interpreted by a computer as a program.
 - ‘The Licensor’: the natural or legal person that distributes or communicates
  the Work under the Licence.
 - ‘Contributor(s)’: any natural or legal person who modifies the Work under the
  Licence, or otherwise contributes to the creation of a Derivative Work.
 - ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
  the Work under the terms of the Licence.
 - ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
  renting, distributing, communicating, transmitting, or otherwise making
  available, online or offline, copies of the Work or providing access to its
  essential functionalities at the disposal of any other natural or legal
  person.
 2. Scope of the rights granted by the Licence
 The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
 sublicensable licence to do the following, for the duration of copyright vested
 in the Original Work:
 - use the Work in any circumstance and for all usage,
 - reproduce the Work,
 - modify the Work, and make Derivative Works based upon the Work,
 - communicate to the public, including the right to make available or display
  the Work or copies thereof to the public and perform publicly, as the case may
  be, the Work,
 - distribute the Work or copies thereof,
 - lend and rent the Work or copies thereof,
 - sublicense rights in the Work or copies thereof.
 Those rights can be exercised on any media, supports and formats, whether now
 known or later invented, as far as the applicable law permits so.
 In the countries where moral rights apply, the Licensor waives his right to
 exercise his moral right to the extent allowed by law in order to make effective
 the licence of the economic rights here above listed.
 The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to
 any patents held by the Licensor, to the extent necessary to make use of the
 rights granted on the Work under this Licence.
 3. Communication of the Source Code
 The Licensor may provide the Work either in its Source Code form, or as
 Executable Code. If the Work is provided as Executable Code, the Licensor
 provides in addition a machine-readable copy of the Source Code of the Work
 along with each copy of the Work that the Licensor distributes or indicates, in
 a notice following the copyright notice attached to the Work, a repository where
 the Source Code is easily and freely accessible for as long as the Licensor
 continues to distribute or communicate the Work.
 4. Limitations on copyright
 Nothing in this Licence is intended to deprive the Licensee of the benefits from
 any exception or limitation to the exclusive rights of the rights owners in the
 Work, of the exhaustion of those rights or of other applicable limitations
 thereto.
 5. Obligations of the Licensee
 The grant of the rights mentioned above is subject to some restrictions and
 obligations imposed on the Licensee. Those obligations are the following:
 Attribution right: The Licensee shall keep intact all copyright, patent or
 trademarks notices and all notices that refer to the Licence and to the
 disclaimer of warranties. The Licensee must include a copy of such notices and a
 copy of the Licence with every copy of the Work he/she distributes or
 communicates. The Licensee must cause any Derivative Work to carry prominent
 notices stating that the Work has been modified and the date of modification.
 Copyleft clause: If the Licensee distributes or communicates copies of the
 Original Works or Derivative Works, this Distribution or Communication will be
 done under the terms of this Licence or of a later version of this Licence
 unless the Original Work is expressly distributed only under this version of the
 Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
 (becoming Licensor) cannot offer or impose any additional terms or conditions on
 the Work or Derivative Work that alter or restrict the terms of the Licence.
 Compatibility clause: If the Licensee Distributes or Communicates Derivative
 Works or copies thereof based upon both the Work and another work licensed under
 a Compatible Licence, this Distribution or Communication can be done under the
 terms of this Compatible Licence. For the sake of this clause, ‘Compatible
 Licence’ refers to the licences listed in the appendix attached to this Licence.
 Should the Licensee's obligations under the Compatible Licence conflict with
 his/her obligations under this Licence, the obligations of the Compatible
 Licence shall prevail.
 Provision of Source Code: When distributing or communicating copies of the Work,
 the Licensee will provide a machine-readable copy of the Source Code or indicate
 a repository where this Source will be easily and freely available for as long
 as the Licensee continues to distribute or communicate the Work.
 Legal Protection: This Licence does not grant permission to use the trade names,
 trademarks, service marks, or names of the Licensor, except as required for
 reasonable and customary use in describing the origin of the Work and
 reproducing the content of the copyright notice.
 6. Chain of Authorship
 The original Licensor warrants that the copyright in the Original Work granted
 hereunder is owned by him/her or licensed to him/her and that he/she has the
 power and authority to grant the Licence.
 Each Contributor warrants that the copyright in the modifications he/she brings
 to the Work are owned by him/her or licensed to him/her and that he/she has the
 power and authority to grant the Licence.
 Each time You accept the Licence, the original Licensor and subsequent
 Contributors grant You a licence to their contributions to the Work, under the
 terms of this Licence.
 7. Disclaimer of Warranty
 The Work is a work in progress, which is continuously improved by numerous
 Contributors. It is not a finished work and may therefore contain defects or
 ‘bugs’ inherent to this type of development.
 For the above reason, the Work is provided under the Licence on an ‘as is’ basis
 and without warranties of any kind concerning the Work, including without
 limitation merchantability, fitness for a particular purpose, absence of defects
 or errors, accuracy, non-infringement of intellectual property rights other than
 copyright as stated in Article 6 of this Licence.
 This disclaimer of warranty is an essential part of the Licence and a condition
 for the grant of any rights to the Work.
 8. Disclaimer of Liability
 Except in the cases of wilful misconduct or damages directly caused to natural
 persons, the Licensor will in no event be liable for any direct or indirect,
 material or moral, damages of any kind, arising out of the Licence or of the use
 of the Work, including without limitation, damages for loss of goodwill, work
 stoppage, computer failure or malfunction, loss of data or any commercial
 damage, even if the Licensor has been advised of the possibility of such damage.
 However, the Licensor will be liable under statutory product liability laws as
 far such laws apply to the Work.
 9. Additional agreements
 While distributing the Work, You may choose to conclude an additional agreement,
 defining obligations or services consistent with this Licence. However, if
 accepting obligations, You may act only on your own behalf and on your sole
 responsibility, not on behalf of the original Licensor or any other Contributor,
 and only if You agree to indemnify, defend, and hold each Contributor harmless
 for any liability incurred by, or claims asserted against such Contributor by
 the fact You have accepted any warranty or additional liability.
 10. Acceptance of the Licence
 The provisions of this Licence can be accepted by clicking on an icon ‘I agree’
 placed under the bottom of a window displaying the text of this Licence or by
 affirming consent in any other similar way, in accordance with the rules of
 applicable law. Clicking on that icon indicates your clear and irrevocable
 acceptance of this Licence and all of its terms and conditions.
 Similarly, you irrevocably accept this Licence and all of its terms and
 conditions by exercising any rights granted to You by Article 2 of this Licence,
 such as the use of the Work, the creation by You of a Derivative Work or the
 Distribution or Communication by You of the Work or copies thereof.
 11. Information to the public
 In case of any Distribution or Communication of the Work by means of electronic
 communication by You (for example, by offering to download the Work from a
 remote location) the distribution channel or media (for example, a website) must
 at least provide to the public the information requested by the applicable law
 regarding the Licensor, the Licence and the way it may be accessible, concluded,
 stored and reproduced by the Licensee.
 12. Termination of the Licence
 The Licence and the rights granted hereunder will terminate automatically upon
 any breach by the Licensee of the terms of the Licence.
 Such a termination will not terminate the licences of any person who has
 received the Work from the Licensee under the Licence, provided such persons
 remain in full compliance with the Licence.
 13. Miscellaneous
 Without prejudice of Article 9 above, the Licence represents the complete
 agreement between the Parties as to the Work.
 If any provision of the Licence is invalid or unenforceable under applicable
 law, this will not affect the validity or enforceability of the Licence as a
 whole. Such provision will be construed or reformed so as necessary to make it
 valid and enforceable.
 The European Commission may publish other linguistic versions or new versions of
 this Licence or updated versions of the Appendix, so far this is required and
 reasonable, without reducing the scope of the rights granted by the Licence. New
 versions of the Licence will be published with a unique version number.
 All linguistic versions of this Licence, approved by the European Commission,
 have identical value. Parties can take advantage of the linguistic version of
 their choice.
 14. Jurisdiction
 Without prejudice to specific agreement between parties,
 - any litigation resulting from the interpretation of this License, arising
  between the European Union institutions, bodies, offices or agencies, as a
  Licensor, and any Licensee, will be subject to the jurisdiction of the Court
  of Justice of the European Union, as laid down in article 272 of the Treaty on
  the Functioning of the European Union,
 - any litigation arising between other parties and resulting from the
  interpretation of this License, will be subject to the exclusive jurisdiction
  of the competent court where the Licensor resides or conducts its primary
  business.
 15. Applicable Law
 Without prejudice to specific agreement between parties,
 - this Licence shall be governed by the law of the European Union Member State
  where the Licensor has his seat, resides or has his registered office,
 - this licence shall be governed by Belgian law if the Licensor has no seat,
  residence or registered office inside a European Union Member State.
 Appendix
 ‘Compatible Licences’ according to Article 5 EUPL are:
 - GNU General Public License (GPL) v. 2, v. 3
 - GNU Affero General Public License (AGPL) v. 3
 - Open Software License (OSL) v. 2.1, v. 3.0
 - Eclipse Public License (EPL) v. 1.0
 - CeCILL v. 2.0, v. 2.1
 - Mozilla Public Licence (MPL) v. 2
 - GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
 - Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
  works other than software
 - European Union Public Licence (EUPL) v. 1.1, v. 1.2
 - Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong
  Reciprocity (LiLiQ-R+).
 The European Commission may update this Appendix to later versions of the above
 licences without producing a new version of the EUPL, as long as they provide
 the rights granted in Article 2 of this Licence and protect the covered Source
 Code from exclusive appropriation.
 All other changes or additions to this Appendix require the production of a new
 EUPL version.
--- a/Package.resolved
+++ b/Package.resolved
@@ -1,5 +1,5 @@
 {
-  "originHash" : "db0ba74c125e968c67646390cbba012a5572a5c9c54171588ecbb73e370a448d",
+  "originHash" : "fd1e824e418c767633bb79b055a4e84d9c86165746bc881d5d27457ad34b0c20",
  "pins" : [
    {
      "identity" : "noora",
@@ -46,6 +46,15 @@
        "version" : "1.1.3"
      }
    },
    {
      "identity" : "swift-atomics",
      "kind" : "remoteSourceControl",
      "location" : "https://github.com/apple/swift-atomics.git",
      "state" : {
        "revision" : "b601256eab081c0f92f059e12818ac1d4f178ff7",
        "version" : "1.3.0"
      }
    },
    {
      "identity" : "swift-collections",
      "kind" : "remoteSourceControl",
@@ -64,6 +73,15 @@
        "version" : "1.10.1"
      }
    },
    {
      "identity" : "swift-nio",
      "kind" : "remoteSourceControl",
      "location" : "https://github.com/apple/swift-nio",
      "state" : {
        "revision" : "e932d3c4d8f77433c8f7093b5ebcbf91463948a0",
        "version" : "2.95.0"
      }
    },
    {
      "identity" : "swift-subprocess",
      "kind" : "remoteSourceControl",
--- a/Package.swift
+++ b/Package.swift
@@ -18,6 +18,8 @@ let package = Package(
 		.package(url: "https://github.com/apple/swift-argument-parser", from: "1.7.0"),
 		.package(url: "https://github.com/apple/swift-async-algorithms", from: "1.1.3"),
 		.package(url: "https://github.com/apple/swift-log", from: "1.10.1"),
 		.package(url: "https://github.com/apple/swift-nio", from: "2.95.0"),
 		.package(url: "https://github.com/apple/swift-system", from: "1.6.4"),
 		.package(url: "https://github.com/swiftlang/swift-subprocess.git", from: "0.3.0"),
 		.package(url: "https://github.com/tuist/Noora", from: "0.55.1")
 	],
@@ -28,11 +30,16 @@ let package = Package(
 			dependencies: [
 				"CInotify",
 				.product(name: "Logging", package: "swift-log"),
 				.product(name: "_NIOFileSystem", package: "swift-nio"),
 				.product(name: "SystemPackage", package: "swift-system")
 			]
 		),
 		.testTarget(
 			name: "InotifyIntegrationTests",
-			dependencies: ["Inotify"],
+			dependencies: [
 				"Inotify",
 				.product(name: "SystemPackage", package: "swift-system")
 			],
 		),
 		.executableTarget(
 			name: "TaskCLI",
--- a/README.md
+++ b/README.md
@@ -0,0 +1,148 @@
 # Inotify
 A Swift wrapper around the Linux [inotify](https://man7.org/linux/man-pages/man7/inotify.7.html) API, built on modern Swift concurrency. It lets you watch individual files or directories for filesystem events, recursively monitor entire subtrees, and optionally have newly created subdirectories watched automatically.
 Events are delivered as an `AsyncSequence`, so you can consume them with a simple `for await` loop.
 ## Adding Inotify to Your Project
 Add the package dependency in your `Package.swift`:
 ```swift
 dependencies: [
    .package(url: "https://github.com/astzweig/swift-inotify.git", from: "1.0.0")
 ]
 ```
 Then add `Inotify` to your target's dependencies:
 ```swift
 .target(
    ...
    dependencies: [
        .product(name: "Inotify", package: "swift-inotify")
    ]
    ...
 )
 ```
 ## Quick Start
 ```swift
 import Inotify
 let inotify = try Inotify()
 // Watch a single file for modifications
 try inotify.addWatch(path: "/tmp/some-existing-file.txt", mask: [.modify])
 // Watch a single directory for file creations and modifications
 try inotify.addWatch(path: "/tmp/watched", mask: [.create, .modify])
 // Consume events as they arrive
 for await event in await inotify.events {
    print("Event at \(event.path): \(event.mask)")
 }
 ```
 ## Watching Subtrees
 Inotify operates on individual watch descriptors, so monitoring a directory does not automatically cover its children. This library provides two convenience methods that handle the recursion for you.
 ### Recursive Watch
 `addRecursiveWatch` walks the directory tree at setup time and installs a watch on every existing subdirectory:
 ```swift
 try await inotify.addRecursiveWatch(
    forDirectory: "/home/user/project",
    mask: [.create, .modify, .delete]
 )
 ```
 Subdirectories created after the call are **not** watched.
 ### Automatic Subtree Watching
 `addWatchWithAutomaticSubtreeWatching` does everything `addRecursiveWatch` does, and additionally listens for `CREATE` events with the `isDir` flag. Whenever a new subdirectory appears, a watch is installed on it automatically:
 ```swift
 try await inotify.addWatchWithAutomaticSubtreeWatching(
    forDirectory: "/home/user/project",
    mask: [.create, .modify, .delete]
 )
 ```
 This is the most convenient option when you need full coverage of a growing directory tree.
 ## Event Masks
 `InotifyEventMask` is an `OptionSet` that mirrors the native inotify flags. You can combine them freely.
 | Mask | Description |
 |------|-------------|
 | `.access` | File was read |
 | `.attrib` | Metadata changed (permissions, timestamps, ...) |
 | `.closeWrite` | File opened for writing was closed |
 | `.closeNoWrite` | File **not** opened for writing was closed |
 | `.create` | File or directory created in watched directory |
 | `.delete` | File or directory deleted in watched directory |
 | `.deleteSelf` | Watched item itself was deleted |
 | `.modify` | File was written to |
 | `.moveSelf` | Watched item itself was moved |
 | `.movedFrom` | File moved **out** of watched directory |
 | `.movedTo` | File moved **into** watched directory |
 | `.open` | File was opened |
 Convenience combinations: `.move` (`.movedFrom` + `.movedTo`), `.close` (`.closeWrite` + `.closeNoWrite`), `.allEvents`.
 Watch flags: `.dontFollow`, `.onlyDir`, `.oneShot`.
 Kernel-only flags returned in events: `.isDir`, `.ignored`, `.queueOverflow`, `.unmount`.
 ## Removing a Watch
 Every `addWatch` variant returns one or more watch descriptors that you can use to remove the watch later:
 ```swift
 let wd = try inotify.addWatch(path: "/tmp/watched", mask: .create)
 // ... later
 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.
 ```bash
 swift run task 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
 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
 ```
 Or preview in Xcode by selecting **Product > Build Documentation**.
 ## Requirements
 - Swift 6.0+
 - Linux (inotify is a Linux-only API)
 - Docker (for running the test suite via `swift run task test`)
 ## License
 See [LICENSE](LICENSE) for details.
--- a/Sources/CInotify/cinotify.h
+++ b/Sources/CInotify/cinotify.h
@@ -3,6 +3,7 @@
 #include <stdlib.h>
 #include <sys/inotify.h>
 #include <unistd.h>
 #include <errno.h>
 static inline int cinotify_deinit(int fd) {
--- a/Sources/Inotify/DirectoryResolver.swift
+++ b/Sources/Inotify/DirectoryResolver.swift
@@ -0,0 +1,44 @@
 import _NIOFileSystem
 public struct DirectoryResolver {
 	static let fileManager = FileSystem.shared
 	public static func resolve(_ paths: String...) async throws -> [FilePath] {
 		try await Self.resolve(paths)
 	}
 	static func resolve(_ paths: [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)
 		}
 		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] = []
 		let directoryHandle = try await fileManager.openDirectory(atPath: path)
 		for try await childContent in directoryHandle.listContents(recursive: true) {
 			guard childContent.type == .directory else { continue }
 			result.append(childContent.path)
 		}
 		try await directoryHandle.close()
 		return result
 	}
 }
--- a/Sources/Inotify/DirectoryResolverErrror.swift
+++ b/Sources/Inotify/DirectoryResolverErrror.swift
@@ -0,0 +1,16 @@
 import Foundation
 import SystemPackage
 public enum DirectoryResolverError: LocalizedError, Equatable {
 	case pathNotFound(FilePath)
 	case pathIsNoDirectory(FilePath)
 	var errorDescription: String {
 		switch self {
 		case .pathNotFound(let path):
 			return "Path not found: \(path)"
 		case .pathIsNoDirectory(let path):
 			return "Path is not a directory: \(path)"
 		}
 	}
 }
--- a/Sources/Inotify/Inotify.docc/Inotify.md
+++ b/Sources/Inotify/Inotify.docc/Inotify.md
@@ -0,0 +1,40 @@
 # ``Inotify``
 Monitor filesystem events on Linux using modern Swift concurrency.
 ## Overview
 The Inotify library wraps the Linux [inotify](https://man7.org/linux/man-pages/man7/inotify.7.html) API in a Swift-native interface built around actors and async sequences. You create an ``Inotify/Inotify`` actor, add watches for the paths you care about, and iterate over the ``Inotify/Inotify/events`` property to receive ``InotifyEvent`` values as they occur.
 ```swift
 let inotify = try Inotify()
 try inotify.addWatch(path: "/tmp/inbox", mask: [.create, .modify])
 for await event in await inotify.events {
    print("\(event.mask) at \(event.path)")
 }
 ```
 Beyond single-directory watches, the library provides two higher-level methods for monitoring entire directory trees:
 - ``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.
 All public types conform to `Sendable`, so they can be safely passed across concurrency boundaries.
 ## Topics
 ### Essentials
 - ``Inotify/Inotify``
 - ``InotifyEvent``
 - ``InotifyEventMask``
 ### Errors
 - ``InotifyError``
 - ``DirectoryResolverError``
 ### Low-Level Types
 - ``RawInotifyEvent``
--- a/Sources/Inotify/Inotify.docc/WatchingDirectoryTrees.md
+++ b/Sources/Inotify/Inotify.docc/WatchingDirectoryTrees.md
@@ -0,0 +1,42 @@
 # Watching Directory Trees
 Monitor an entire directory hierarchy for filesystem events.
 ## Overview
 The Linux inotify API watches individual directories — it does not descend into subdirectories automatically. The ``Inotify/Inotify`` actor offers two convenience methods that handle the recursion for you.
 ### Recursive Watch
 Call ``Inotify/Inotify/addRecursiveWatch(forDirectory:mask:)`` to walk the directory tree once and install a watch on every subdirectory that exists at the time of the call:
 ```swift
 let inotify = try Inotify()
 let descriptors = try await inotify.addRecursiveWatch(
    forDirectory: "/home/user/project",
    mask: [.create, .modify, .delete]
 )
 ```
 The returned array contains one watch descriptor per directory. Subdirectories created **after** this call are not covered.
 ### Automatic Subtree Watching
 When you also want future subdirectories to be picked up, use ``Inotify/Inotify/addWatchWithAutomaticSubtreeWatching(forDirectory:mask:)`` instead:
 ```swift
 let descriptors = try await inotify.addWatchWithAutomaticSubtreeWatching(
    forDirectory: "/home/user/project",
    mask: [.create, .modify, .delete]
 )
 ```
 Internally this listens for `CREATE` events carrying the ``InotifyEventMask/isDir`` flag and installs a new watch with the same mask whenever a subdirectory appears.
 ### Choosing the Right Method
 | Method | Covers existing subdirectories | Covers new subdirectories |
 |--------|:----:|:----:|
 | ``Inotify/Inotify/addWatch(path:mask:)`` | No | No |
 | ``Inotify/Inotify/addRecursiveWatch(forDirectory:mask:)`` | Yes | No |
 | ``Inotify/Inotify/addWatchWithAutomaticSubtreeWatching(forDirectory:mask:)`` | Yes | Yes |
--- a/Sources/Inotify/Inotify.swift
+++ b/Sources/Inotify/Inotify.swift
@@ -1,34 +1,101 @@
 import Dispatch
 import CInotify
 public actor Inotify {
-	private let fd: Int32
+	private let fd: CInt
-	private var watches: [Int32: String] = [:]
+	private var watches = InotifyWatchManager()
 	private var eventReader: any DispatchSourceRead
 	private var eventStream: AsyncStream<RawInotifyEvent>
 	public var events: AsyncCompactMapSequence<AsyncStream<RawInotifyEvent>, InotifyEvent> {
 		self.eventStream.compactMap(self.transform(_:))
 	}
 	public init() throws {
-		self.fd = inotify_init1(Int32(IN_NONBLOCK | IN_CLOEXEC))
+		self.fd = inotify_init1(CInt(IN_NONBLOCK | IN_CLOEXEC))
 		guard self.fd >= 0 else {
 			throw InotifyError.initFailed(errno: cinotify_get_errno())
 		}
 		(self.eventReader, self.eventStream) = Self.createEventReader(forFileDescriptor: fd)
 	}
 	@discardableResult
-	public func addWatch(path: String, mask: InotifyEventMask) throws -> Int32 {
+	public func addWatch(path: String, mask: InotifyEventMask) throws -> CInt {
 		let wd = inotify_add_watch(self.fd, path, mask.rawValue)
 		guard wd >= 0 else {
 			throw InotifyError.addWatchFailed(path: path, errno: cinotify_get_errno())
 		}
-		watches[wd] = path
+		watches.add(path, withId: wd, mask: mask)
 		return wd
 	}
-	public func removeWatch(_ wd: Int32) throws {
+	@discardableResult
 	public func addRecursiveWatch(forDirectory path: String, mask: InotifyEventMask) async throws -> [CInt] {
 		let directoryPaths = try await DirectoryResolver.resolve(path)
 		var result: [CInt] = []
 		for path in directoryPaths {
 			let wd = try self.addWatch(path: path.string, mask: mask)
 			result.append(wd)
 		}
 		return result
 	}
 	@discardableResult
 	public func addWatchWithAutomaticSubtreeWatching(forDirectory path: String, mask: InotifyEventMask) async throws -> [CInt] {
 		let wds = try await self.addRecursiveWatch(forDirectory: path, mask: mask)
 		watches.enableAutomaticSubtreeWatching(forIds: wds)
 		return wds
 	}
 	public func removeWatch(_ wd: CInt) throws {
 		guard inotify_rm_watch(self.fd, wd) == 0 else {
 			throw InotifyError.removeWatchFailed(watchDescriptor: wd, errno: cinotify_get_errno())
 		}
-		watches.removeValue(forKey: wd)
+		watches.remove(forId: wd)
 	}
 	deinit {
 		cinotify_deinit(self.fd)
 	}
 	private func transform(_ rawEvent: RawInotifyEvent) async -> InotifyEvent? {
 		guard let path = self.watches.path(forId: rawEvent.watchDescriptor) else { return nil }
 		let event = InotifyEvent.init(from: rawEvent, inDirectory: path)
 		await self.addWatchInCaseOfAutomaticSubtreeWatching(event)
 		return InotifyEvent.init(from: rawEvent, inDirectory: path)
 	}
 	private func addWatchInCaseOfAutomaticSubtreeWatching(_ event: InotifyEvent) async {
 		guard watches.isAutomaticSubtreeWatching(event.watchDescriptor),
 			  event.mask.contains(.create),
 			  event.mask.contains(.isDir) else {
 			return
 		}
 		guard let mask = self.watches.mask(forId: event.watchDescriptor) else { return }
 		let _ = try? await self.addWatchWithAutomaticSubtreeWatching(forDirectory: event.path.string, mask: mask)
 	}
 	private static func createEventReader(forFileDescriptor fd: CInt) -> (any DispatchSourceRead, AsyncStream<RawInotifyEvent>) {
 		let (stream, continuation) = AsyncStream<RawInotifyEvent>.makeStream(
 			of: RawInotifyEvent.self,
 			bufferingPolicy: .bufferingNewest(512)
 		)
 		let reader = DispatchSource.makeReadSource(
 			fileDescriptor: fd,
 			queue: DispatchQueue(label: "Inotify.read", qos: .utility)
 		)
 		reader.setEventHandler {
 			for rawEvent in InotifyEventParser.parse(fromFileDescriptor: fd) {
 				continuation.yield(rawEvent)
 			}
 		}
 		reader.setCancelHandler {
 			continuation.finish()
 		}
 		reader.activate()
 		return (reader, stream)
 	}
 }
--- a/Sources/Inotify/InotifyEvent.swift
+++ b/Sources/Inotify/InotifyEvent.swift
@@ -0,0 +1,26 @@
 import SystemPackage
 public struct InotifyEvent: Sendable, Hashable, CustomStringConvertible {
 	public let watchDescriptor: Int32
 	public let mask: InotifyEventMask
 	public let cookie: UInt32
 	public let path: FilePath
 	public var description: String {
 		var parts = ["InotifyEvent(wd: \(watchDescriptor), mask: \(mask), path: \"\(path)\""]
 		if cookie != 0 { parts.append("cookie: \(cookie)") }
 		return parts.joined(separator: ", ") + ")"
 	}
 }
 extension InotifyEvent {
 	public init(from rawEvent: RawInotifyEvent, inDirectory path: String) {
 		let dirPath = FilePath(path)
 		self.init(
 			watchDescriptor: rawEvent.watchDescriptor,
 			mask: rawEvent.mask,
 			cookie: rawEvent.cookie,
 			path: dirPath.appending(rawEvent.name)
 		)
 	}
 }
--- a/Sources/Inotify/InotifyEventMask.swift
+++ b/Sources/Inotify/InotifyEventMask.swift
@@ -1,7 +1,7 @@
 import CInotify
 public struct InotifyEventMask: OptionSet, Sendable, Hashable {
-	public let rawValue: UInt32
+	public let rawValue: CUnsignedInt
 	public init(rawValue: UInt32) {
 		self.rawValue = rawValue
@@ -9,18 +9,18 @@ public struct InotifyEventMask: OptionSet, Sendable, Hashable {
 	// MARK: - Watchable Events
-	public static let access        = InotifyEventMask(rawValue: UInt32(IN_ACCESS))
+	public static let access        = InotifyEventMask(rawValue: CUnsignedInt(IN_ACCESS))
-	public static let attrib        = InotifyEventMask(rawValue: UInt32(IN_ATTRIB))
+	public static let attrib        = InotifyEventMask(rawValue: CUnsignedInt(IN_ATTRIB))
-	public static let closeWrite    = InotifyEventMask(rawValue: UInt32(IN_CLOSE_WRITE))
+	public static let closeWrite    = InotifyEventMask(rawValue: CUnsignedInt(IN_CLOSE_WRITE))
-	public static let closeNoWrite  = InotifyEventMask(rawValue: UInt32(IN_CLOSE_NOWRITE))
+	public static let closeNoWrite  = InotifyEventMask(rawValue: CUnsignedInt(IN_CLOSE_NOWRITE))
-	public static let create        = InotifyEventMask(rawValue: UInt32(IN_CREATE))
+	public static let create        = InotifyEventMask(rawValue: CUnsignedInt(IN_CREATE))
-	public static let delete        = InotifyEventMask(rawValue: UInt32(IN_DELETE))
+	public static let delete        = InotifyEventMask(rawValue: CUnsignedInt(IN_DELETE))
-	public static let deleteSelf    = InotifyEventMask(rawValue: UInt32(IN_DELETE_SELF))
+	public static let deleteSelf    = InotifyEventMask(rawValue: CUnsignedInt(IN_DELETE_SELF))
-	public static let modify        = InotifyEventMask(rawValue: UInt32(IN_MODIFY))
+	public static let modify        = InotifyEventMask(rawValue: CUnsignedInt(IN_MODIFY))
-	public static let moveSelf      = InotifyEventMask(rawValue: UInt32(IN_MOVE_SELF))
+	public static let moveSelf      = InotifyEventMask(rawValue: CUnsignedInt(IN_MOVE_SELF))
-	public static let movedFrom     = InotifyEventMask(rawValue: UInt32(IN_MOVED_FROM))
+	public static let movedFrom     = InotifyEventMask(rawValue: CUnsignedInt(IN_MOVED_FROM))
-	public static let movedTo       = InotifyEventMask(rawValue: UInt32(IN_MOVED_TO))
+	public static let movedTo       = InotifyEventMask(rawValue: CUnsignedInt(IN_MOVED_TO))
-	public static let open          = InotifyEventMask(rawValue: UInt32(IN_OPEN))
+	public static let open          = InotifyEventMask(rawValue: CUnsignedInt(IN_OPEN))
 	// MARK: - Combinations
@@ -34,14 +34,14 @@ public struct InotifyEventMask: OptionSet, Sendable, Hashable {
 	// MARK: - Watch Flags
-	public static let dontFollow    = InotifyEventMask(rawValue: UInt32(IN_DONT_FOLLOW))
+	public static let dontFollow    = InotifyEventMask(rawValue: CUnsignedInt(IN_DONT_FOLLOW))
-	public static let onlyDir       = InotifyEventMask(rawValue: UInt32(IN_ONLYDIR))
+	public static let onlyDir       = InotifyEventMask(rawValue: CUnsignedInt(IN_ONLYDIR))
-	public static let oneShot       = InotifyEventMask(rawValue: UInt32(IN_ONESHOT))
+	public static let oneShot       = InotifyEventMask(rawValue: CUnsignedInt(IN_ONESHOT))
 	// MARK: - Kernel-Only Flags
-	public static let isDir         = InotifyEventMask(rawValue: UInt32(IN_ISDIR))
+	public static let isDir         = InotifyEventMask(rawValue: CUnsignedInt(IN_ISDIR))
-	public static let ignored       = InotifyEventMask(rawValue: UInt32(IN_IGNORED))
+	public static let ignored       = InotifyEventMask(rawValue: CUnsignedInt(IN_IGNORED))
-	public static let queueOverflow = InotifyEventMask(rawValue: UInt32(IN_Q_OVERFLOW))
+	public static let queueOverflow = InotifyEventMask(rawValue: CUnsignedInt(IN_Q_OVERFLOW))
-	public static let unmount       = InotifyEventMask(rawValue: UInt32(IN_UNMOUNT))
+	public static let unmount       = InotifyEventMask(rawValue: CUnsignedInt(IN_UNMOUNT))
 }
--- a/Sources/Inotify/InotifyEventParser.swift
+++ b/Sources/Inotify/InotifyEventParser.swift
@@ -0,0 +1,57 @@
 import CInotify
 struct InotifyEventParser {
 	static let readBufferSize = 4096
 	static func parse(fromFileDescriptor fd: Int32) -> [RawInotifyEvent] {
 		let buffer = UnsafeMutableRawPointer.allocate(
 			byteCount: Self.readBufferSize,
 			alignment: MemoryLayout<inotify_event>.alignment
 		)
 		defer { buffer.deallocate() }
 		let bytesRead = read(fd, buffer, readBufferSize)
 		guard bytesRead > 0 else { return [] }
 		return Self.parseEventBuffer(buffer, bytesRead: bytesRead)
 	}
 	private static func parseEventBuffer(
 		_ buffer: UnsafeMutableRawPointer,
 		bytesRead: Int
 	) -> [RawInotifyEvent] {
 		var events: [RawInotifyEvent] = []
 		var offset = 0
 		while offset < bytesRead {
 			let eventPointer = buffer.advanced(by: offset)
 			let rawEvent = eventPointer.assumingMemoryBound(to: inotify_event.self).pointee
 			events.append(RawInotifyEvent(
 				watchDescriptor: rawEvent.wd,
 				mask: InotifyEventMask(rawValue: rawEvent.mask),
 				cookie: rawEvent.cookie,
 				name: Self.extractName(from: eventPointer, nameLength: rawEvent.len)
 			))
 			offset += Self.eventSize(nameLength: rawEvent.len)
 		}
 		return events
 	}
 	private static func extractName(
 		from eventPointer: UnsafeMutableRawPointer,
 		nameLength: UInt32
 	) -> String {
 		guard nameLength > 0 else { return "" }
 		let namePointer = eventPointer
 			.advanced(by: MemoryLayout<inotify_event>.size)
 			.assumingMemoryBound(to: CChar.self)
 		return String(cString: namePointer)
 	}
 	private static func eventSize(nameLength: UInt32) -> Int {
 		MemoryLayout<inotify_event>.size + Int(nameLength)
 	}
 }
--- a/Sources/Inotify/InotifyWatchManager.swift
+++ b/Sources/Inotify/InotifyWatchManager.swift
@@ -0,0 +1,46 @@
 struct InotifyWatchManager {
 	private var watchPaths: [CInt: String] = [:]
 	private var watchMasks: [CInt: InotifyEventMask] = [:]
 	private var activeWatches: Set<CInt> = []
 	private var watchesWithAutomaticSubtreeWatching: Set<CInt> = []
 	mutating func add(_ path: String, withId watchDescriptor: CInt, mask: InotifyEventMask) {
 		self.watchPaths[watchDescriptor] = path
 		self.watchMasks[watchDescriptor] = mask
 		self.activeWatches.insert(watchDescriptor)
 	}
 	mutating func enableAutomaticSubtreeWatching(forId watchDescriptor: CInt) {
 		assert(self.activeWatches.contains(watchDescriptor))
 		self.watchesWithAutomaticSubtreeWatching.insert(watchDescriptor)
 	}
 	mutating func enableAutomaticSubtreeWatching(forIds watchDescriptors: CInt...) {
 		self.enableAutomaticSubtreeWatching(forIds: watchDescriptors)
 	}
 	mutating func enableAutomaticSubtreeWatching(forIds watchDescriptors: [CInt]) {
 		for watchDescriptor in watchDescriptors {
 			self.enableAutomaticSubtreeWatching(forId: watchDescriptor)
 		}
 	}
 	mutating func remove(forId watchDescriptor: CInt) {
 		self.watchPaths.removeValue(forKey: watchDescriptor)
 		self.watchMasks.removeValue(forKey: watchDescriptor)
 		self.activeWatches.remove(watchDescriptor)
 		self.watchesWithAutomaticSubtreeWatching.remove(watchDescriptor)
 	}
 	func path(forId watchDescriptor: CInt) -> String? {
 		return self.watchPaths[watchDescriptor]
 	}
 	func mask(forId watchDescriptor: CInt) -> InotifyEventMask? {
 		return self.watchMasks[watchDescriptor]
 	}
 	func isAutomaticSubtreeWatching(_ watchDescriptor: CInt) -> Bool {
 		return self.watchesWithAutomaticSubtreeWatching.contains(watchDescriptor)
 	}
 }
--- a/Sources/Inotify/RawInotifyEvent.swift
+++ b/Sources/Inotify/RawInotifyEvent.swift
@@ -0,0 +1,12 @@
 public struct RawInotifyEvent: Sendable, Hashable, CustomStringConvertible {
 	public let watchDescriptor: Int32
 	public let mask: InotifyEventMask
 	public let cookie: UInt32
 	public let name: String
 	public var description: String {
 		var parts = ["RawInotifyEvent(wd: \(watchDescriptor), mask: \(mask), name: \"\(name)\""]
 		if cookie != 0 { parts.append("cookie: \(cookie)") }
 		return parts.joined(separator: ", ") + ")"
 	}
 }
--- a/Sources/TaskCLI/TaskCLI.docc/TaskCLI.md
+++ b/Sources/TaskCLI/TaskCLI.docc/TaskCLI.md
@@ -0,0 +1,46 @@
 # ``TaskCLI``
 The build tool for the Swift Inotify project.
 ## Overview
 `TaskCLI` is a small command-line executable (exposed as `task` in `Package.swift`) that automates project-level workflows. Its primary purpose is running the integration test suite inside a Linux Docker container, so you can validate the inotify-dependent code on the correct platform even when developing on macOS.
 ### Running the Tests
 ```bash
 swift run task test
 ```
 This launches a `swift:latest` Docker container with the repository mounted at `/code`, then executes two test passes:
 1. All tests **except** `InotifyLimitTests` — the regular integration suite.
 2. Only `InotifyLimitTests` (with `--skip-build`) — tests that manipulate system-level inotify limits and must run in isolation.
 The container is started with `--security-opt systempaths=unconfined` so that the limit tests can write to `/proc/sys/fs/inotify/*`.
 ### Verbosity
 Pass one or more `-v` flags to increase log output:
 | Flag | Level |
 |------|-------|
 | *(none)* | `notice` |
 | `-v` | `info` |
 | `-vv` | `debug` |
 | `-vvv` | `trace` |
 ### Prerequisites
 Docker must be installed and running on the host machine. The container uses the `linux/arm64` platform by default.
 ## Topics
 ### Commands
 - ``Command``
 - ``TestCommand``
 ### Configuration
 - ``GlobalOptions``
--- a/Sources/TaskCLI/Test
+++ b/Sources/TaskCLI/Test
@@ -24,7 +24,7 @@ struct TestCommand: AsyncParsableCommand {
 		logger.debug("Current directory", metadata: ["current-directory": "\(currentDirectory)"])
 		async let monitorResult = Subprocess.run(
 			.name("docker"),
-			arguments: ["run", "-v", "\(currentDirectory):/code", "--platform", "linux/arm64", "-w", "/code", "swift:latest", "swift", "test"],
+			arguments: ["run", "-v", "\(currentDirectory):/code", "--security-opt", "systempaths=unconfined", "--platform", "linux/arm64", "-w", "/code", "swift:latest", "/bin/bash", "-c", "swift test --skip InotifyLimitTests; swift test --skip-build --filter InotifyLimitTests"],
 			preferredBufferSize: 10,
 		) { execution, standardInput, standardOutput, standardError in
 			print("")
--- a/Tests/InotifyIntegrationTests/EventTests.swift
+++ b/Tests/InotifyIntegrationTests/EventTests.swift
@@ -0,0 +1,118 @@
 import Foundation
 import Testing
@testable import Inotify
@Suite("File Event Detection")
 struct EventTests {
 	@Test func detectsFileCreation() async throws {
 		try await withTempDir { dir in
 			let filename = "testfile.txt"
 			let events = try await getEventsForTrigger(
 				in: dir,
 				mask: [.create, .closeWrite],
 			) { try createFile(at: "\($0)/\(filename)", contents: "hello") }
 			let createEvent = events.first { $0.mask.contains(.create) && $0.path.lastComponent?.string == filename }
 			#expect(createEvent != nil, "Expected CREATE for '\(filename)', got: \(events)")
 		}
 	}
 	@Test func detectsFileModification() async throws {
 		try await withTempDir { dir in
 			let filepath = "\(dir)/modify-target.txt"
 			try createFile(at: filepath)
 			let events = try await getEventsForTrigger(
 				in: dir,
 				mask: .modify,
 			) { _ in try "hello".write(toFile: filepath, atomically: false, encoding: .utf8) }
 			let modifyEvent = events.first { $0.mask.contains(.modify) && $0.path.string == filepath }
 			#expect(modifyEvent != nil, "Expected MODIFY for '\(filepath)', got: \(events)")
 		}
 	}
 	@Test func detectsFileDeletion() async throws {
 		try await withTempDir { dir in
 			let filepath = "\(dir)/delete-me.txt"
 			try createFile(at: filepath)
 			let events = try await getEventsForTrigger(
 				in: dir,
 				mask: .delete,
 			) { _ in try FileManager.default.removeItem(atPath: filepath) }
 			let deleteEvent = events.first { $0.mask.contains(.delete) && $0.path.string == filepath }
 			#expect(deleteEvent != nil, "Expected DELETE for '\(filepath)', got: \(events)")
 		}
 	}
 	@Test func detectsSubdirectoryCreationWithIsDirFlag() async throws {
 		try await withTempDir { dir in
 			let folderpath = "\(dir)/subdir-\(UUID())"
 			let events = try await getEventsForTrigger(
 				in: dir,
 				mask: .create,
 			) { _ in try FileManager.default.createDirectory(atPath: folderpath, withIntermediateDirectories: false) }
 			let createEvent = events.first { $0.mask.contains(.create) && $0.mask.contains(.isDir) && $0.path.string == folderpath }
 			#expect(createEvent != nil, "Expected CREATE for folder '\(folderpath)', got: \(events)")
 		}
 	}
 	@Test func detectsMoveWithMatchingCookies() async throws {
 		try await withTempDir { dir in
 			let sourceFilePath = "\(dir)/move-src.txt"
 			let destionationFilePath = "\(dir)/move-dst.txt"
 			try createFile(at: sourceFilePath)
 			let events = try await getEventsForTrigger(
 				in: dir,
 				mask: .move,
 			) { _ in try FileManager.default.moveItem(atPath: sourceFilePath, toPath: destionationFilePath) }
 			let movedFromEvent = events.first { $0.mask.contains(.movedFrom) && $0.path.string == sourceFilePath }
 			#expect(movedFromEvent != nil, "Expected MOVED_FROM for '\(movedFromEvent)', got: \(events)")
 			let movedToEvent = events.first { $0.mask.contains(.movedTo) && $0.path.string == destionationFilePath }
 			#expect(movedToEvent != nil, "Expected MOVED_TO for '\(destionationFilePath)', got: \(events)")
 			#expect(movedFromEvent?.cookie == movedToEvent?.cookie)
 		}
 	}
 	@Test func eventsArriveInOrder() async throws {
 		try await withTempDir { dir in
 			let filepath = "\(dir)/ordered-test.txt"
 			let events = try await getEventsForTrigger(in: dir, mask: [.create, .delete]) { _ in
 				try createFile(at: filepath)
 				try await Task.sleep(for: .milliseconds(50))
 				try FileManager.default.removeItem(atPath: filepath)
 			}
 			let createIdx = events.firstIndex { $0.mask.contains(.create) && $0.path.string == filepath }
 			#expect(createIdx != nil)
 			let deleteIdx = events.firstIndex { $0.mask.contains(.delete) && $0.path.string == filepath }
 			#expect(deleteIdx != nil)
 			if let createIdx, let deleteIdx {
 				#expect(createIdx < deleteIdx)
 			}
 		}
 	}
 	@Test func maskFiltersCorrectly() async throws {
 		try await withTempDir { dir in
 			let filepath = "\(dir)/mask-filter.txt"
 			let events = try await getEventsForTrigger(in: dir, mask: .delete) { _ in
 				try createFile(at: filepath)
 			}
 			let deleteEvent = events.first { $0.mask.contains(.delete) && $0.path.string == filepath }
 			#expect(deleteEvent == nil)
 		}
 	}
 }
--- a/Tests/InotifyIntegrationTests/InotifyLimitTests.swift
+++ b/Tests/InotifyIntegrationTests/InotifyLimitTests.swift
@@ -0,0 +1,43 @@
 import Testing
 import Foundation
@testable import Inotify
@Suite("Inotify Limits", .serialized)
 struct InotifyLimitTests {
 	@Test func throwsIfInotifyUpperLimitReached() async throws {
 		try await withTempDir { dir in
 			try await withInotifyWatchLimit(of: 10) {
 				try createSubdirectorytree(at: dir, foldersPerLevel: 4, levels: 3)
 				try await Task.sleep(for: .milliseconds(100))
 				await #expect(throws: InotifyError.self) {
 					let watcher = try Inotify()
 					try await watcher.addRecursiveWatch(forDirectory: dir, mask: .allEvents)
 				}
 			}
 		}
 	}
 	@Test func watchesMassivSubtreesIfAllowed() async throws {
 		try await withTempDir { dir in
 			try await withInotifyWatchLimit(of: 1000) {
 				try createSubdirectorytree(at: dir, foldersPerLevel: 8, levels: 3)
 				let subDirectory = "\(dir)/Folder 8/Folder 8/Folder 8"
 				let filepath = "\(subDirectory)/new-file.txt"
 				try await Task.sleep(for: .milliseconds(100))
 				let events = try await getEventsForTrigger(
 					in: dir,
 					mask: [.create],
 					recursive: .recursive
 				) { _ in
 					assert(FileManager.default.fileExists(atPath: subDirectory))
 					try createFile(at: "\(filepath)", contents: "hello")
 				}
 				let createEvent = events.first { $0.mask.contains(.create) && $0.path.string == filepath }
 				#expect(createEvent != nil, "Expected CREATE for '\(filepath)', got: \(events)")
 			}
 		}
 	}
 }
--- a/Tests/InotifyIntegrationTests/RecursiveEventTests.swift
+++ b/Tests/InotifyIntegrationTests/RecursiveEventTests.swift
@@ -0,0 +1,43 @@
 import Foundation
 import Testing
@testable import Inotify
@Suite("Recursive Event Detection")
 struct RecursiveEventTests {
 	@Test func detectsFileCreationInSubfolder() 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
 			) { _ in try createFile(at: "\(filepath)", contents: "hello") }
 			let createEvent = events.first { $0.mask.contains(.create) && $0.path.string == filepath }
 			#expect(createEvent != nil, "Expected CREATE for '\(filepath)', got: \(events)")
 		}
 	}
 	@Test func newSubfoldersOfRecursiveWatchAreAutomaticallyWatchedToo() async throws {
 		try await withTempDir { dir in
 			let subDirectory = "\(dir)/Subfolder"
 			let filepath = "\(subDirectory)/modify-target.txt"
 			let events = try await getEventsForTrigger(
 				in: dir,
 				mask: [.create],
 				recursive: .withAutomaticSubtreeWatching
 			) { _ in
 				try FileManager.default.createDirectory(atPath: subDirectory, withIntermediateDirectories: true)
 				try await Task.sleep(for: .milliseconds(200))
 				try createFile(at: "\(filepath)", contents: "hello")
 			}
 			let createEvent = events.first { $0.mask.contains(.create) && $0.path.string == filepath }
 			#expect(createEvent != nil, "Expected CREATE for '\(filepath)', got: \(events)")
 		}
 	}
 }
--- a/Tests/InotifyIntegrationTests/Utilities/createFile.swift
+++ b/Tests/InotifyIntegrationTests/Utilities/createFile.swift
@@ -0,0 +1,3 @@
 func createFile(at path: String, contents: String = "") throws {
 	try contents.write(toFile: path, atomically: false, encoding: .utf8)
 }
--- a/Tests/InotifyIntegrationTests/Utilities/createSubdirectorytree.swift
+++ b/Tests/InotifyIntegrationTests/Utilities/createSubdirectorytree.swift
@@ -0,0 +1,53 @@
 import Foundation
 import SystemPackage
 func createSubdirectorytree(at dir: String, foldersPerLevel: Int, levels: Int) throws {
 	let fileManager = FileManager.default
 	for path in SubfolderTreeIterator(basePath: dir, foldersPerLevel: foldersPerLevel, levels: levels) {
 		try fileManager.createDirectory(
 			at: path,
 			withIntermediateDirectories: true,
 			attributes: nil
 		)
 	}
 }
 struct SubfolderTreeIterator: IteratorProtocol, Sequence {
 	let basePath: URL
 	let foldersPerLevel: Int
 	let levels: Int
 	private var indices: [Int]
 	private var done = false
 	init(basePath: String, foldersPerLevel: Int, levels: Int) {
 		self.basePath = URL(filePath: basePath)
 		self.foldersPerLevel = foldersPerLevel
 		self.levels = levels
 		self.indices = Array(repeating: 1, count: levels)
 	}
 	mutating func next() -> URL? {
 		guard !done else { return nil }
 		let path = indices.reduce(basePath) { partialPath, index in
 			partialPath.appending(path: "Folder \(index)")
 		}
 		// Advance indices (odometer-style, rightmost increments first)
 		var carry = true
 		for i in (0..<levels).reversed() {
 			if carry {
 				indices[i] += 1
 				if indices[i] > foldersPerLevel {
 					indices[i] = 1
 				} else {
 					carry = false
 				}
 			}
 		}
 		if carry { done = true }
 		return path
 	}
 }
--- a/Tests/InotifyIntegrationTests/Utilities/getEventsForTrigger.swift
+++ b/Tests/InotifyIntegrationTests/Utilities/getEventsForTrigger.swift
@@ -0,0 +1,39 @@
 import Inotify
 enum RecursivKind {
 	case nonrecursive
 	case recursive
 	case withAutomaticSubtreeWatching
 }
 func getEventsForTrigger(
 	in dir: String,
 	mask: InotifyEventMask,
 	recursive: RecursivKind = .nonrecursive,
 	trigger: @escaping (String) async throws -> Void,
 ) async throws -> [InotifyEvent] {
 	let watcher = try Inotify()
 	switch recursive {
 	case .nonrecursive:
 		try await watcher.addWatch(path: dir, mask: mask)
 	case .recursive:
 		try await watcher.addRecursiveWatch(forDirectory: dir, mask: mask)
 	case .withAutomaticSubtreeWatching:
 		try await watcher.addWatchWithAutomaticSubtreeWatching(forDirectory: dir, mask: mask)
 	}
 	let eventTask = Task {
 		var events: [InotifyEvent] = []
 		for await event in await watcher.events {
 			events.append(event)
 		}
 		return events
 	}
 	try await Task.sleep(for: .milliseconds(100))
 	try await trigger(dir)
 	try await Task.sleep(for: .milliseconds(500))
 	eventTask.cancel()
 	return await eventTask.value
 }
--- a/Tests/InotifyIntegrationTests/Utilities/withLowInotifyWatchLimit.swift
+++ b/Tests/InotifyIntegrationTests/Utilities/withLowInotifyWatchLimit.swift
@@ -0,0 +1,22 @@
 import Foundation
 func withInotifyWatchLimit(of limit: Int, _ body: () async throws -> Void) async throws {
 	let confPath = URL(filePath: "/proc/sys/fs/inotify")
 	let filenames = ["max_user_watches", "max_user_instances", "max_queued_events"]
 	var previousLimits: [String: String] = [:]
 	for filename in filenames {
 		let filePath = confPath.appending(path: filename)
 		let currentLimit = try String(contentsOf: filePath, encoding: .utf8)
 		previousLimits[filename] = currentLimit
 		try "\(limit)".write(to: filePath, atomically: false, encoding: .utf8)
 	}
 	try await body()
 	for filename in filenames {
 		let filePath = confPath.appending(path: filename)
 		guard let previousLimit = previousLimits[filename] else { continue }
 		try previousLimit.write(to: filePath, atomically: false, encoding: .utf8)
 	}
 }
--- a/Tests/InotifyIntegrationTests/Utilities/withTempDir.swift
+++ b/Tests/InotifyIntegrationTests/Utilities/withTempDir.swift
Author	SHA1	Message	Date
T. R. Bernstein	a3652003f9	Add GitHub workflow file to generate docs Some checks failed Docs / docs (push) Has been cancelled Details Docs / deploy (push) Has been cancelled Details	2026-03-12 16:07:50 +01:00
T. R. Bernstein	80bde65a7c	Add SwiftPackageIndex configuration file	2026-03-12 16:07:30 +01:00
T. R. Bernstein	39fe5c9237	Add open source documentation files	2026-03-12 15:31:10 +01:00
T. R. Bernstein	76f91f67a6	Add integration tests for inofity limits inotify exposes a /proc interface to limit kernel memory usage. If those limits are set too low, inotify cannot add all watches. The integration test verifies, that Inotify yields an error in that case.	2026-03-12 14:52:33 +01:00
T. R. Bernstein	ffac6d17a5	Implement auto subtree watching of a directory Allow recursively watching a directory while adding newly created subdirectories to the inotify watch list.	2026-03-12 12:04:08 +01:00
T. R. Bernstein	a8d7fb017f	Add data structure for watch descriptor management For watching whole trees - a change which is upcoming - the watch descriptor IDs will have to be managed in multiple lists. The InotifyWatchManager encapsulates the managment logic within a nice API.	2026-03-12 11:32:29 +01:00
T. R. Bernstein	b41b82bd0f	Implement recursive watching of a directory	2026-03-12 10:36:12 +01:00
T. R. Bernstein	d57f998fd4	Use C integer types Instead of using hardcoded fixed width integers, use C integer types. As the actual integer size of C depends on the implementation, even if it is often 32bit, we use the C integer types to guard against cases, where that is not the case.	2026-03-12 00:32:14 +01:00
T. R. Bernstein	e44e1fc9b8	Adapt inotify timeouts in Tests Inotify event stream is dependent on system usage. Increasing the timeouts helps not having to repeat the integration tests.	2026-03-12 00:22:22 +01:00
T. R. Bernstein	58a05e9b61	Implement async event streaming	2026-03-12 00:22:17 +01:00