From 7bdcbfd6f51cb1bcaee4fbc2b5e84099e46fbc0a Mon Sep 17 00:00:00 2001 From: Rekai Musuka Date: Wed, 3 Jul 2024 18:30:07 -0500 Subject: [PATCH] feat: update to Zig v0.13.0 --- .gitignore | 3 ++- build.zig | 25 ++++++++++---------- build.zig.zon | 65 +++++++++++++++++++++++++++++++++++++++++++++++++-- 3 files changed, 78 insertions(+), 15 deletions(-) diff --git a/.gitignore b/.gitignore index c003a68..c9173bc 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +.zig-cache/ zig-cache/ zig-out/ -.vscode/ \ No newline at end of file +.vscode/ diff --git a/build.zig b/build.zig index e78946a..392714a 100644 --- a/build.zig +++ b/build.zig @@ -15,13 +15,13 @@ pub fn build(b: *std.Build) void { // set a preferred release mode, allowing the user to decide how to optimize. const optimize = b.standardOptimizeOption(.{}); - const mod = b.addModule("hamt", .{ .root_source_file = .{ .path = "src/lib.zig" } }); + const mod = b.addModule("hamt", .{ .root_source_file = b.path("src/lib.zig") }); const lib = b.addStaticLibrary(.{ .name = "hamt", // 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 = b.path("src/lib.zig"), .target = target, .optimize = optimize, }); @@ -33,30 +33,31 @@ pub fn build(b: *std.Build) void { // Benchmark const bench = b.addExecutable(.{ - .name = "hamt-benchmark", - .root_source_file = .{ .path = "src/bench.zig" }, + .name = "hamt-bench", + .root_source_file = b.path("src/bench.zig"), .target = target, .optimize = .ReleaseFast, }); bench.root_module.addImport("hamt", mod); const bench_cmd = b.addRunArtifact(bench); + const bench_step = b.step("bench", "Run benchmark"); bench_step.dependOn(&bench_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/tests.zig" }, + const lib_unit_tests = b.addTest(.{ + .root_source_file = b.path("src/tests.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); + // 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); } diff --git a/build.zig.zon b/build.zig.zon index 46477fb..a80ca41 100644 --- a/build.zig.zon +++ b/build.zig.zon @@ -1,11 +1,72 @@ .{ + // This is the default name used by packages depending on this one. For + // example, when a user runs `zig fetch --save `, this field is used + // as the key in the `dependencies` table. Although the user can choose a + // different name, most users will stick with this provided value. + // + // It is redundant to include "zig" in this name because it is already + // within the Zig package namespace. .name = "hamt", + + // This is a [Semantic Version](https://semver.org/). + // In a future version of Zig it will be used for package deduplication. .version = "0.1.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 a `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", + + // // When this is set to `true`, a package is declared to be lazily + // // fetched. This makes the dependency only get fetched if it is + // // actually used. + // .lazy = false, + //}, + }, + + // 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. Only files listed here will remain on disk + // when using the zig package manager. As a rule of thumb, one should list + // files required for compilation plus any license(s). + // 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 = .{ "build.zig", "build.zig.zon", - "README.md", "src", + // For example... + //"LICENSE", + //"README.md", }, - .dependencies = .{}, }