5 Commits

Author SHA1 Message Date
T. R. Bernstein
29e35ae386 Update README section about docs generation
Some checks failed
Docs / docs (push) Has been cancelled
Docs / deploy (push) Has been cancelled
Show how to generate the Docc docs using task CLI instead of faning out
to swift package docc plugin.
2026-03-13 02:32:15 +01:00
T. R. Bernstein
672c4b85f2 Add GitHub workflow file to generate docs
Some checks failed
Docs / docs (push) Has been cancelled
Docs / deploy (push) Has been cancelled
2026-03-13 02:25:18 +01:00
T. R. Bernstein
295b701be1 Add SwiftPackageIndex configuration file 2026-03-13 02:09:56 +01:00
T. R. Bernstein
984b0dd29c 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-13 02:09:56 +01:00
T. R. Bernstein
39fe5c9237 Add open source documentation files 2026-03-12 15:31:10 +01:00
16 changed files with 93 additions and 299 deletions

View File

@@ -30,7 +30,7 @@ jobs:
- name: Generate Docs - name: Generate Docs
run: | run: |
swift package add-dependency --from 1.4.0 "https://github.com/apple/swift-docc-plugin.git" swift package add-dependency --from 1.4.0 "https://github.com/apple/swift-docc-plugin.git"
for target in Inotify InotifyTaskCLI; do for target in Inotify TaskCLI; do
lower="${target,,}" lower="${target,,}"
mkdir -p "./public/$lower" mkdir -p "./public/$lower"
swift package --allow-writing-to-directory "./public/$lower" \ swift package --allow-writing-to-directory "./public/$lower" \
@@ -44,7 +44,7 @@ jobs:
cp ./.github/workflows/index.tpl.html public/index.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.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.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 sed -i -e 's|{{project.links}}|<li><a href="inotify/documentation/inotify/">Inotify</a>: The actual library.</li><li><a href="taskcli/documentation/taskcli/">TaskCLI</a>: The project build command.</li>|g' public/index.html
- name: Upload artifact - name: Upload artifact
uses: actions/upload-pages-artifact@v4 uses: actions/upload-pages-artifact@v4
with: with:

View File

@@ -2,4 +2,3 @@ version: 1
builder: builder:
configs: configs:
- documentation_targets: [Inotify, TaskCLI] - documentation_targets: [Inotify, TaskCLI]
platform: Linux

View File

@@ -8,6 +8,10 @@ let package = Package(
.library( .library(
name: "Inotify", name: "Inotify",
targets: ["Inotify"] targets: ["Inotify"]
),
.executable(
name: "task",
targets: ["TaskCLI"]
) )
], ],
dependencies: [ dependencies: [
@@ -38,16 +42,14 @@ let package = Package(
], ],
), ),
.executableTarget( .executableTarget(
name: "InotifyTaskCLI", name: "TaskCLI",
dependencies: [ dependencies: [
.product(name: "ArgumentParser", package: "swift-argument-parser"), .product(name: "ArgumentParser", package: "swift-argument-parser"),
.product(name: "AsyncAlgorithms", package: "swift-async-algorithms"), .product(name: "AsyncAlgorithms", package: "swift-async-algorithms"),
.product(name: "Logging", package: "swift-log"), .product(name: "Logging", package: "swift-log"),
.product(name: "_NIOFileSystem", package: "swift-nio"),
.product(name: "Subprocess", package: "swift-subprocess"), .product(name: "Subprocess", package: "swift-subprocess"),
.product(name: "Noora", package: "Noora") .product(name: "Noora", package: "Noora")
], ]
path: "Sources/TaskCLI"
) )
] ]
) )

View File

@@ -75,24 +75,6 @@ try await inotify.addWatchWithAutomaticSubtreeWatching(
This is the most convenient option when you need full coverage of a growing directory tree. 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 ## Event Masks
`InotifyEventMask` is an `OptionSet` that mirrors the native inotify flags. You can combine them freely. `InotifyEventMask` is an `OptionSet` that mirrors the native inotify flags. You can combine them freely.
@@ -131,15 +113,10 @@ try inotify.removeWatch(wd)
## Build Tool ## Build Tool
The package ships with a `task` executable (the `TaskCLI` target) that serves as the project's build tool. It automates running tests and generating documentation inside Linux Docker containers, so you can validate everything on the correct platform even when developing on macOS. 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.
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 ```bash
./task.sh test 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). 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).
@@ -151,7 +128,7 @@ Docker must be installed and running on your machine.
Full API documentation is available as DocC catalogs bundled with the package. Generate them locally with: Full API documentation is available as DocC catalogs bundled with the package. Generate them locally with:
```bash ```bash
./task.sh generate-docs swift run task generate-docs
``` ```
Then open the files in the newly created `public` folder. Then open the files in the newly created `public` folder.

View File

@@ -3,35 +3,42 @@ import _NIOFileSystem
public struct DirectoryResolver { public struct DirectoryResolver {
static let fileManager = FileSystem.shared static let fileManager = FileSystem.shared
public static func resolve(_ paths: String..., excluding itemNames: Set<String> = []) async throws -> [FilePath] { public static func resolve(_ paths: String...) async throws -> [FilePath] {
try await Self.resolve(paths, excluding: itemNames) try await Self.resolve(paths)
} }
static func resolve(_ paths: [String], excluding itemNames: Set<String> = []) async throws -> [FilePath] { static func resolve(_ paths: [String]) async throws -> [FilePath] {
var resolved: [FilePath] = [] var resolved: [FilePath] = []
for path in paths { for path in paths {
let path = FilePath(path) let itemPath = FilePath(path)
resolved.append(path) try await Self.ensure(itemPath, is: .directory)
try await withSubdirectories(at: path, recursive: true) { subdirectoryPath in
guard let basename = subdirectoryPath.lastComponent?.description else { return } let allDirectoriesIncludingSelf = try await getAllSubdirectoriesAndSelf(at: itemPath)
guard !itemNames.contains(basename) else { return } resolved.append(contentsOf: allDirectoriesIncludingSelf)
resolved.append(subdirectoryPath)
}
} }
return resolved return resolved
} }
private static func withSubdirectories(at path: FilePath, recursive: Bool = false, body: (FilePath) async throws -> Void) async throws { 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) let directoryHandle = try await fileManager.openDirectory(atPath: path)
for try await childContent in directoryHandle.listContents() { for try await childContent in directoryHandle.listContents(recursive: true) {
guard childContent.type == .directory else { continue } guard childContent.type == .directory else { continue }
try await body(childContent.path) result.append(childContent.path)
if recursive {
try await withSubdirectories(at: childContent.path, recursive: recursive, body: body)
}
} }
try await directoryHandle.close() try await directoryHandle.close()
return result
} }
} }

View File

@@ -20,8 +20,6 @@ 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/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. - ``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. All public types conform to `Sendable`, so they can be safely passed across concurrency boundaries.
## Topics ## Topics
@@ -32,10 +30,6 @@ All public types conform to `Sendable`, so they can be safely passed across conc
- ``InotifyEvent`` - ``InotifyEvent``
- ``InotifyEventMask`` - ``InotifyEventMask``
### Articles
- <doc:WatchingDirectoryTrees>
### Errors ### Errors
- ``InotifyError`` - ``InotifyError``

View File

@@ -33,22 +33,6 @@ 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. 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 ### Choosing the Right Method
| Method | Covers existing subdirectories | Covers new subdirectories | | Method | Covers existing subdirectories | Covers new subdirectories |

View File

@@ -3,7 +3,6 @@ import CInotify
public actor Inotify { public actor Inotify {
private let fd: CInt private let fd: CInt
private var excludedItemNames: Set<String> = []
private var watches = InotifyWatchManager() private var watches = InotifyWatchManager()
private var eventReader: any DispatchSourceRead private var eventReader: any DispatchSourceRead
private var eventStream: AsyncStream<RawInotifyEvent> private var eventStream: AsyncStream<RawInotifyEvent>
@@ -19,24 +18,6 @@ public actor Inotify {
(self.eventReader, self.eventStream) = Self.createEventReader(forFileDescriptor: fd) (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 @discardableResult
public func addWatch(path: String, mask: InotifyEventMask) throws -> CInt { public func addWatch(path: String, mask: InotifyEventMask) throws -> CInt {
let wd = inotify_add_watch(self.fd, path, mask.rawValue) let wd = inotify_add_watch(self.fd, path, mask.rawValue)
@@ -49,7 +30,7 @@ public actor Inotify {
@discardableResult @discardableResult
public func addRecursiveWatch(forDirectory path: String, mask: InotifyEventMask) async throws -> [CInt] { public func addRecursiveWatch(forDirectory path: String, mask: InotifyEventMask) async throws -> [CInt] {
let directoryPaths = try await DirectoryResolver.resolve(path, excluding: self.excludedItemNames) let directoryPaths = try await DirectoryResolver.resolve(path)
var result: [CInt] = [] var result: [CInt] = []
for path in directoryPaths { for path in directoryPaths {
let wd = try self.addWatch(path: path.string, mask: mask) let wd = try self.addWatch(path: path.string, mask: mask)
@@ -78,7 +59,6 @@ public actor Inotify {
private func transform(_ rawEvent: RawInotifyEvent) async -> InotifyEvent? { private func transform(_ rawEvent: RawInotifyEvent) async -> InotifyEvent? {
guard let path = self.watches.path(forId: rawEvent.watchDescriptor) else { return nil } 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) let event = InotifyEvent.init(from: rawEvent, inDirectory: path)
await self.addWatchInCaseOfAutomaticSubtreeWatching(event) await self.addWatchInCaseOfAutomaticSubtreeWatching(event)
return InotifyEvent.init(from: rawEvent, inDirectory: path) return InotifyEvent.init(from: rawEvent, inDirectory: path)

View File

@@ -4,6 +4,6 @@ import ArgumentParser
struct Command: AsyncParsableCommand { struct Command: AsyncParsableCommand {
static let configuration = CommandConfiguration( static let configuration = CommandConfiguration(
abstract: "Project tasks of Astzweig's Swift Inotify project.", abstract: "Project tasks of Astzweig's Swift Inotify project.",
subcommands: [TestCommand.self, GenerateDocumentationCommand.self] subcommands: [TestCommand.self, GenerateDocsCommand.self]
) )
} }

View File

@@ -1,25 +0,0 @@
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()
}
}

View File

@@ -5,10 +5,10 @@ import Logging
import Noora import Noora
import Subprocess import Subprocess
struct GenerateDocumentationCommand: AsyncParsableCommand { struct GenerateDocsCommand: AsyncParsableCommand {
static let configuration = CommandConfiguration( static let configuration = CommandConfiguration(
commandName: "generate-documentation", commandName: "generate-docs",
abstract: "Generate DocC documentation of all targets inside a Linux container.", abstract: "Generate DocC documentation inside a Linux container.",
aliases: ["gd"], aliases: ["gd"],
) )
@@ -16,20 +16,20 @@ struct GenerateDocumentationCommand: AsyncParsableCommand {
private static let doccPluginURL = "https://github.com/apple/swift-docc-plugin.git" private static let doccPluginURL = "https://github.com/apple/swift-docc-plugin.git"
private static let doccPluginMinVersion = "1.4.0" 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"] private static let skipItems: Set<String> = [".git", ".build", ".swiftpm", "public"]
// MARK: - Run // MARK: - Run
func run() async throws { func run() async throws {
let noora = Noora() let noora = Noora()
let logger = global.makeLogger(labeled: "swift-inotify.cli.task.generate-documentation") let logger = global.makeLogger(labeled: "swift-inotify.cli.task.generate-docs")
let fileManager = FileManager.default let fileManager = FileManager.default
let projectDirectory = URL(fileURLWithPath: fileManager.currentDirectoryPath) let projectDirectory = URL(fileURLWithPath: fileManager.currentDirectoryPath)
let targets = try await Self.targets(for: projectDirectory)
noora.info("Generating DocC documentation on Linux.") noora.info("Generating DocC documentation on Linux.")
logger.debug("Current directory", metadata: ["current-directory": "\(projectDirectory.path(percentEncoded: false))", "targets": "\(targets.joined(separator: ", "))"]) logger.debug("Current directory", metadata: ["current-directory": "\(projectDirectory.path(percentEncoded: false))"])
let tempDirectory = try copyProject(from: projectDirectory) let tempDirectory = try copyProject(from: projectDirectory)
logger.info("Copied project to temporary directory.", metadata: ["path": "\(tempDirectory.path(percentEncoded: false))"]) logger.info("Copied project to temporary directory.", metadata: ["path": "\(tempDirectory.path(percentEncoded: false))"])
@@ -40,7 +40,7 @@ struct GenerateDocumentationCommand: AsyncParsableCommand {
} }
try await injectDoccPluginDependency(in: tempDirectory, logger: logger) try await injectDoccPluginDependency(in: tempDirectory, logger: logger)
let script = Self.makeRunScript(for: targets) let script = Self.makeRunScript()
logger.debug("Container script", metadata: ["script": "\(script)"]) logger.debug("Container script", metadata: ["script": "\(script)"])
let dockerResult = try await Subprocess.run( let dockerResult = try await Subprocess.run(
@@ -70,81 +70,47 @@ struct GenerateDocumentationCommand: AsyncParsableCommand {
} }
try copyResults(from: tempDirectory, to: projectDirectory) 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( noora.success(
.alert("Documentation generated successfully.", .alert("Documentation generated successfully.",
takeaways: ["Start a local web server with ./public as document root, i.e. with python3 -m http.server to browse the documentation."] takeaways: Self.targets.map {
"./public/\($0.lowercased())/"
}
) )
) )
} }
private static func generateIndexHTML(templateURL: URL, outputURL: URL) throws { private static func generateDocsCommand() -> String {
var content = try String(contentsOf: templateURL, encoding: .utf8) Self.targets.map {
"swift package generate-documentation --target \($0)"
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: " && ") }.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()
return "set -euo pipefail && \(generateDocs)" +
" && OUTPUTS=.build/plugins/Swift-DocC/outputs" +
" && mkdir -p \(outputDirs)" +
" && \(transformDocs)"
}
// MARK: - Project Copy // MARK: - Project Copy
private func copyProject(from source: URL) throws -> URL { private func copyProject(from source: URL) throws -> URL {
@@ -175,23 +141,32 @@ struct GenerateDocumentationCommand: AsyncParsableCommand {
// MARK: - Dependency Injection // MARK: - Dependency Injection
private func injectDoccPluginDependency(in directory: URL, logger: Logger) async throws { 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( let result = try await Subprocess.run(
.name("swift"), .name("swift"),
arguments: [ arguments: [
"package", "--package-path", directory.path(percentEncoded: false), "package", "--package-path", directory.path(percentEncoded: false),
"add-dependency", "--from", Self.doccPluginMinVersion, Self.doccPluginURL "add-dependency", Self.doccPluginURL,
"--from", Self.doccPluginMinVersion,
], ],
) { _ in } ) { _ in }
guard result.terminationStatus.isSuccess else { guard result.terminationStatus.isSuccess else {
throw GenerateDocumentationError.dependencyInjectionFailed throw GenerateDocsError.dependencyInjectionFailed
} }
logger.info("Injected swift-docc-plugin dependency.") logger.info("Injected swift-docc-plugin dependency.")
} }
} }
enum GenerateDocumentationError: Error, CustomStringConvertible { enum GenerateDocsError: Error, CustomStringConvertible {
case dependencyInjectionFailed case dependencyInjectionFailed
var description: String { var description: String {

View File

@@ -1,4 +1,4 @@
# ``InotifyTaskCLI`` # ``TaskCLI``
The build tool for the Swift Inotify project. The build tool for the Swift Inotify project.
@@ -6,14 +6,10 @@ 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. `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 ### Running the Tests
```bash ```bash
./task.sh test swift run task test
``` ```
This launches a `swift:latest` Docker container with the repository mounted at `/code`, then executes two test passes: This launches a `swift:latest` Docker container with the repository mounted at `/code`, then executes two test passes:
@@ -26,7 +22,7 @@ The container is started with `--security-opt systempaths=unconfined` so that th
### Generating Documentation ### Generating Documentation
```bash ```bash
./task.sh generate-documentation swift run task generate-docs
``` ```
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. 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.
@@ -54,7 +50,7 @@ Docker must be installed and running on the host machine. The container uses the
- ``Command`` - ``Command``
- ``TestCommand`` - ``TestCommand``
- ``GenerateDocumentationCommand`` - ``GenerateDocsCommand``
### Configuration ### Configuration
@@ -62,4 +58,4 @@ Docker must be installed and running on the host machine. The container uses the
### Errors ### Errors
- ``GenerateDocumentationError`` - ``GenerateDocsError``

View File

@@ -1,17 +0,0 @@
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])
}
}
}

View File

@@ -21,24 +21,6 @@ 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 { @Test func newSubfoldersOfRecursiveWatchAreAutomaticallyWatchedToo() async throws {
try await withTempDir { dir in try await withTempDir { dir in
let subDirectory = "\(dir)/Subfolder" let subDirectory = "\(dir)/Subfolder"
@@ -50,7 +32,7 @@ struct RecursiveEventTests {
recursive: .withAutomaticSubtreeWatching recursive: .withAutomaticSubtreeWatching
) { _ in ) { _ in
try FileManager.default.createDirectory(atPath: subDirectory, withIntermediateDirectories: true) try FileManager.default.createDirectory(atPath: subDirectory, withIntermediateDirectories: true)
try await Task.sleep(for: .milliseconds(400)) try await Task.sleep(for: .milliseconds(200))
try createFile(at: "\(filepath)", contents: "hello") try createFile(at: "\(filepath)", contents: "hello")
} }

View File

@@ -10,11 +10,9 @@ func getEventsForTrigger(
in dir: String, in dir: String,
mask: InotifyEventMask, mask: InotifyEventMask,
recursive: RecursivKind = .nonrecursive, recursive: RecursivKind = .nonrecursive,
exclude: [String] = [],
trigger: @escaping (String) async throws -> Void, trigger: @escaping (String) async throws -> Void,
) async throws -> [InotifyEvent] { ) async throws -> [InotifyEvent] {
let watcher = try Inotify() let watcher = try Inotify()
await watcher.exclude(names: exclude)
switch recursive { switch recursive {
case .nonrecursive: case .nonrecursive:
try await watcher.addWatch(path: dir, mask: mask) try await watcher.addWatch(path: dir, mask: mask)

58
task.sh
View File

@@ -1,58 +0,0 @@
#!/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 "$@"