https://github.com/berkansasmaz/rfsnotify
A recursive file watcher package based on github.com/fsnotify/fsnotify
https://github.com/berkansasmaz/rfsnotify
Last synced: 3 months ago
JSON representation
A recursive file watcher package based on github.com/fsnotify/fsnotify
- Host: GitHub
- URL: https://github.com/berkansasmaz/rfsnotify
- Owner: berkansasmaz
- License: gpl-3.0
- Created: 2020-03-06T22:00:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-02T00:05:28.000Z (about 5 years ago)
- Last Synced: 2025-01-21T07:26:30.250Z (5 months ago)
- Language: Go
- Homepage:
- Size: 50.8 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# R-FSNotify
> This project is still under development and its API is not stable. Please use it with caution or wait until this message is removed and the first version is released.
A recursive file watcher package based on `github.com/fsnotify/fsnotify`.
Unfortunately, `fsnotify` does not have recursive watching capability, and you need to write your way to find all the sub-folders and files underneath and add them by using its `Add()` method.
R-FsNotify is the solution for that problem. It automatically watches all of your files under a directory.
### Warning
It is important to realize that this package is only for recursive file watcher. You can disable the recursive nature of this package. Hence, you can use github.com/fsnotify/fsnotify if you need a non-recursive watcher instead.
Since this package is still under development, the API surface may change as the new requirements come up. Therefore, until the first release is fully published, use this library with caution. [Feel free to contact me!](mailto:[email protected]?subject=Ketum&body=Hi,)
## Unit Tests
This project is covered by various unit tests in the `rfsnotify_test.go` file. My intention is to keep it 100% covered . In case you would like to create PR for this project, please make sure that your code does not reduce the test coverage score. However, I am aware of the fact that not everything can be unit-testable, but it is still a crucial practice to keep unit tests in mind while contributing to this project.
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/berkansasmaz/rfsnotify/issues). You can also take a look at the [contributing guide](https://dev.to/janessatran/a-beginner-s-guide-to-contributing-to-open-source-4fen).
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2020 [Berkan](https://github.com/berkansasmaz).
This project is [GPL3.O](https://github.com/berkansasmaz/rfsnotify/blob/master/LICENSE) licensed.