https://github.com/falsepattern/gradlezigbuild
A gradle plugin for integrating with the zig build system and zig toolchain management.
https://github.com/falsepattern/gradlezigbuild
gradle gradle-kotlin-dsl gradle-plugin gradle-zig zig ziglang
Last synced: 5 months ago
JSON representation
A gradle plugin for integrating with the zig build system and zig toolchain management.
- Host: GitHub
- URL: https://github.com/falsepattern/gradlezigbuild
- Owner: FalsePattern
- License: other
- Created: 2025-05-04T21:59:58.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-05-07T09:17:31.000Z (9 months ago)
- Last Synced: 2025-06-30T23:04:54.870Z (7 months ago)
- Topics: gradle, gradle-kotlin-dsl, gradle-plugin, gradle-zig, zig, ziglang
- Language: Kotlin
- Homepage: https://plugins.gradle.org/plugin/com.falsepattern.zigbuild
- Size: 97.7 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: COPYING
Awesome Lists containing this project
README
# Gradle ZigBuild
## Author: FalsePattern
## License: GNU LGPLv3.0-only
A gradle plugin that adds integration with zig toolchains, and preliminary integration with the zig build system.
## Setup
You can install the plugin by adding it in your build.gradle like so:
```kotlin
plugins {
id("com.falsepattern.zigbuild") version "VERSION_GOES_HERE"
}
```
The plugin also ships with a default repository for automatically downloading zig toolchains (`https://ziglang.org/download/`), however, you will need to add the above lines to
your settings.gradle too.
If you don't add it to your settings.gradle, ZigBuild will look for zig toolchains in your PATH, and the following well-known locations:
- Windows:
- `%LOCALAPPDATA%/zig`
- `%LOCALAPPDATA%/zigup`
- `%HOME%/.zig`
- Linux if XDG_DATA_HOME is set:
- `$XDG_DATA_HOME/zig`
- `$XDG_DATA_HOME/zigup`
- `~/.zig`
- Linux if XDG_DATA_HOME is not set:
- `~/.local/share/zig`
- `~/.local/share/zigup`
- `~/.zig`
- MacOS:
- `~/Library/zig`
- `~/Library/zigup`
- `~/.zig`
This is identical to the default toolchain search/installation logic of [ZigBrains](https://github.com/falsepattern/zigbrains), so this effectively just integrates
toolchain management with it.
If you want to disable this autodetection, you can set `scanSystem` inside the `zig` project extension to false:
```kotlin
zig {
scanSystem = false
}
```
Specific toolchains can also be acquired using `zig.compilerFor`. This compiler can be used as-is for `Exec` tasks, or
with some presets in the `ZigCompileTask` task.
For more information, you can check the `ZigBuild-test` subproject, which has a zig 0.14.0 example project hooked up to gradle.
## Special Thanks
A large part of this plugin is based on [ZigGradle](https://github.com/lukebemishprojects/ZigGradle) ported to kotlin, and heavily tweaked for better build.zig integration.