Upgrade to Zig version 0.16.0 (#14)

Author: habedi

.github/workflows/docs.yml

@@ -1,4 +1,4 @@
-name: Publish API Documentation
+name: Publish API documentation
 
 on:
   workflow_dispatch:
@@ -17,23 +17,23 @@ jobs:
   deploy-docs:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout Repository
+      - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Install Zig
-        uses: goto-bus-stop/setup-zig@v2
-        with:
-          version: '0.15.2'
+      - name: Install Zig 0.16.0
+        run: |
+          curl -sSfL https://ziglang.org/download/0.16.0/zig-x86_64-linux-0.16.0.tar.xz | tar -xJ
+          echo "$PWD/zig-x86_64-linux-0.16.0" >> "$GITHUB_PATH"
 
-      - name: Install System Dependencies
+      - name: Install dependencies
         run: |
           sudo apt-get update
           sudo apt-get install -y make
 
-      - name: Generate Documentation
+      - name: Generate documentation
         run: make docs
 
-      - name: Deploy to GitHub Pages
+      - name: Deploy to GitHub pages
         uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/tests.yml

@@ -1,4 +1,4 @@
-name: Run Tests
+name: Run tests
 
 on:
   workflow_dispatch:
@@ -24,18 +24,18 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout Repository
+      - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Install Zig
-        uses: goto-bus-stop/setup-zig@v2
-        with:
-          version: '0.15.2'
+      - name: Install Zig 0.16.0
+        run: |
+          curl -sSfL https://ziglang.org/download/0.16.0/zig-x86_64-linux-0.16.0.tar.xz | tar -xJ
+          echo "$PWD/zig-x86_64-linux-0.16.0" >> "$GITHUB_PATH"
 
-      - name: Install Dependencies
+      - name: Install dependencies
         run: |
           sudo apt-get update
           sudo apt-get install -y make
 
-      - name: Run the Tests
+      - name: Run the tests
         run: make test

Makefile

@@ -1,7 +1,8 @@
 # ################################################################################
 # # Configuration and Variables
 # ################################################################################
-ZIG    ?= $(shell which zig || echo ~/.local/share/zig/0.15.1/zig)
+ZIG_LOCAL  := $(HOME)/.local/share/zig/0.16.0/zig
+ZIG        ?= $(shell test -x $(ZIG_LOCAL) && echo $(ZIG_LOCAL) || which zig)
 BUILD_TYPE    ?= Debug
 BUILD_OPTS      = -Doptimize=$(BUILD_TYPE)
 JOBS          ?= $(shell nproc || echo 2)

README.md

@@ -7,7 +7,7 @@
 <h2>Chilli</h2>
 
 [![Tests](https://img.shields.io/github/actions/workflow/status/CogitatorTech/chilli/tests.yml?label=tests&style=flat&labelColor=282c34&logo=github)](https://github.com/CogitatorTech/chilli/actions/workflows/tests.yml)
-[![Zig Version](https://img.shields.io/badge/Zig-0.15.2-orange?logo=zig&labelColor=282c34)](https://ziglang.org/download)
+[![Zig Version](https://img.shields.io/badge/Zig-0.16.0-orange?logo=zig&labelColor=282c34)](https://ziglang.org/download)
 [![Docs](https://img.shields.io/badge/docs-read-blue?style=flat&labelColor=282c34&logo=read-the-docs)](https://CogitatorTech.github.io/chilli)
 [![Examples](https://img.shields.io/badge/examples-view-green?style=flat&labelColor=282c34&logo=zig)](https://github.com/CogitatorTech/chilli/tree/main/examples)
 [![Release](https://img.shields.io/github/release/CogitatorTech/chilli.svg?label=release&style=flat&labelColor=282c34&logo=github)](https://github.com/CogitatorTech/chilli/releases/latest)
@@ -104,16 +104,16 @@ fn greet(ctx: chilli.CommandContext) !void {
     const name = try ctx.getFlag("name", []const u8);
     const excitement = try ctx.getFlag("excitement", u32);
 
-    std.print("Hello, {s}", .{name});
+    std.debug.print("Hello, {s}", .{name});
     var i: u32 = 0;
     while (i < excitement) : (i += 1) {
-        std.print("!", .{});
+        std.debug.print("!", .{});
     }
-    std.print("\n", .{});
+    std.debug.print("\n", .{});
 }
 
-pub fn main() anyerror!void {
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
+pub fn main(init: std.process.Init.Minimal) anyerror!void {
+    var gpa: std.heap.DebugAllocator(.{}) = .init;
     defer _ = gpa.deinit();
     const allocator = gpa.allocator();
 
@@ -142,15 +142,15 @@ pub fn main() anyerror!void {
     });
 
     // Hand control over to the framework
-    try root_cmd.run(null);
+    try root_cmd.run(init.args, null);
 }
 ```
 
 You can now run your CLI application with the `--help` flag to see the output below:
 
 ```bash
 $ ./your-cli-app --help
-your-cli-app v0.2.3
+your-cli-app v0.3.0
 A new CLI built with Chilli
 
 USAGE:

build.zig

@@ -62,17 +62,18 @@ pub fn build(b: *std.Build) void {
 
     // --- Example Setup ---
     const examples_path = "examples";
+    const io = b.graph.io;
     examples_blk: {
         // If the examples directory isn't present (common when used as a dependency),
         // skip setting up example artifacts instead of panicking.
-        var examples_dir = fs.cwd().openDir(examples_path, .{ .iterate = true }) catch |err| {
+        var examples_dir = b.build_root.handle.openDir(io, examples_path, .{ .iterate = true }) catch |err| {
             if (err == error.FileNotFound or err == error.NotDir) break :examples_blk;
             @panic("Can't open 'examples' directory");
         };
-        defer examples_dir.close();
+        defer examples_dir.close(io);
 
         var dir_iter = examples_dir.iterate();
-        while (dir_iter.next() catch @panic("Failed to iterate examples")) |entry| {
+        while (dir_iter.next(io) catch @panic("Failed to iterate examples")) |entry| {
             if (!std.mem.endsWith(u8, entry.name, ".zig")) continue;
 
             const exe_name = fs.path.stem(entry.name);

build.zig.zon

@@ -1,8 +1,8 @@
 .{
     .name = .chilli,
-    .version = "0.2.3",
+    .version = "0.3.0",
     .fingerprint = 0x6c259741ae4f5f73, // Changing this has security and trust implications.
-    .minimum_zig_version = "0.15.2",
+    .minimum_zig_version = "0.16.0",
     .paths = .{
         "build.zig",
         "build.zig.zon",

examples/e1_simple_cli.zig

@@ -5,8 +5,8 @@ const AppContext = struct {
     config_path: []const u8,
 };
 
-pub fn main() anyerror!void {
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
+pub fn main(init: std.process.Init.Minimal) anyerror!void {
+    var gpa: std.heap.DebugAllocator(.{}) = .init;
     defer _ = gpa.deinit();
     const allocator = gpa.allocator();
 
@@ -54,13 +54,17 @@ pub fn main() anyerror!void {
         .variadic = true,
     });
 
-    try root_command.run(&app_context);
+    try root_command.run(init.args, &app_context);
 }
 
 fn rootExec(ctx: chilli.CommandContext) anyerror!void {
     const app_ctx = ctx.getContextData(AppContext).?;
     const config_slice = try ctx.getFlag("config", []const u8);
-    const stdout = std.fs.File.stdout().deprecatedWriter();
+    const io = std.Options.debug_io;
+    var stdout_buf: [4096]u8 = undefined;
+    var stdout_fw = std.Io.File.stdout().writer(io, &stdout_buf);
+    defer stdout_fw.flush() catch {};
+    const stdout = &stdout_fw.interface;
 
     if (app_ctx.config_path.len > 0) {
         ctx.app_allocator.free(app_ctx.config_path);
@@ -75,7 +79,11 @@ fn rootExec(ctx: chilli.CommandContext) anyerror!void {
 fn runExec(ctx: chilli.CommandContext) anyerror!void {
     const task_name = try ctx.getArg("task-name", []const u8);
     const files = ctx.getArgs("files");
-    const stdout = std.fs.File.stdout().deprecatedWriter();
+    const io = std.Options.debug_io;
+    var stdout_buf: [4096]u8 = undefined;
+    var stdout_fw = std.Io.File.stdout().writer(io, &stdout_buf);
+    defer stdout_fw.flush() catch {};
+    const stdout = &stdout_fw.interface;
 
     try stdout.print("Running task '{s}'...\n", .{task_name});
 

examples/e2_nested_commands.zig

@@ -7,18 +7,26 @@ fn rootExec(ctx: chilli.CommandContext) !void {
 
 fn dbMigrateExec(ctx: chilli.CommandContext) !void {
     _ = ctx;
-    const stdout = std.fs.File.stdout().deprecatedWriter();
+    const io = std.Options.debug_io;
+    var stdout_buf: [4096]u8 = undefined;
+    var stdout_fw = std.Io.File.stdout().writer(io, &stdout_buf);
+    defer stdout_fw.flush() catch {};
+    const stdout = &stdout_fw.interface;
     try stdout.print("Running database migrations...\n", .{});
 }
 
 fn dbSeedExec(ctx: chilli.CommandContext) !void {
     const file = try ctx.getArg("file", []const u8);
-    const stdout = std.fs.File.stdout().deprecatedWriter();
+    const io = std.Options.debug_io;
+    var stdout_buf: [4096]u8 = undefined;
+    var stdout_fw = std.Io.File.stdout().writer(io, &stdout_buf);
+    defer stdout_fw.flush() catch {};
+    const stdout = &stdout_fw.interface;
     try stdout.print("Seeding database from file: {s}\n", .{file});
 }
 
-pub fn main() anyerror!void {
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
+pub fn main(init: std.process.Init.Minimal) anyerror!void {
+    var gpa: std.heap.DebugAllocator(.{}) = .init;
     defer _ = gpa.deinit();
     const allocator = gpa.allocator();
 
@@ -56,7 +64,7 @@ pub fn main() anyerror!void {
         .is_required = true,
     });
 
-    try root_cmd.run(null);
+    try root_cmd.run(init.args, null);
 }
 
 // Example Invocations

examples/e3_help_output.zig

@@ -6,7 +6,7 @@ fn dummyExec(ctx: chilli.CommandContext) !void {
 }
 
 pub fn main() anyerror!void {
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
+    var gpa: std.heap.DebugAllocator(.{}) = .init;
     defer _ = gpa.deinit();
     const allocator = gpa.allocator();
 

examples/e4_custom_sections.zig

@@ -5,8 +5,8 @@ fn dummyExec(ctx: chilli.CommandContext) !void {
     try ctx.command.printHelp();
 }
 
-pub fn main() anyerror!void {
-    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
+pub fn main(init: std.process.Init.Minimal) anyerror!void {
+    var gpa: std.heap.DebugAllocator(.{}) = .init;
     defer _ = gpa.deinit();
     const allocator = gpa.allocator();
 
@@ -56,7 +56,7 @@ pub fn main() anyerror!void {
     });
     try root_cmd.addSubcommand(cmd_other);
 
-    try root_cmd.run(null);
+    try root_cmd.run(init.args, null);
 }
 
 // Example Invocation