Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/krzysztofzablocki/KZFileWatchers
A micro-framework for observing file changes, both local and remote. Helpful in building developer tools.
https://github.com/krzysztofzablocki/KZFileWatchers
Last synced: 3 months ago
JSON representation
A micro-framework for observing file changes, both local and remote. Helpful in building developer tools.
- Host: GitHub
- URL: https://github.com/krzysztofzablocki/KZFileWatchers
- Owner: krzysztofzablocki
- License: mit
- Created: 2016-08-08T09:00:27.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-21T15:11:11.000Z (11 months ago)
- Last Synced: 2024-04-13T21:57:35.849Z (7 months ago)
- Language: Swift
- Homepage: http://merowing.info
- Size: 2.17 MB
- Stars: 1,076
- Watchers: 21
- Forks: 63
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: Funding.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-ios - KZFileWatchers - A micro-framework for observing file changes, both local and remote. Helpful in building developer tools. (Files / Getting Started)
- awesome-swift - KZFileWatchers - A micro-framework for observing file changes, both local and remote. (Libs / Files)
- awesome-swift - KZFileWatchers - A micro-framework for observing file changes, both local and remote. (Libs / Files)
- awesome-macos-libraries - KZFileWatchers - A micro-framework for observing file changes, both local and remote. Helpful in building developer tools. Language: Swift. (Files)
- awesome-ios-star - KZFileWatchers - A micro-framework for observing file changes, both local and remote. Helpful in building developer tools. (Files / Getting Started)
- fucking-awesome-swift - KZFileWatchers - A micro-framework for observing file changes, both local and remote. (Libs / Files)
- awesome-swift - KZFileWatchers - A micro-framework for observing file changes, both local and remote. Helpful in building developer tools. ` 📝 6 months ago ` (Files [🔝](#readme))
README
# KZFileWatchers
[](https://travis-ci.org/krzysztofzablocki/KZFileWatchers)
[](http://cocoapods.org/pods/KZFileWatchers)
[](http://cocoapods.org/pods/KZFileWatchers)
[](http://cocoapods.org/pods/KZFileWatchers)
Wouldn't it be great if we could adjust feeds and configurations of our native apps without having to sit back to Xcode, change code, recompile and navigate back to screen we were at?
One of the basis of building tools that allow us to do just that is the way we observe for data changes, this micro-framework provides you File observers for Local and Remote assets.
This framework provides:
- `FileWatcher.Local` useful for observing local file changes, it can also be used to breach Sandbox env for debug simulator builds and e.g. observe file on the developer desktop (like the demo app does).
- `FileWatcher.Remote` can be used to observe files on the web, it supports both `Etag` headers and `Last-Modified-Date` so you can just put file on Dropbox or real ftp server.
It also supports usage from Objective-C projects. For this, you should consider these following steps:
1. Add `$(TOOLCHAIN_DIR)/usr/lib/swift/$(PLATFORM_NAME)` into your projects **Library Search Paths** in **Build Setting** section.
2. Import swift-header by adding `@import KZFileWatchers;` into any `.m` file, where you want to use FileWatchers.
3. Use provided classes for set up file observing like this:
```objectivec
self.fileWatcher = [[LocalFileWatcher alloc] initWithPath:path];
self.fileWatcher.delegate = self;
[self.fileWatcher startWithError:nil];
```
4. Implement `FileWatcherDelegate` in your class for handling file refreshing events. For example:
```objectivec
- (void)refreshDidOccurFrom:(id)fileWatcher type:(enum RefreshResult)type data:(NSData *)data
{
self.textLabel.text = [[NSString alloc] initWithData:data encoding:kCFStringEncodingUTF8];
}
```
## Installation
KZFileWatchers is available through [CocoaPods](http://cocoapods.org) and [Swift Package Manager](http://github.com/apple/swift-package-manager).
### CocoaPods
In order to install KZFileWatchers by using CocoaPods, simply add the following line to your Podfile:
```ruby
pod "KZFileWatchers"
```
Last version to support Swift 2.3 is `0.1.2`
Last version to support Swift 3.0 is `1.0.4`
### Swift Package Manager
Installing KZFileWatchers over SwiftPM is only supported since version 1.0.1. You just need to add it as a dependency to your Package.swift manifest:
```swift
import PackageDescription
let package = Package(
name: "YourProject",
dependencies: [
.package(url: "https://github.com/krzysztofzablocki/KZFileWatchers.git", from: "1.1.0"),
// other dependencies
],
targets: [
.executableTarget(name: "YourApp", dependencies: [
.product(name: "KZFileWatchers", package: "KZFileWatchers"),
// other dependencies
]
]
)
```
## Author
Krzysztof Zabłocki, [email protected]
## Contributing
Contributions to KZFileWatchers are welcomed and encouraged! Please see the [Contributing guide](https://github.com/krzysztofzablocki/KZFileWatchers/blob/master/CONTRIBUTING.md).
[A list of contributors is available through GitHub.](https://github.com/krzysztofzablocki/KZFileWatchers/graphs/contributors)
To give clarity of what is expected of our members, KZFileWatchers has adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities. For more, see the [Code of Conduct](https://github.com/krzysztofzablocki/KZFileWatchers/blob/master/CODE_OF_CONDUCT.md).
## License
KZFileWatchers is available under the MIT license. See [LICENSE](https://github.com/krzysztofzablocki/KZFileWatchers/blob/master/LICENSE) for more information.