ZON.zigDocument-Based ZON Library

Read, write, and manipulate ZON files — complementary to std.zon

Get Started

API Reference

View on GitHub

📄

Document-Based API

Maintains an in-memory document tree for editing and manipulation, unlike std.zon which parses into typed structures.

🔧

Full ZON Support

Supports all ZON types including identifiers (.name = .value), large hex numbers, arrays, and nested objects.

🔍

Find & Replace

Search for values across your document and replace them with a single function call.

🔄

Merge & Clone

Deep clone documents and merge configurations together for environment-specific setups.

🎨

Pretty Print

Configurable output formatting with custom indentation levels or compact output.

⚡

Custom Parser

Does NOT depend on std.zig.Ast or compiler internals. Provides diagnostic error reporting with line/column tracking.

🌐

JSON Interoperability

Import from and Export to standard JSON seamlessly. Ideal for data transformation and cross-tooling.

🛡️

Integrity Suite

Stable order-independent hashing and cryptographic checksums for document validation.

🏗️

Flatten & Expand

Convert nested configurations to flat maps for environment overrides and simplified summaries.

Quick Start

zig

const std = @import("std");
const zon = @import("zon");

pub fn main() !void {
    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
    defer _ = gpa.deinit();
    const allocator = gpa.allocator();

    zon.disableUpdateCheck();

    var doc = zon.create(allocator);
    defer doc.deinit();

    try doc.setIdentifier("name", "my_app");
    try doc.setString("version", "1.0.0");
    try doc.setInt("port", 8080);
    try doc.setString("database.host", "localhost");

    try doc.saveAs("config.zon");
}

Output (config.zon):

zig

.{
    .database = .{
        .host = "localhost",
    },
    .name = .my_app,
    .port = 8080,
    .version = "1.0.0",
}

Installation

bash

zig fetch --save https://github.com/muhammad-fiaz/zon.zig/archive/refs/tags/0.0.3.tar.gz

Then in your build.zig:

zig

const zon_dep = b.dependency("zon", .{
    .target = target,
    .optimize = optimize,
});
exe.root_module.addImport("zon", zon_dep.module("zon"));

License

MIT License - View on GitHub