From 0d61cc7d5fadc5522bc982aa35b85153ebfb94cb Mon Sep 17 00:00:00 2001 From: Hanaasagi Date: Wed, 6 Dec 2023 18:50:11 +0900 Subject: [PATCH] feat: new template --- build.zig | 62 +++++++++++++++++++++++++++++++++++++++++++-------- build.zig.zon | 61 ++++++++++++++++++++++++++++++++++++++++++++++++-- src/lib.zig | 10 --------- src/main.zig | 2 ++ src/root.zig | 1 + 5 files changed, 115 insertions(+), 21 deletions(-) delete mode 100644 src/lib.zig create mode 100644 src/main.zig create mode 100644 src/root.zig diff --git a/build.zig b/build.zig index f777e87..4b8b387 100644 --- a/build.zig +++ b/build.zig @@ -19,7 +19,7 @@ pub fn build(b: *std.Build) void { .name = "zig-project-template", // 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/lib.zig" }, + .root_source_file = .{ .path = "src/root.zig" }, .target = target, .optimize = optimize, }); @@ -29,19 +29,63 @@ pub fn build(b: *std.Build) void { // running `zig build`). b.installArtifact(lib); + const exe = b.addExecutable(.{ + .name = "zig-project-template", + .root_source_file = .{ .path = "src/main.zig" }, + .target = target, + .optimize = optimize, + }); + + // 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); + + // 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); + // Creates a step for unit testing. This only builds the test executable // but does not run it. - const main_tests = b.addTest(.{ - .root_source_file = .{ .path = "src/lib.zig" }, + const lib_unit_tests = b.addTest(.{ + .root_source_file = .{ .path = "src/root.zig" }, .target = target, .optimize = optimize, }); - const run_main_tests = b.addRunArtifact(main_tests); + const run_lib_unit_tests = b.addRunArtifact(lib_unit_tests); - // This creates a build step. It will be visible in the `zig build --help` menu, - // and can be selected like this: `zig build test` - // This will evaluate the `test` step rather than the default, which is "install". - const test_step = b.step("test", "Run library tests"); - test_step.dependOn(&run_main_tests.step); + const exe_unit_tests = b.addTest(.{ + .root_source_file = .{ .path = "src/main.zig" }, + .target = target, + .optimize = optimize, + }); + + 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_lib_unit_tests.step); + test_step.dependOn(&run_exe_unit_tests.step); } diff --git a/build.zig.zon b/build.zig.zon index 50bedb2..2ad7ddc 100644 --- a/build.zig.zon +++ b/build.zig.zon @@ -1,5 +1,62 @@ .{ .name = "zig-project-template", - .version = "0.1.0", - .dependencies = .{}, + // This is a [Semantic Version](https://semver.org/). + // In a future version of Zig it will be used for package deduplication. + .version = "0.0.0", + + // This field is optional. + // This is currently advisory only; Zig does not yet do anything + // with this value. + //.minimum_zig_version = "0.11.0", + + // This field is optional. + // Each dependency must either provide a `url` and `hash`, or a `path`. + // `zig build --fetch` can be used to fetch all dependencies of a package, recursively. + // Once all dependencies are fetched, `zig build` no longer requires + // Internet connectivity. + .dependencies = .{ + // See `zig fetch --save ` for a command-line interface for adding dependencies. + //.example = .{ + // // When updating this field to a new URL, be sure to delete the corresponding + // // `hash`, otherwise you are communicating that you expect to find the old hash at + // // the new URL. + // .url = "https://example.com/foo.tar.gz", + // + // // This is computed from the file contents of the directory of files that is + // // obtained after fetching `url` and applying the inclusion rules given by + // // `paths`. + // // + // // This field is the source of truth; packages do not come from an `url`; they + // // come from a `hash`. `url` is just one of many possible mirrors for how to + // // obtain a package matching this `hash`. + // // + // // Uses the [multihash](https://multiformats.io/multihash/) format. + // .hash = "...", + // + // // When this is provided, the package is found in a directory relative to the + // // build root. In this case the package's hash is irrelevant and therefore not + // // computed. This field and `url` are mutually exclusive. + // .path = "foo", + //}, + }, + + // Specifies the set of files and directories that are included in this package. + // Only files and directories listed here are included in the `hash` that + // is computed for this package. + // Paths are relative to the build root. Use the empty string (`""`) to refer to + // the build root itself. + // A directory listed here means that all files within, recursively, are included. + .paths = .{ + // This makes *all* files, recursively, included in this package. It is generally + // better to explicitly list the files and directories instead, to insure that + // fetching from tarballs, file system paths, and version control all result + // in the same contents hash. + "", + // For example... + //"build.zig", + //"build.zig.zon", + //"src", + //"LICENSE", + //"README.md", + }, } diff --git a/src/lib.zig b/src/lib.zig deleted file mode 100644 index ecfeade..0000000 --- a/src/lib.zig +++ /dev/null @@ -1,10 +0,0 @@ -const std = @import("std"); -const testing = std.testing; - -export fn add(a: i32, b: i32) i32 { - return a + b; -} - -test "basic add functionality" { - try testing.expect(add(3, 7) == 10); -} diff --git a/src/main.zig b/src/main.zig new file mode 100644 index 0000000..e715fde --- /dev/null +++ b/src/main.zig @@ -0,0 +1,2 @@ +pub fn main() void {} + diff --git a/src/root.zig b/src/root.zig new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/src/root.zig @@ -0,0 +1 @@ +