zigwebserver

Tools for writing web stuff in zig
Log | Files | Refs

build.zig (3504B)


      1 const std = @import("std");
      2 
      3 // Although this function looks imperative, note that its job is to
      4 // declaratively construct a build graph that will be executed by an external
      5 // runner.
      6 pub fn build(b: *std.Build) void {
      7     // Standard target options allows the person running `zig build` to choose
      8     // what target to build for. Here we do not override the defaults, which
      9     // means any target is allowed, and the default is native. Other options
     10     // for restricting supported target set are available.
     11     const target = b.standardTargetOptions(.{});
     12 
     13     // Standard optimization options allow the person running `zig build` to select
     14     // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. Here we do not
     15     // set a preferred release mode, allowing the user to decide how to optimize.
     16     const optimize = b.standardOptimizeOption(.{});
     17 
     18     const exe = b.addExecutable(.{
     19         .name = "zigwebserver-exe",
     20         // In this case the main source file is merely a path, however, in more
     21         // complicated build scripts, this could be a generated file.
     22         .root_source_file = b.path("src/main.zig"),
     23         .target = target,
     24         .optimize = optimize,
     25     });
     26 
     27     const lib = b.addStaticLibrary(.{
     28         .name = "zigwebserver",
     29         .root_source_file = b.path("src/zigwebserver.zig"),
     30         .target = target,
     31         .optimize = optimize,
     32     });
     33     b.installArtifact(lib);
     34 
     35     // for zig module system
     36     _ = b.addModule("zigwebserver", .{ .root_source_file = b.path("src/zigwebserver.zig") });
     37 
     38     // This declares intent for the executable to be installed into the
     39     // standard location when the user invokes the "install" step (the default
     40     // step when running `zig build`).
     41     b.installArtifact(exe);
     42 
     43     // This *creates* a Run step in the build graph, to be executed when another
     44     // step is evaluated that depends on it. The next line below will establish
     45     // such a dependency.
     46     const run_cmd = b.addRunArtifact(exe);
     47 
     48     // By making the run step depend on the install step, it will be run from the
     49     // installation directory rather than directly from within the cache directory.
     50     // This is not necessary, however, if the application depends on other installed
     51     // files, this ensures they will be present and in the expected location.
     52     run_cmd.step.dependOn(b.getInstallStep());
     53 
     54     // This allows the user to pass arguments to the application in the build
     55     // command itself, like this: `zig build run -- arg1 arg2 etc`
     56     if (b.args) |args| {
     57         run_cmd.addArgs(args);
     58     }
     59 
     60     // This creates a build step. It will be visible in the `zig build --help` menu,
     61     // and can be selected like this: `zig build run`
     62     // This will evaluate the `run` step rather than the default, which is "install".
     63     const run_step = b.step("run", "Run the app");
     64     run_step.dependOn(&run_cmd.step);
     65 
     66     // Creates a step for unit testing. This only builds the test executable
     67     // but does not run it.
     68     const unit_tests = b.addTest(.{
     69         .root_source_file = b.path("src/main.zig"),
     70         .target = target,
     71         .optimize = optimize,
     72     });
     73 
     74     const run_unit_tests = b.addRunArtifact(unit_tests);
     75 
     76     // Similar to creating the run step earlier, this exposes a `test` step to
     77     // the `zig build --help` menu, providing a way for the user to request
     78     // running the unit tests.
     79     const test_step = b.step("test", "Run unit tests");
     80     test_step.dependOn(&run_unit_tests.step);
     81 }