Init with the new step thing

src/init/build.zig

@@ -1,54 +1,96 @@
 const std = @import("std");
-
+const jetzig_build = @import("jetzig");
-pub fn build(b: *std.Build) !void {
+// Although this function looks imperative, note that its job is to
+// declaratively construct a build graph that will be executed by an external
+// runner.
+pub fn build(b: *std.Build) void {
+    // Standard target options allows the person running `zig build` to choose
+    // what target to build for. Here we do not override the defaults, which
+    // means any target is allowed, and the default is native. Other options
+    // for restricting supported target set are available.
     const target = b.standardTargetOptions(.{});
 
+    // Standard optimization options allow the person running `zig build` to select
+    // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. Here we do not
+    // set a preferred release mode, allowing the user to decide how to optimize.
     const optimize = b.standardOptimizeOption(.{});
+    const jetzig_dep = b.dependency("jetzig", .{ .optimize = optimize, .target = target });
+    const compile_view_step = jetzig_build.CompileViewsStep.create(b, .{ .template_path = "src/app/views/" });
 
-    const exe = b.addExecutable(.{
+    const lib = b.addStaticLibrary(.{
         .name = "%%project_name%%",
-        .root_source_file = .{ .path = "src/main.zig" },
+        // In this case the main source file is merely a path, however, in more
+        // complicated build scripts, this could be a generated file.
+        .root_source_file = .{ .path = "src/root.zig" },
         .target = target,
         .optimize = optimize,
     });
 
-    b.installArtifact(exe);
+    // This declares intent for the library to be installed into the standard
+    // location when the user invokes the "install" step (the default step when
+    // running `zig build`).
+    b.installArtifact(lib);
 
-    const jetzig = b.dependency("jetzig", .{ .optimize = optimize, .target = target });
+    const exe = b.addExecutable(.{
-    exe.addModule("jetzig", jetzig.module("jetzig"));
+        .name = "jetzig-demo",
-    try b.modules.put("jetzig", jetzig.module("jetzig"));
+        .root_source_file = .{ .path = "src/main.zig" },
-
-    const zmpl_dep = b.dependency(
-        "zmpl",
-        .{
         .target = target,
         .optimize = optimize,
-            .zmpl_templates_path = @as([]const u8, "src/app/views/"),
+    });
-            .zmpl_manifest_path = @as([]const u8, "src/app/views/zmpl.manifest.zig"),
+    exe.root_module.addImport("jetzig", jetzig_dep.module("jetzig"));
-        },
-    );
 
-    exe.addModule("zmpl", zmpl_dep.module("zmpl"));
+    exe.root_module.addImport("zmpl", jetzig_dep.module("zmpl"));
-    try b.modules.put("zmpl", zmpl_dep.module("zmpl"));
+    // This declares intent for the executable to be installed into the
+    // standard location when the user invokes the "install" step (the default
+    // step when running `zig build`).
+    b.installArtifact(exe);
+    exe.step.dependOn(&compile_view_step.step);
 
+    // This *creates* a Run step in the build graph, to be executed when another
+    // step is evaluated that depends on it. The next line below will establish
+    // such a dependency.
     const run_cmd = b.addRunArtifact(exe);
+
+    // By making the run step depend on the install step, it will be run from the
+    // installation directory rather than directly from within the cache directory.
+    // This is not necessary, however, if the application depends on other installed
+    // files, this ensures they will be present and in the expected location.
     run_cmd.step.dependOn(b.getInstallStep());
 
+    // This allows the user to pass arguments to the application in the build
+    // command itself, like this: `zig build run -- arg1 arg2 etc`
     if (b.args) |args| {
         run_cmd.addArgs(args);
     }
 
+    // This creates a build step. It will be visible in the `zig build --help` menu,
+    // and can be selected like this: `zig build run`
+    // This will evaluate the `run` step rather than the default, which is "install".
     const run_step = b.step("run", "Run the app");
     run_step.dependOn(&run_cmd.step);
 
-    const unit_tests = b.addTest(.{
+    // Creates a step for unit testing. This only builds the test executable
+    // but does not run it.
+    const lib_unit_tests = b.addTest(.{
+        .root_source_file = .{ .path = "src/root.zig" },
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const run_lib_unit_tests = b.addRunArtifact(lib_unit_tests);
+
+    const exe_unit_tests = b.addTest(.{
         .root_source_file = .{ .path = "src/main.zig" },
         .target = target,
         .optimize = optimize,
     });
 
-    const run_unit_tests = b.addRunArtifact(unit_tests);
+    const run_exe_unit_tests = b.addRunArtifact(exe_unit_tests);
 
+    // Similar to creating the run step earlier, this exposes a `test` step to
+    // the `zig build --help` menu, providing a way for the user to request
+    // running the unit tests.
     const test_step = b.step("test", "Run unit tests");
-    test_step.dependOn(&run_unit_tests.step);
+    test_step.dependOn(&run_lib_unit_tests.step);
+    test_step.dependOn(&run_exe_unit_tests.step);
 }

src/init/build.zig.zon

@@ -5,10 +5,6 @@
         .jetzig = .{
             .url = "https://github.com/jetzig-framework/jetzig/archive/refs/tags/dev.tar.gz",
         },
-        .zmpl = .{
-            .url = "https://github.com/jetzig-framework/zmpl/archive/refs/tags/0.0.1.tar.gz",
-            .hash = "12204256376f262a58935d66a2a0b41ac0447299b7e63a4c6ff160ddcef6572cd3c7",
-        },
     },
 
     .paths = .{