Merge branch 'zig-0.15'

Author: sam701

.github/workflows/build-and-test.yaml

@@ -1,44 +1,44 @@
 name: build-and-test
 on:
   push:
-    branches:
-      - main
   pull_request:
-    branches:
-      - main
+  schedule:
+    - cron: 0 4 * * *
+
+env:
+  zig_version: 0.15.1
 
 jobs:
-  test-linux:
+  build-and-test-linux:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: goto-bus-stop/setup-zig@v2
+      - uses: mlugg/setup-zig@v2
         with:
-          version: 0.14.1
+          version: ${{ env.zig_version }}
       - run: zig fmt --check *.zig src/*.zig
       - run: zig build
       - run: zig build test
-      - run: cd examples/standalone && zig build
       - run: zig build docs
       - name: Upload docs artifact
         if: github.ref == 'refs/heads/main' && github.event_name != 'schedule'
         uses: actions/upload-pages-artifact@v3
         with:
           path: ./zig-out/docs/
 
-  test-windows:
+  build-and-test-windows:
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: goto-bus-stop/setup-zig@v2
+      - uses: mlugg/setup-zig@v2
         with:
-          version: 0.14.1
+          version: ${{ env.zig_version }}
       - run: zig build
       - run: zig build test
 
   deploy-pages:
     runs-on: ubuntu-latest
-    needs: test-linux
+    needs: build-and-test-linux
     if: github.ref == 'refs/heads/main' && github.event_name != 'schedule'
     permissions:
       pages: write      # to deploy to Pages

README.md

@@ -73,9 +73,12 @@ fn run_server() !void {
 ### Using with the Zig package manager
 Add `cli` to your `build.zig.zon`
 ```
+# For zig 0.14.x
 zig fetch --save git+https://github.com/sam701/zig-cli
+
+# For zig master
+zig fetch --save git+https://github.com/sam701/zig-cli#zig-0.15
 ```
-See the [`standalone`](./examples/standalone) example in the `examples` folder.
 
 ## Printing help
 See [`simple.zig`](./examples/simple.zig)

build.zig

@@ -18,33 +18,45 @@ pub fn build(b: *std.Build) void {
     b.installArtifact(lib);
 
     const main_tests = b.addTest(.{
-        .root_source_file = b.path("src/tests.zig"),
-        .target = target,
-        .optimize = optimize,
+        .root_module = lib_mod,
     });
     const run_tests = b.addRunArtifact(main_tests);
     const test_step = b.step("test", "Run library tests");
     test_step.dependOn(&run_tests.step);
 
-    const simple = b.addExecutable(.{
-        .target = target,
-        .name = "simple",
-        .root_source_file = b.path("examples/simple.zig"),
-        .optimize = optimize,
-    });
-    simple.root_module.addImport("cli", lib_mod);
-    b.installArtifact(simple);
-    b.default_step.dependOn(&simple.step);
+    // Example simple
+    {
+        const simple_mod = b.addModule("simple", .{
+            .root_source_file = b.path("examples/simple.zig"),
+            .target = target,
+            .optimize = optimize,
+        });
 
-    const short = b.addExecutable(.{
-        .target = target,
-        .name = "short",
-        .root_source_file = b.path("examples/short.zig"),
-        .optimize = optimize,
-    });
-    short.root_module.addImport("cli", lib_mod);
-    b.installArtifact(short);
-    b.default_step.dependOn(&short.step);
+        const simple = b.addExecutable(.{
+            .name = "simple",
+            .root_module = simple_mod,
+        });
+        simple.root_module.addImport("cli", lib_mod);
+        b.installArtifact(simple);
+        b.default_step.dependOn(&simple.step);
+    }
+
+    // Examples short
+    {
+        const short_mod = b.addModule("simple", .{
+            .root_source_file = b.path("examples/short.zig"),
+            .target = target,
+            .optimize = optimize,
+        });
+
+        const short = b.addExecutable(.{
+            .name = "short",
+            .root_module = short_mod,
+        });
+        short.root_module.addImport("cli", lib_mod);
+        b.installArtifact(short);
+        b.default_step.dependOn(&short.step);
+    }
 
     // Docs
     {

build.zig.zon

@@ -1,6 +1,6 @@
 .{
     .name = .cli,
     .fingerprint = 0x48f6513cff9ee2d9,
-    .version = "0.9.0",
+    .version = "0.10.0",
     .paths = .{ "./src", "./build.zig", "./build.zig.zon" },
 }

examples/standalone/build.zig

@@ -3,48 +3,45 @@ const command = @import("./command.zig");
 
 const Self = @This();
 
-out: std.fs.File.Writer,
+writer: *std.Io.Writer,
 use_color: bool,
 
 const color_clear = "0";
 
-pub fn init(file: std.fs.File, color: command.ColorUsage) Self {
+pub fn init(writer: *std.Io.Writer, use_color: bool) Self {
     return .{
-        .out = file.writer(),
-        .use_color = switch (color) {
-            .always => true,
-            .never => false,
-            .auto => std.posix.isatty(file.handle),
-        },
+        .writer = writer,
+        .use_color = use_color,
     };
 }
 
-pub inline fn write(self: *const Self, text: []const u8) void {
-    _ = self.out.write(text) catch unreachable;
+pub fn flush(self: *Self) void {
+    self.writer.flush() catch unreachable;
 }
 
-pub inline fn printNewLine(self: *const Self) void {
-    self.write("\n");
+pub inline fn write(self: *Self, text: []const u8) void {
+    _ = self.writer.writeAll(text) catch unreachable;
 }
 
-pub inline fn format(self: *const Self, comptime text: []const u8, args: anytype) void {
-    std.fmt.format(self.out, text, args) catch unreachable;
+pub inline fn printNewLine(self: *Self) void {
+    self.writer.writeByte('\n') catch unreachable;
 }
 
-pub inline fn printColor(self: *const Self, color: []const u8) void {
+pub inline fn format(self: *Self, comptime fmt: []const u8, args: anytype) void {
+    self.writer.print(fmt, args) catch unreachable;
+}
+
+pub inline fn printColor(self: *Self, color: []const u8) void {
     if (self.use_color)
         self.format("{c}[{s}m", .{ 0x1b, color });
 }
 
-pub inline fn printInColor(self: *const Self, color: []const u8, text: []const u8) void {
+pub inline fn printInColor(self: *Self, color: []const u8, text: []const u8) void {
     self.printColor(color);
     self.write(text);
     self.printColor(color_clear);
 }
 
-pub inline fn printSpaces(self: *const Self, cnt: usize) void {
-    var i: usize = 0;
-    while (i < cnt) : (i += 1) {
-        self.write(" ");
-    }
+pub inline fn printSpaces(self: *Self, cnt: usize) void {
+    self.writer.splatByteAll(' ', cnt) catch unreachable;
 }

examples/standalone/build.zig.zon

@@ -50,7 +50,7 @@ pub const AppRunner = struct {
         return self.allocSlice(command.Command, args);
     }
 
-    pub const Error = Allocator.Error;
+    pub const Error = Allocator.Error || error{WriteFailed};
 
     /// `getAction` returns the action function that should be called by the main app.
     pub fn getAction(self: *Self, app: *const App) Error!command.ExecFn {
@@ -66,8 +66,8 @@ pub const AppRunner = struct {
         } else |err| {
             processError(err, cr.error_data orelse unreachable, app);
             if (app.help_config.print_help_on_error) {
-                _ = std.io.getStdOut().write("\n") catch unreachable;
-                try help.print_command_help(app, try cr.command_path.toOwnedSlice(), cr.global_options);
+                _ = std.fs.File.stdout().write("\n") catch unreachable;
+                try help.print_command_help(app, try cr.command_path.toOwnedSlice(self.orig_allocator), cr.global_options);
             }
             std.posix.exit(1);
         }
@@ -117,7 +117,15 @@ fn processError(err: parser.ParseError, err_data: parser.ErrorData, app: *const
 }
 
 pub fn printError(app: *const App, comptime fmt: []const u8, args: anytype) void {
-    var p = Printer.init(std.io.getStdErr(), app.help_config.color_usage);
+    var buf: [4096]u8 = undefined;
+    var stderr = std.fs.File.stderr();
+    var w = stderr.writer(&buf);
+    const use_color = switch (app.help_config.color_usage) {
+        .always => true,
+        .never => false,
+        .auto => std.posix.isatty(stderr.handle),
+    };
+    var p = Printer.init(&w.interface, use_color);
 
     p.printInColor(app.help_config.color_error, "ERROR");
     p.format(": ", .{});

src/Printer.zig

@@ -14,17 +14,28 @@ pub fn print_command_help(
     command_path: []const *const command.Command,
     global_options: *const GlobalOptions,
 ) !void {
-    const stdout = std.io.getStdOut();
+    const stdout: std.fs.File = .stdout();
     var gpa = std.heap.GeneralPurposeAllocator(.{}){};
     const allocator = gpa.allocator();
     var arena = std.heap.ArenaAllocator.init(allocator);
+    defer arena.deinit();
+
+    const use_color = switch (global_options.color_usage) {
+        .always => true,
+        .never => false,
+        .auto => std.posix.isatty(stdout.handle),
+    };
+
+    var buf: [4096]u8 = undefined;
+    var w = stdout.writer(&buf);
+    var printer = Printer.init(&w.interface, use_color);
+    defer printer.flush();
     var help_printer = HelpPrinter{
         .app = app,
-        .printer = Printer.init(stdout, global_options.color_usage),
+        .printer = &printer,
         .global_options = global_options,
         .allocator = arena.allocator(),
     };
-    defer arena.deinit();
 
     if (command_path.len == 1) {
         help_printer.printAppHelp(app, command_path);
@@ -35,7 +46,7 @@ pub fn print_command_help(
 
 const HelpPrinter = struct {
     app: *const command.App,
-    printer: Printer,
+    printer: *Printer,
     global_options: *const GlobalOptions,
     allocator: Allocator,
 
@@ -171,7 +182,7 @@ const HelpPrinter = struct {
         }
     }
 
-    fn printOption(self: *const HelpPrinter, option: *const command.Option, option_column_width: usize) void {
+    fn printOption(self: *HelpPrinter, option: *const command.Option, option_column_width: usize) void {
         if (option.short_alias) |alias| {
             self.printer.printSpaces(2);
             self.printer.printColor(self.app.help_config.color_option);