njdehoog / witness Goto Github PK

View Code? Open in Web Editor NEW

164.0 2.0 28.0 21.05 MB

Monitor file system events using Swift

License: MIT License

Objective-C 3.08% Swift 96.92%

file-system events swift watch monitor

witness's Introduction

Witness

Monitor file system changes using Swift. Witness provides a wrapper around the File System Events API for OS X.

Installation

The recommended way to include Witness in your project is by using Carthage. Simply add this line to your Cartfile:

github "njdehoog/Witness" ~> 0.1

Usage

Import the framework

import Witness

Monitor file system events

This will trigger an event when a file in the Desktop directory is created, deleted or modified.

if let desktopPath = NSSearchPathForDirectoriesInDomains(.desktopDirectory, .userDomainMask, true).first {
    self.witness = Witness(paths: [desktopPath], flags: .FileEvents, latency: 0.3) { events in
        print("file system events received: \(events)")
    }
}

Contributing

Fork it!
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am 'Add some feature'
Push to the branch: git push origin my-new-feature
Submit a pull request :D

Credits

Witness was developed for use in Spelt. If you like this library, please consider supporting development by purchasing the app.

License

Witness is released under the MIT license. See LICENSE for details.

witness's People

Contributors

Stargazers

Watchers

witness's Issues

Support Swift 4

Hi @njdehoog,

I will be submitting a PR for this issue. Please review when at your earliest convenience.

I like that you added support for Swift Package Manager, but it needs to have a new tag (say 0.1.4). I can test things in my application by specifying the master branch, but I can't do that in my production version since the package management in Xcode will not allow the mix. Specifically I get the following:

because package libs-ebedcore is required using a version-based requirement and it depends on unversion package witness and no versions of libs-EbedCore match the requirement 2.3.1..<3.0.0, libs-EbedCore >=2.3.0 is forbidden.
And because root depends on libs-EbedCore 2.3.0..<3.0.0, version solving failed.

While I can work around that while I'm testing since I also use a branch for my libs-ebedcore library, when I switch to using a specific version, it fails complaining that the specific version (libs-ebedcore v2.3.0) is depending on a non-versioned (Witness) prerequisite.

Would you be willing to take your current commit "b046945" as version 0.1.4? That would help me out a lot.

Thread 1: Fatal error: Unexpectedly found nil while implicitly unwrapping an Optional value

EventStream file of Witness. String 57

[![enter image description here][1]][1]
[1]: https://i.stack.imgur.com/g3fCp.png

Seemingly duplicated events for a change

I added a watch to a folder (Source) with a file (first.txt), and when I change the contents of that file, I get this exact event 150 times:

▿ FileEvent
  - path : "/Users/revolt/Downloads/Source/first.txt"
  ▿ flags : Item created,Item Renamed,Item Modified,Item Change Owner,Item Is File
    - rawValue : 4282624

Maybe I'm receiving the "Item created" event for a simple content modification because of Vim, but shouldn't I receive only one "Item Modified" event?

I tried using echo "new content" > first.txt and I get a lot of times this event:

▿ FileEvent
  - path : "/Users/revolt/Downloads/Source/first.txt"
  ▿ flags : Item Inode Meta Modification,Item Modified,Item Is File
    - rawValue : 4264960

Improve repository description and add tags

Thanks for the project! While this is one of the most up to date and neatest projects it seems a little tricky to find. Consider changing description to include file system events watch swift and adding tags. More will find it. More will use it. More will contribute.

Swift Package Manager support

Hi!
We are using Witness in our project and this will be useful, if Witness make support SPM
It's possible?