Correctly print options with multi line help messages

closes #41
sam701 · Oct 13, 2024 · ac82640 · ac82640
1 parent 7fce6a3
commit ac82640
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 4 deletions.
diff --git a/examples/simple.zig b/examples/simple.zig
@@ -85,7 +85,7 @@ fn parseArgs() cli.AppRunner.Error!cli.ExecFn {
                             },
                             .{
                                 .long_name = "int",
-                                .help = "this is an int",
+                                .help = "this is an int\nwith the second line",
                                 .value_ref = r.mkRef(&config.int),
                             },
                             .{

diff --git a/src/Printer.zig b/src/Printer.zig
@@ -23,7 +23,7 @@ pub inline fn write(self: *const Self, text: []const u8) void {
     _ = self.out.write(text) catch unreachable;
 }
 
-pub inline fn printNewLine(self: *Self) void {
+pub inline fn printNewLine(self: *const Self) void {
     self.write("\n");
 }
 

diff --git a/src/help.zig b/src/help.zig
@@ -182,8 +182,16 @@ const HelpPrinter = struct {
             self.printer.printColor(color_clear);
             width += option.value_name.len + 3;
         }
-        self.printer.printSpaces(option_column_width - width);
 
-        self.printer.format("{s}\n", .{option.help});
+        // print option help
+        self.printer.printSpaces(option_column_width - width);
+        var it = std.mem.splitScalar(u8, option.help, '\n');
+        var lineNo: usize = 0;
+        while (it.next()) |line| : (lineNo += 1) {
+            if (lineNo > 0) {
+                self.printer.printSpaces(option_column_width + 8);
+            }
+            self.printer.format("{s}\n", .{line});
+        }
     }
 };