chore: update to Zig v0.14.0

Author: tensorush

.gitattributes

@@ -1,2 +1,3 @@
+# Zig recommends LF line endings
 *.zig text eol=lf
 *.zon text eol=lf

.github/workflows/cd.yaml

@@ -9,6 +9,8 @@ on:
 
 jobs:
   emit:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+
     runs-on: ubuntu-latest
 
     steps:
@@ -17,14 +19,16 @@ jobs:
 
       - name: Set up Zig
         uses: mlugg/setup-zig@v1
+        with:
+          version: master
 
-      - name: Run `doc`
+      - name: Run doc step
         run: zig build doc
 
       - name: Upload artifact for GitHub Pages
         uses: actions/upload-pages-artifact@v3
         with:
-          path: zig-out/doc/
+          path: zig-out/docs/
 
   deploy:
     needs: emit

.github/workflows/ci.yaml

@@ -19,8 +19,10 @@ jobs:
 
       - name: Set up Zig
         uses: mlugg/setup-zig@v1
+        with:
+          version: master
 
-      - name: Run `example`
+      - name: Run example step
         run: zig build example
 
   fmt:
@@ -32,6 +34,8 @@ jobs:
 
       - name: Set up Zig
         uses: mlugg/setup-zig@v1
+        with:
+          version: master
 
-      - name: Run `fmt`
+      - name: Run fmt step
         run: zig build fmt

.gitignore

@@ -1,2 +1,3 @@
+# Zig artifacts
 .zig-cache/
 zig-out/

README.md

@@ -1,18 +1,13 @@
 # zig-quickphf
 
-[![CI][ci-shd]][ci-url]
-[![CD][cd-shd]][cd-url]
-[![DC][dc-shd]][dc-url]
-[![LC][lc-shd]][lc-url]
-
 ## Zig port of [quickphf library](https://github.com/dtrifuno/quickphf) for static hash map generation.
 
 ### Usage
 
 - Add `quickphf` dependency to `build.zig.zon`.
 
 ```sh
-zig fetch --save git+https://github.com/tensorush/zig-quickphf#<git_tag_or_commit_hash>
+zig fetch --save git+https://github.com/tensorush/zig-quickphf
 ```
 
 - Use `quickphf` dependency in `build.zig`.
@@ -25,14 +20,3 @@ const quickphf_dep = b.dependency("quickphf", .{
 const quickphf_mod = quickphf_dep.module("quickphf");
 <compile>.root_module.addImport("quickphf", quickphf_mod);
 ```
-
-<!-- MARKDOWN LINKS -->
-
-[ci-shd]: https://img.shields.io/github/actions/workflow/status/tensorush/zig-quickphf/ci.yaml?branch=main&style=for-the-badge&logo=github&label=CI&labelColor=black
-[ci-url]: https://github.com/tensorush/zig-quickphf/blob/main/.github/workflows/ci.yaml
-[cd-shd]: https://img.shields.io/github/actions/workflow/status/tensorush/zig-quickphf/cd.yaml?branch=main&style=for-the-badge&logo=github&label=CD&labelColor=black
-[cd-url]: https://github.com/tensorush/zig-quickphf/blob/main/.github/workflows/cd.yaml
-[dc-shd]: https://img.shields.io/badge/click-F6A516?style=for-the-badge&logo=zig&logoColor=F6A516&label=docs&labelColor=black
-[dc-url]: https://tensorush.github.io/zig-quickphf
-[lc-shd]: https://img.shields.io/github/license/tensorush/zig-quickphf.svg?style=for-the-badge&labelColor=black
-[lc-url]: https://github.com/tensorush/zig-quickphf/blob/main/LICENSE

build.zig

@@ -1,78 +1,75 @@
 const std = @import("std");
 
 pub fn build(b: *std.Build) void {
+    const install_step = b.getInstallStep();
     const target = b.standardTargetOptions(.{});
     const optimize = b.standardOptimizeOption(.{});
-    const root_source_file = b.path("src/lib.zig");
-    const version = std.SemanticVersion{ .major = 0, .minor = 2, .patch = 0 };
+    const root_source_file = b.path("src/root.zig");
+    const version = std.SemanticVersion{ .major = 0, .minor = 1, .patch = 1 };
 
     // Module
-    const quickphf_mod = b.addModule("quickphf", .{ .root_source_file = root_source_file });
+    const mod = b.addModule("quickphf", .{
+        .target = target,
+        .optimize = optimize,
+        .root_source_file = root_source_file,
+    });
 
     // Library
     const lib_step = b.step("lib", "Install library");
 
-    const lib = b.addStaticLibrary(.{
+    const lib = b.addLibrary(.{
         .name = "quickphf",
-        .target = target,
         .version = version,
-        .optimize = optimize,
-        .root_source_file = root_source_file,
+        .root_module = mod,
     });
 
     const lib_install = b.addInstallArtifact(lib, .{});
     lib_step.dependOn(&lib_install.step);
-    b.default_step.dependOn(lib_step);
+    install_step.dependOn(lib_step);
 
     // Documentation
-    const doc_step = b.step("doc", "Emit documentation");
-
-    const doc_install = b.addInstallDirectory(.{
+    const docs_step = b.step("doc", "Emit documentation");
+    const docs_install = b.addInstallDirectory(.{
         .install_dir = .prefix,
-        .install_subdir = "doc",
+        .install_subdir = "docs",
         .source_dir = lib.getEmittedDocs(),
     });
-    doc_step.dependOn(&doc_install.step);
-    b.default_step.dependOn(doc_step);
+    docs_step.dependOn(&docs_install.step);
+    install_step.dependOn(docs_step);
 
     // Example
     const example_step = b.step("example", "Run example");
 
     const example = b.addExecutable(.{
         .name = "example",
-        .target = target,
         .version = version,
-        .optimize = optimize,
-        .root_source_file = b.path(EXAMPLE_DIR ++ "main.zig"),
+        .root_module = b.createModule(.{
+            .target = target,
+            .optimize = optimize,
+            .root_source_file = b.path(EXAMPLE_DIR ++ "main.zig"),
+        }),
     });
-    example.root_module.addImport("quickphf", quickphf_mod);
+    example.root_module.addImport("quickphf", mod);
 
     const example_run = b.addRunArtifact(example);
+    example_step.dependOn(&example_run.step);
 
-    const example_test = b.addTest(.{
-        .target = target,
-        .root_source_file = b.path(EXAMPLE_DIR ++ "test.zig"),
-    });
-    example_test.root_module.addImport("quickphf", quickphf_mod);
-    example_test.step.dependOn(&example_run.step);
-
-    const example_test_run = b.addRunArtifact(example_test);
-    example_step.dependOn(&example_test_run.step);
-    b.default_step.dependOn(example_step);
+    install_step.dependOn(example_step);
 
-    // Formatting checks
-    const fmt_step = b.step("fmt", "Run formatting checks");
+    // Formatting check
+    const fmt_step = b.step("fmt", "Check formatting");
 
     const fmt = b.addFmt(.{
         .paths = &.{
             "src/",
             "build.zig",
+            "build.zig.zon",
             EXAMPLE_DIR,
         },
         .check = true,
     });
     fmt_step.dependOn(&fmt.step);
-    b.default_step.dependOn(fmt_step);
+    install_step.dependOn(fmt_step);
 }
 
 const EXAMPLE_DIR = "example/";

build.zig.zon

@@ -1,6 +1,7 @@
 .{
-    .name = "quickphf",
-    .version = "0.2.0",
+    .name = .quickphf,
+    .fingerprint = 0xfbc2df748cb26bb1,
+    .version = "0.2.1",
     .paths = .{
         "src/",
         "example/",

src/quickdiv.zig

@@ -1,7 +1,6 @@
-//! Unsigned divisor optimized for repeated division and modulo operations.
-
 const std = @import("std");
 
+/// Unsigned divisor optimized for repeated division and modulo operations.
 pub fn Divisor(comptime T: type) type {
     if (std.meta.activeTag(@typeInfo(T)) != .int or
         @typeInfo(T).int.signedness != .unsigned or

src/lib.zig renamed to src/root.zig

@@ -1,4 +1,4 @@
-//! Root library file that exposes the public API.
+//! Root source file that exposes the library's API to users and Autodoc.
 
 const std = @import("std");