Add Io to API where io is used.

This is a breaking API change, but I think it makes sense in the context of the Io changes.
It adds an Io argument to functions that call other functions that require an io value.

Author: Zambito1

src/App.zig

@@ -32,7 +32,9 @@ process_args: ?[]const [:0]u8 = null,
 pub fn init(allocator: Allocator, name: []const u8, description: ?[]const u8) App {
     return App{
         .allocator = allocator,
-        .command = Command.init(allocator, name, description) catch { @panic("failed to create Command"); }
+        .command = Command.init(allocator, name, description) catch {
+            @panic("failed to create Command");
+        },
     };
 }
 
@@ -67,7 +69,9 @@ pub fn deinit(self: *App) void {
 /// var subcmd1 = app.createCommand("subcmd1", "First Subcommand");
 /// ```
 pub fn createCommand(self: *App, name: []const u8, description: ?[]const u8) Command {
-    return Command.init(self.allocator, name, description) catch { @panic("failed to create Command"); };
+    return Command.init(self.allocator, name, description) catch {
+        @panic("failed to create Command");
+    };
 }
 
 /// Returns a pointer to the root `Command` of the application.
@@ -99,11 +103,11 @@ pub fn rootCommand(self: *App) *Command {
 ///
 /// // Add arguments and subcommands using `root`.
 ///
-/// const matches = try app.parseProcess();
+/// const matches = try app.parseProcess(io);
 /// ```
-pub fn parseProcess(self: *App) YazapError!ArgMatches {
+pub fn parseProcess(self: *App, io: std.Io) YazapError!ArgMatches {
     self.process_args = try std.process.argsAlloc(self.allocator);
-    return self.parseFrom(self.process_args.?[1..]);
+    return self.parseFrom(io, self.process_args.?[1..]);
 }
 
 /// Parses the given arguments.
@@ -118,9 +122,9 @@ pub fn parseProcess(self: *App) YazapError!ArgMatches {
 ///
 /// // Add arguments and subcommands using `root`.
 ///
-/// const matches = try app.parseFrom(&.{ "arg1", "--some-option" "subcmd" });
+/// const matches = try app.parseFrom(io, &.{ "arg1", "--some-option" "subcmd" });
 /// ```
-pub fn parseFrom(self: *App, argv: []const [:0]const u8) YazapError!ArgMatches {
+pub fn parseFrom(self: *App, io: std.Io, argv: []const [:0]const u8) YazapError!ArgMatches {
     var parser = Parser.init(self.allocator, argv, self.rootCommand());
     var result = parser.parse() catch |err| {
         // Don't clutter the test result with error messages.
@@ -132,7 +136,7 @@ pub fn parseFrom(self: *App, argv: []const [:0]const u8) YazapError!ArgMatches {
 
     if (result.getCommandContainingHelpFlag()) |command| {
         var buffer: [help_message_buffer_size]u8 = undefined;
-        var help_writer = HelpMessageWriter.init(command, &buffer);
+        var help_writer = HelpMessageWriter.init(command, io, &buffer);
         try help_writer.write();
         result.deinit();
         self.deinit();
@@ -162,14 +166,14 @@ pub fn parseFrom(self: *App, argv: []const [:0]const u8) YazapError!ArgMatches {
 /// const matches = try app.parseProcess();
 ///
 /// if (!matches.containsArgs()) {
-///     try app.displayHelp();
+///     try app.displayHelp(io);
 ///     return;
 /// }
 /// ```
-pub fn displayHelp(self: *App) YazapError!void {
+pub fn displayHelp(self: *App, io: std.Io) YazapError!void {
     if (self.parse_result) |parse_result| {
         var buffer: [help_message_buffer_size]u8 = undefined;
-        var help_writer = HelpMessageWriter.init(parse_result.getCommand(), &buffer);
+        var help_writer = HelpMessageWriter.init(parse_result.getCommand(), io, &buffer);
         try help_writer.write();
     }
 }
@@ -197,15 +201,15 @@ pub fn displayHelp(self: *App) YazapError!void {
 ///
 /// if (matches.subcommandMatches("subcmd")) |subcmd_matches| {
 ///     if (!subcmd_matches.containsArgs()) {
-///         try app.displaySubcommandHelp();
+///         try app.displaySubcommandHelp(io);
 /// }
 /// ```
-pub fn displaySubcommandHelp(self: *App) YazapError!void {
+pub fn displaySubcommandHelp(self: *App, io: std.Io) YazapError!void {
     const parse_result = self.parse_result orelse return;
 
     if (parse_result.getActiveSubcommand()) |subcmd| {
         var buffer: [help_message_buffer_size]u8 = undefined;
-        var help_writer = HelpMessageWriter.init(subcmd, &buffer);
+        var help_writer = HelpMessageWriter.init(subcmd, io, &buffer);
         try help_writer.write();
     }
 }

src/HelpMessageWriter.zig

@@ -2,7 +2,7 @@ const HelpMessageWriter = @This();
 
 const std = @import("std");
 const Arg = @import("Arg.zig");
-const BufferedWriter = std.fs.File.Writer;
+const BufferedWriter = std.Io.File.Writer;
 const Command = @import("Command.zig");
 const ParsedCommand = @import("parser/ParseResult.zig").ParsedCommand;
 
@@ -16,9 +16,9 @@ writer: BufferedWriter = undefined,
 /// Command whose help to write.
 command: *const ParsedCommand = undefined,
 
-pub fn init(command: *const ParsedCommand, buffer: []u8) HelpMessageWriter {
+pub fn init(command: *const ParsedCommand, io: std.Io, buffer: []u8) HelpMessageWriter {
     return HelpMessageWriter{
-        .writer = .init(std.fs.File.stderr(), buffer),
+        .writer = .init(std.Io.File.stderr(), io, buffer),
         .command = command,
     };
 }

src/parser/ParseError.zig

@@ -19,7 +19,7 @@ pub fn setContext(self: *ParseError, ctx: Context) void {
 /// Prints the error context in a nice error message.
 pub fn print(self: *const ParseError) PrintError!void {
     var buffer: [1024]u8 = undefined;
-    var _writer = std.fs.File.stderr().writer(&buffer);
+    var _writer = std.Io.File.stderr().writer(&buffer);
     const writer = &_writer.interface;
 
     // Print the error prefix for nicer output.
@@ -111,7 +111,7 @@ pub fn print(self: *const ParseError) PrintError!void {
 }
 
 /// An error type returned by the `print`.
-pub const PrintError = std.fs.File.WriteError || std.Io.Writer.Error;
+pub const PrintError = std.Io.Writer.Error;
 /// An error type returned by the parser.
 pub const Error = error{
     UnrecognizedCommand,

src/test.zig

@@ -14,7 +14,7 @@ test "positional arguments with auto index" {
     try app.rootCommand().addArg(Arg.positional("TWO", null, null));
     try app.rootCommand().addArg(Arg.positional("THREE", null, null));
 
-    const matches = try app.parseFrom(&.{ "val1", "val2", "val3" });
+    const matches = try app.parseFrom(std.testing.io, &.{ "val1", "val2", "val3" });
     try testing.expectEqualStrings("val1", matches.getSingleValue("ONE").?);
     try testing.expectEqualStrings("val2", matches.getSingleValue("TWO").?);
     try testing.expectEqualStrings("val3", matches.getSingleValue("THREE").?);
@@ -30,7 +30,7 @@ test "positional arguments with manual index" {
     try app.rootCommand().addArg(Arg.positional("THREE", null, 3));
     try app.rootCommand().addArg(Arg.positional("TWO", null, 2));
 
-    const matches = try app.parseFrom(&.{ "val1", "val2", "val3" });
+    const matches = try app.parseFrom(std.testing.io, &.{ "val1", "val2", "val3" });
     try testing.expectEqualStrings("val1", matches.getSingleValue("ONE").?);
     try testing.expectEqualStrings("val2", matches.getSingleValue("TWO").?);
     try testing.expectEqualStrings("val3", matches.getSingleValue("THREE").?);
@@ -57,7 +57,7 @@ test "command that takes single value" {
 
     try app.rootCommand().addArg(Arg.positional("PATH", null, 1));
 
-    const matches = try app.parseFrom(&.{"test.txt"});
+    const matches = try app.parseFrom(std.testing.io, &.{"test.txt"});
     try testing.expectEqualStrings("test.txt", matches.getSingleValue("PATH").?);
 
     app.deinit();
@@ -117,7 +117,7 @@ test "command that takes required positional arg" {
 
     try app.rootCommand().addArg(Arg.positional("PATH", null, null));
     app.rootCommand().setProperty(.positional_arg_required);
-    try testing.expectError(error.PositionalArgumentNotProvided, app.parseFrom(&.{}));
+    try testing.expectError(error.PositionalArgumentNotProvided, app.parseFrom(std.testing.io, &.{}));
 
     app.deinit();
 }
@@ -128,7 +128,7 @@ test "command requires subcommand" {
 
     try app.rootCommand().addSubcommand(app.createCommand("init", null));
     app.rootCommand().setProperty(.subcommand_required);
-    try testing.expectError(error.SubcommandNotProvided, app.parseFrom(&.{}));
+    try testing.expectError(error.SubcommandNotProvided, app.parseFrom(std.testing.io, &.{}));
 
     app.deinit();
 }
@@ -138,7 +138,7 @@ test "Option that does not takes value" {
     errdefer app.deinit();
 
     try app.rootCommand().addArg(Arg.booleanOption("version", 'v', null));
-    try testing.expectError(error.UnexpectedOptionValue, app.parseFrom(&.{"-v=13"}));
+    try testing.expectError(error.UnexpectedOptionValue, app.parseFrom(std.testing.io, &.{"-v=13"}));
 
     app.deinit();
 }
@@ -148,7 +148,7 @@ test "Option that takes single value" {
     errdefer app.deinit();
 
     try app.rootCommand().addArg(Arg.singleValueOption("output", 'o', null));
-    try testing.expectError(error.OptionValueNotProvided, app.parseFrom(&.{"-o"}));
+    try testing.expectError(error.OptionValueNotProvided, app.parseFrom(std.testing.io, &.{"-o"}));
 
     app.deinit();
 }
@@ -162,7 +162,7 @@ test "multiValuesOption provided with single value short" {
     // ex: clang sources...
     try app.rootCommand().addArg(srcs);
 
-    const matches_short = try app.parseFrom(&.{ "-s", "f1" });
+    const matches_short = try app.parseFrom(std.testing.io, &.{ "-s", "f1" });
     try testing.expectEqual(@as(usize, 1), matches_short.getMultiValues("sources").?.len);
 }
 
@@ -175,7 +175,7 @@ test "multiValuesOption provided with single value long" {
     // ex: clang sources...
     try app.rootCommand().addArg(srcs);
 
-    const matches_short = try app.parseFrom(&.{ "--sources", "f1" });
+    const matches_short = try app.parseFrom(std.testing.io, &.{ "--sources", "f1" });
     try testing.expectEqual(@as(usize, 1), matches_short.getMultiValues("sources").?.len);
 }
 
@@ -187,7 +187,7 @@ test "multiValuesOption provided with multiple values short" {
 
     // ex: clang sources...
     try app.rootCommand().addArg(srcs);
-    const matches = try app.parseFrom(&.{ "-s", "f1", "f2", "f3", "f4", "f5" });
+    const matches = try app.parseFrom(std.testing.io, &.{ "-s", "f1", "f2", "f3", "f4", "f5" });
 
     try testing.expectEqual(@as(usize, 5), matches.getMultiValues("sources").?.len);
 }
@@ -200,7 +200,7 @@ test "multiValuesOption provided with multiple values long" {
 
     // ex: clang sources...
     try app.rootCommand().addArg(srcs);
-    const matches = try app.parseFrom(&.{ "--sources", "f1", "f2", "f3", "f4", "f5" });
+    const matches = try app.parseFrom(std.testing.io, &.{ "--sources", "f1", "f2", "f3", "f4", "f5" });
 
     try testing.expectEqual(@as(usize, 5), matches.getMultiValues("sources").?.len);
 }
@@ -217,7 +217,7 @@ test "Option that takes many/multiple values" {
 
     // ex: clang sources...
     try app.rootCommand().addArg(srcs);
-    const matches = try app.parseFrom(&.{ "-s", "f1", "f2", "f3", "f4", "f5" });
+    const matches = try app.parseFrom(std.testing.io, &.{ "-s", "f1", "f2", "f3", "f4", "f5" });
 
     try testing.expectEqual(@as(usize, 5), matches.getMultiValues("sources").?.len);
 
@@ -235,7 +235,7 @@ test "Option with min values" {
     srcs.setProperty(.takes_value);
 
     try app.rootCommand().addArg(srcs);
-    try testing.expectError(error.TooFewOptionValue, app.parseFrom(&.{"-s=f1"}));
+    try testing.expectError(error.TooFewOptionValue, app.parseFrom(std.testing.io, &.{"-s=f1"}));
 
     app.deinit();
 }
@@ -249,6 +249,7 @@ test "Option with max values" {
 
     try app.rootCommand().addArg(srcs);
     try testing.expectError(error.TooManyOptionValue, app.parseFrom(
+        std.testing.io,
         &.{"-s=f1:f2:f3:f4:f5:f6"},
     ));
 
@@ -267,7 +268,7 @@ test "Option with allowed values" {
     );
 
     try app.rootCommand().addArg(stdd);
-    try testing.expectError(error.InvalidOptionValue, app.parseFrom(&.{"--std=c100"}));
+    try testing.expectError(error.InvalidOptionValue, app.parseFrom(std.testing.io, &.{"--std=c100"}));
 
     app.deinit();
 }
@@ -280,7 +281,7 @@ test "passing positional argument before options" {
     try app.rootCommand().addArg(Arg.booleanOption("all", 'a', null));
     app.rootCommand().setProperty(.positional_arg_required);
 
-    const matches = try app.parseFrom(&.{ ".", "-a" });
+    const matches = try app.parseFrom(std.testing.io, &.{ ".", "-a" });
     try testing.expectEqualStrings(".", matches.getSingleValue("PATH").?);
     try testing.expectEqual(true, matches.containsArg("all"));
 
@@ -294,7 +295,7 @@ test "passing positional argument after options" {
     try app.rootCommand().addArg(Arg.positional("PATH", null, null));
     try app.rootCommand().addArg(Arg.booleanOption("all", 'a', null));
 
-    const matches = try app.parseFrom(&.{ "-a", "." });
+    const matches = try app.parseFrom(std.testing.io, &.{ "-a", "." });
     try testing.expectEqualStrings(".", matches.getSingleValue("PATH").?);
     try testing.expectEqual(true, matches.containsArg("all"));
 
@@ -309,7 +310,7 @@ test "passing positional argument before and after options" {
     try app.rootCommand().addArg(Arg.booleanOption("all", 'a', null));
     try app.rootCommand().addArg(Arg.booleanOption("one-line", '1', null));
 
-    const matches = try app.parseFrom(&.{ "-1", ".", "-a" });
+    const matches = try app.parseFrom(std.testing.io, &.{ "-1", ".", "-a" });
     try testing.expectEqualStrings(".", matches.getSingleValue("PATH").?);
     try testing.expectEqual(true, matches.containsArg("one-line"));
     try testing.expectEqual(true, matches.containsArg("all"));