Initial commit

Author: Hanaasagi

.github/workflows/ci.yaml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Tests on Linux
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: goto-bus-stop/setup-zig@v2
+      - uses: Hanaasagi/[email protected]
+        with:
+          cache-on-failure: true
+      - run: zig version
+      - run: zig env
+      - name: Build
+        run: zig build --verbose
+      - name: Run Tests
+        run: zig build test

.gitignore

@@ -0,0 +1,2 @@
+**/zig-out/
+**/zig-cache/

README.md

@@ -0,0 +1 @@
+# zig-project-template

build.zig

@@ -0,0 +1,47 @@
+const std = @import("std");
+
+// 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 lib = b.addStaticLibrary(.{
+        .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" },
+        .target = target,
+        .optimize = optimize,
+    });
+
+    // 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);
+
+    // 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" },
+        .target = target,
+        .optimize = optimize,
+    });
+
+    const run_main_tests = b.addRunArtifact(main_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);
+}

build.zig.zon

@@ -0,0 +1,5 @@
+.{
+    .name = "zig-project-template",
+    .version = "0.1.0",
+    .dependencies = .{},
+}

examples/build.zig

@@ -0,0 +1,39 @@
+const std = @import("std");
+
+const pkg_name = "zig-project-template";
+const pkg_path = "../src/lib.zig";
+
+const examples = .{
+    "default",
+};
+
+pub fn build(b: *std.build.Builder) void {
+    const target = b.standardTargetOptions(.{});
+    const optimize = b.standardOptimizeOption(.{});
+
+    inline for (examples) |e| {
+        const example_path = e ++ "/main.zig";
+        const exe_name = "example-" ++ e;
+        const run_name = "run-" ++ e;
+        const run_desc = "Run the " ++ e ++ " example";
+
+        const exe = b.addExecutable(.{
+            .name = exe_name,
+            .root_source_file = .{ .path = example_path },
+            .target = target,
+            .optimize = optimize,
+        });
+        const mod = b.addModule("zig-project-template", .{
+            .source_file = .{ .path = "../src/lib.zig" },
+        });
+        exe.addModule("zig-project-template", mod);
+
+        b.installArtifact(exe);
+
+        const run_cmd = b.addRunArtifact(exe);
+
+        run_cmd.step.dependOn(b.getInstallStep());
+        const run_step = b.step(run_name, run_desc);
+        run_step.dependOn(&run_cmd.step);
+    }
+}

examples/default/main.zig

@@ -0,0 +1,5 @@
+const std = @import("std");
+
+pub fn main() !void {
+    std.debug.print("Hello  World!\n", .{});
+}

src/lib.zig

@@ -0,0 +1,10 @@
+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);
+}