summaryrefslogtreecommitdiff
path: root/example
diff options
context:
space:
mode:
authorGravatar Jimmi Holst Christensen2025-07-22 10:49:49 +0200
committerGravatar Jimmi Holst Christensen2025-07-22 10:49:49 +0200
commit1c8cc16b660d8933c48b1f8c5321542985c92c04 (patch)
tree16260ac3cbc89cadefbb713fc554289032b6ed2c /example
parentfeat: Add `Diagnostic.reportToFile` (diff)
downloadzig-clap-1c8cc16b660d8933c48b1f8c5321542985c92c04.tar.gz
zig-clap-1c8cc16b660d8933c48b1f8c5321542985c92c04.tar.xz
zig-clap-1c8cc16b660d8933c48b1f8c5321542985c92c04.zip
feat: Add `clap.helpToFile`
The code for printing help became quite verbose after writegate. Writing help to a file like stdout and stderr is very common, so this wrapper provides a default, buffered way to report to a file.
Diffstat (limited to 'example')
-rw-r--r--example/help.zig8
1 files changed, 2 insertions, 6 deletions
diff --git a/example/help.zig b/example/help.zig
index 676a56a..5c88d83 100644
--- a/example/help.zig
+++ b/example/help.zig
@@ -17,12 +17,8 @@ pub fn main() !void {
17 // where `Id` has a `description` and `value` method (`Param(Help)` is one such parameter). 17 // where `Id` has a `description` and `value` method (`Param(Help)` is one such parameter).
18 // The last argument contains options as to how `help` should print those parameters. Using 18 // The last argument contains options as to how `help` should print those parameters. Using
19 // `.{}` means the default options. 19 // `.{}` means the default options.
20 if (res.args.help != 0) { 20 if (res.args.help != 0)
21 var buf: [1024]u8 = undefined; 21 return clap.helpToFile(.stderr(), clap.Help, &params, .{});
22 var stderr = std.fs.File.stderr().writer(&buf);
23 try clap.help(&stderr.interface, clap.Help, &params, .{});
24 return stderr.interface.flush();
25 }
26} 22}
27 23
28const clap = @import("clap"); 24const clap = @import("clap");