https://github.com/gradle/gradle-fileevents

Native bindings for file-system watching
https://github.com/gradle/gradle-fileevents

Last synced: about 1 month ago
JSON representation

Native bindings for file-system watching

• Host: GitHub
• URL: https://github.com/gradle/gradle-fileevents
• Owner: gradle
• License: apache-2.0
• Created: 2024-08-19T15:51:43.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-09-11T08:58:53.000Z (2 months ago)
• Last Synced: 2024-09-26T12:41:15.198Z (about 2 months ago)
• Language: Groovy
• Size: 339 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Gradle File Events Library

[![Build Gradle project](https://github.com/gradle/gradle-fileevents/actions/workflows/build.yaml/badge.svg)](https://github.com/gradle/gradle-fileevents/actions/workflows/build.yaml)

A cross-platform library to watch for changes on the file-system.

### Supported platforms

- macOS – `x86_64` (tested on 13 and 14) and `aarch64` (untested)

- Linux – `x86_64`(tested on Ubuntu 20.04 and 24.04) and `aarch64` (untested)

- Windows – `x86_64` (tested on Windows 2019 and 2022) and `aarch64` (untested)

## Building

The project uses [Gradle](https://gradle.org/) to build the final library. Under the hood it

utilizes [Zig](https://ziglang.org/) to cross-compile the C/C++ code.

### Prerequisites

- [JDK 17](https://adoptopenjdk.net/)

- [Zig nightly](https://ziglang.org/download/) (tested on `0.14.0-dev.1224+16d74809d`)

The project currently requires macOS to link to the SDK. It also depends on JDK to be specifically for Darwin. Both of

these limitations should be removable with some legwork in the future.

### Running the build

```shell

./gradlew assemble

```

This should produce a `build/libs/gradle-fileevents.jar` file that contains everything.

### Testing

To run tests with the library built locally:

```shell

./gradlew test

```

To run tests with the library built on another machine, place the JAR in `build/remote/gradle-fileevents.jar`:

```shell

./gradlew externalTest

```