zig-args/README.md

43 lines
1.4 KiB
Markdown
Raw Normal View History

2020-03-05 05:47:34 +08:00
# Zig Argument Parser
2020-03-05 05:34:01 +08:00
Simple-to-use argument parser with struct-based config
2020-03-05 05:38:26 +08:00
2020-03-05 05:47:34 +08:00
## Features
- Automatic option generation from a config struct
- Familiar *look & feel*:
- Everything after the first `--` is assumed to be a positional argument
- A single `-` is interpreted as a positional argument which can be used as the stdin/stdout file placeholder
- Short options with no argument can be combined into a single argument: `-dfe`
- Long options can use either `--option=value` or `--option value` syntax
2020-03-05 05:47:34 +08:00
- Integrated support for primitive types:
- All integer types (signed & unsigned)
- Floating point types
- Booleans (takes no argument)
- Strings
- Enumerations
2020-03-05 05:47:34 +08:00
## Example
2020-03-05 05:38:26 +08:00
```zig
const options = try argsParser.parse(struct {
// This declares long options for double hyphen
output: ?[]const u8 = null,
@"with-offset": bool = false,
@"with-hexdump": bool = false,
@"intermix-source": bool = false,
numberOfBytes: ?i32 = null,
// This declares short-hand options for single hyphen
pub const shorthands = .{
.S = "intermix-source",
.b = "with-hexdump",
.O = "with-offset",
.o = "output",
};
}, &args, argsAllocator);
defer options.deinit();
std.debug.warn("parsed result:\n{}\npositionals:\n", .{options.options});
for (options.args) |arg| {
std.debug.warn("\t{}\n", .{arg});
}
```