Options

Build-time options with type-safe defaults.

Functions

boolOption

pub fn boolOption(b: *std.Build, name: []const u8, description: []const u8, default: bool) bool

const debug = buildx.boolOption(b, "debug", "Enable debug mode", false);
// zig build -Ddebug=true

stringOption

pub fn stringOption(b: *std.Build, name: []const u8, description: []const u8, default: []const u8) []const u8

const version = buildx.stringOption(b, "version", "App version", "1.0.0");
// zig build -Dversion=2.0.0

option (generic)

pub fn option(b: *std.Build, comptime T: type, name: []const u8, description: []const u8) ?T

const port = buildx.option(b, u16, "port", "Server port");
// Returns null if not specified, otherwise the value

optionWithDefault

pub fn optionWithDefault(b: *std.Build, comptime T: type, name: []const u8, description: []const u8, default: T) T

const count = buildx.optionWithDefault(b, u32, "count", "Item count", 10);

enumOption

pub fn enumOption(b: *std.Build, comptime T: type, name: []const u8, description: []const u8) ?T

const Mode = enum { debug, release, perf };
const mode = buildx.enumOption(b, Mode, "mode", "Build mode");

intOption

pub fn intOption(b: *std.Build, comptime T: type, name: []const u8, description: []const u8) ?T

floatOption

pub fn floatOption(b: *std.Build, comptime T: type, name: []const u8, description: []const u8) ?T

pathOption

pub fn pathOption(b: *std.Build, name: []const u8, description: []const u8) ?Build.LazyPath