https://github.com/nextjournal/beholder

The Clojure directory watcher from Krell as a standalone library.
https://github.com/nextjournal/beholder

clojure directory-watcher

Last synced: 6 days ago
JSON representation

The Clojure directory watcher from Krell as a standalone library.

• Host: GitHub
• URL: https://github.com/nextjournal/beholder
• Owner: nextjournal
• License: epl-1.0
• Created: 2021-03-17T09:15:30.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-02-04T22:56:28.000Z (about 1 year ago)
• Last Synced: 2025-01-25T18:08:39.051Z (14 days ago)
• Topics: clojure, directory-watcher
• Language: Clojure
• Homepage:
• Size: 21.5 KB
• Stars: 118
• Watchers: 5
• Forks: 7
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Beholder

[![Clojars Project](https://img.shields.io/clojars/v/com.nextjournal/beholder.svg)](https://clojars.org/com.nextjournal/beholder)

The Clojure directory watcher from

[krell](https://github.com/vouch-opensource/krell/) as a standalone

library.

![Beholder Logo](https://cdn.nextjournal.com/data/QmWMRZdwLqn9Ynt8JAxvNF9eWi3HF4c3UcT9vSXVSBS7Wi?filename=beholder.jpg&content-type=image/jpeg)

Built using the Java library

[directory-watcher](https://github.com/gmethvin/directory-watcher).

From its README:

> A directory watcher utility for JDK 8+ that aims to provide accurate

> and efficient recursive watching for Linux, macOS and Windows. In

> particular, this library provides a JNA-based WatchService for Mac

> OS X to replace the default polling-based JDK implementation.

>

> The core directory-watcher library is designed to have minimal

> dependencies; currently it only depends on slf4j-api (for internal

> logging, which can be disabled by passing a NOPLogger in the

> builder) and jna (for the macOS watcher implementation).

Initial development by [David Nolen](https://github.com/swannodette).

## Usage

Pass a callback function and paths to `watch`.

```clojure

(require '[nextjournal.beholder :as beholder])

(def watcher

  (beholder/watch prn "src"))

(beholder/stop watcher)

```

Whenever a file changes, your callback function will be invoked with a

map with `:type` and `:path` keys. Possible values for `:type` are

`:create`, `:modify`, `:delete` or `:overflow`.

## License

Copyright © 2021 Nextjournal

Distributed under the EPL-1.0 License.