eonist / filewatcher Goto Github PK

Modifications seem to have been made to support SPM but the latest release (0.2.2) is not tagged as such to properly pull via Xcode. A warning is displayed in getting the latest tagged release (0.2.1) in Xcode 11.4 as it doesn't support SPM.

Hi, I'm using this library in a brand new vanilla SwiftUI project and anytime I make a change to a file, the callback is getting triggered twice:

import FileWatcher
class ContentScreenViewModel: ObservableObject {
    let filewatcher = FileWatcher(["/Users/aryamansharda/Documents/test.md"])

    init() {
        filewatcher.start() // start monitoring
        filewatcher.callback = { event in
            print("Something happened here: " + event.path)
        }
    }
}

struct ContentView: View {
    @StateObject var viewModel = ContentScreenViewModel()

    var body: some View {
        VStack {
            Text("Hello, world!")
        }
        .padding()
    }
}

This is the entirety of the program's code and any time I make a change to test.md, I see this in the Debugger:

Something happened here: /Users/aryamansharda/Documents/test.md
Something happened here: /Users/aryamansharda/Documents/test.md

When I use event.description in the print statement, it's showing that the file was renamed even though only its contents were changed:

The file /Users/aryamansharda/Documents/test.md was renamed
The file /Users/aryamansharda/Documents/test.md was created

For other files, both lines mention renamed:

The file /Users/aryamansharda/Documents/calc/.git/HEAD was renamed
The file /Users/aryamansharda/Documents/calc/.git/HEAD was renamed

Is this expected?

Replace with a guard that asserts against streamRef != nil

Hello,
when targeting macOS 13, compiler shows warning "FSEventStreamSetDispatchQueue was deprecated" in FileWatcher.swift line 43.

Thanks and with best regards
Petr Pavlicek

Use Enums? I'll make an example soonish

Xcode has warnings when add FileWatcher with SPM.

Consider to place all sources into 'Sources' subfolder to silence them.

found 3 file(s) which are unhandled; explicitly declare them as resources or exclude from the target

/Users/.../checkouts/FileWatcher/FileWatcher_macOS/Info.plist
/Users/.../checkouts/FileWatcher/README.md
/Users/.../checkouts/FileWatcher/LICENSE

eonist/my-swift-projects@d631b9c#diff-5c6af8db916751978b35427cb86d3c2b

If we need check that file created:

import FileWatcher_macOS

let filewatcher = FileWatcher([
  NSString(string: "~/Desktop").expandingTildeInPath
])
        
filewatcher.callback = { event in
  if (event.fileCreated) {
    print("File created here: " + event.path)
  }
}

filewatcher.start()

We got:
'fileCreated' is inaccessible due to 'internal' protection level

https://developer.apple.com/forums/thread/90531

Observing changes in a file with DispatchSource
The final “lesser known” feature of GCD that I want to bring up is how it provides a way to observe changes in a file on the file system. Like DispatchSemaphore, this is something which can be super useful in a script or command line tool, if we want to automatically react to a file being edited by the user. This enables us to easily build developer tools that have “live editing” features.

Dispatch sources come in a few different variants, depending on what we want to observe. In this case we’ll use DispatchSourceFileSystemObject, which lets us observe events from the file system.

Let's take a look at an example implementation of a simple FileObserver, that lets us attach a closure to be run every time a given file is changed. It works by creating a dispatch source using a fileDescriptor and a DispatchQueue to perform the observation on, and uses Files to refer to the file to observe:

class FileObserver {
    private let file: File
    private let queue: DispatchQueue
    private var source: DispatchSourceFileSystemObject?

    init(file: File) {
        self.file = file
        self.queue = DispatchQueue(label: "com.myapp.fileObserving")
    }

    func start(closure: @escaping () -> Void) {
        // We can only convert an NSString into a file system representation
        let path = (file.path as NSString)
        let fileSystemRepresentation = path.fileSystemRepresentation

        // Obtain a descriptor from the file system
        let fileDescriptor = open(fileSystemRepresentation, O_EVTONLY)

        // Create our dispatch source
        let source = DispatchSource.makeFileSystemObjectSource(
            fileDescriptor: fileDescriptor,
            eventMask: .write,
            queue: queue
        )

        // Assign the closure to it, and resume it to start observing
        source.setEventHandler(handler: closure)
        source.resume()
        self.source = source
    }
}
We can now use FileObserver like this:

let observer = try FileObserver(file: file)

observer.start {
    print("File was changed")
}

ref: https://www.swiftbysundell.com/articles/a-deep-dive-into-grand-central-dispatch-in-swift/

Could we make the instance variable non-optional? Example:

lazy var someSize:CGSize = {
   let x:CGFloat = 0
   let y:CGFloat = 0
   let size = CGSize(x,y,0,0)
   return size
}()

//Now we can use someSize with out force unwrap 👌
//What happens is that the var isn't created until something asks for it.
print(someSize.x)

After importing the project and getting it setup, I tested deleting files from a directory. The notifications fire properly but they state that the file was renamed instead of removed. Additionally, adding a file will say that it was modified instead of created.

I tried this on an iCloud and a non-iCloud Drive folder.

This is the output of printing from extension FileWatcherEvent

Swift.print(self.removed)
Swift.print(self.renamed)
Swift.print(result.description)

false
true
The file /Users/nick/Downloads/IMG_1739.jpeg was renamed

Any ideas? Love the library btw, thank you!

Any way to build with macOS 10.12 support?