xxxbrian / zig-compile-commands

zig compile_commands.json

A simple zig module to generate compile_commands.json from a slice of build targets.

Relies on static variables to store the targets, so that the make step can access them.

Example Usage

First, build.zig.zon:

.{
    .name = "your-project",
    .version = "0.0.0",

    .dependencies = .{
        .compile_commands = .{
            .url = "https://github.com/xxxbrian/zig-compile-commands/archive/77df837b2b13bd3d15ee00de07a1b8f6cb840c69.tar.gz",
            .hash = "12205f1bd27373077104440e39cbc388b2ebbc8938378cc261506588feed29fedf35",
        },
    }
}

Then, bring that into your build.zig:

// import the dependency
const zcc = @import("compile_commands");

pub fn build(b: *std.Build) !void {
    // make a list of targets that have include files and c source files
    var targets = std.ArrayList(*std.Build.CompileStep).init(b.allocator);

    // create your executable
    const exe = b.addExecutable(.{
        .name = app_name,
        .optimize = mode,
        .target = target,
    });
    // keep track of it, so later we can pass it to compile_commands
    targets.append(exe) catch @panic("OOM");
    // maybe some other targets, too?
    targets.append(exe_2) catch @panic("OOM");
    targets.append(lib) catch @panic("OOM");

    // add a step called "zcc" (Compile commands DataBase) for making
    // compile_commands.json. could be named anything. cdb is just quick to type
    zcc.createStep(b, "zcc", .{ .targets = compiles.toOwnedSlice() catch @panic("OOM") });
}

And you're all done. Just run zig build zcc to generate the compile_commands.json file according to your current build graph.