|
| 1 | +# Typed-Only Approach - zig-cli |
| 2 | + |
| 3 | +## Philosophy |
| 4 | + |
| 5 | +**zig-cli is built around one core principle: leverage Zig's compile-time features for maximum type safety with zero runtime overhead.** |
| 6 | + |
| 7 | +There are no duplicate APIs, no "typed vs untyped" choices. Just one way to do things - the type-safe way. |
| 8 | + |
| 9 | +## Why Typed-Only? |
| 10 | + |
| 11 | +### 1. **Compile-Time Safety** |
| 12 | + |
| 13 | +```zig |
| 14 | +// This catches typos at compile time |
| 15 | +const name = ctx.get(.name); |
| 16 | +// ^^^^^ Compiler validates this exists |
| 17 | +
|
| 18 | +// Not at runtime like: |
| 19 | +const name = ctx.getOption("nmae"); // Typo only caught when code runs |
| 20 | +``` |
| 21 | + |
| 22 | +### 2. **Zero Runtime Cost** |
| 23 | + |
| 24 | +All type validation happens at compile time using Zig's `comptime` features: |
| 25 | +- No reflection |
| 26 | +- No runtime type checking |
| 27 | +- No performance overhead |
| 28 | +- Same machine code as hand-written parsing |
| 29 | + |
| 30 | +### 3. **Self-Documenting** |
| 31 | + |
| 32 | +```zig |
| 33 | +const ServerOptions = struct { |
| 34 | + /// Port to listen on (1-65535) |
| 35 | + port: u16 = 8080, |
| 36 | +
|
| 37 | + /// Host address to bind |
| 38 | + host: []const u8 = "0.0.0.0", |
| 39 | +
|
| 40 | + /// TLS configuration |
| 41 | + tls: ?struct { |
| 42 | + cert_path: []const u8, |
| 43 | + key_path: []const u8, |
| 44 | + } = null, |
| 45 | +}; |
| 46 | +``` |
| 47 | + |
| 48 | +The struct IS the documentation. Types, defaults, optionality - all visible at a glance. |
| 49 | + |
| 50 | +### 4. **Superior Developer Experience** |
| 51 | + |
| 52 | +- **IDE Autocomplete**: Full IntelliSense for all fields |
| 53 | +- **Refactoring**: Rename fields across entire codebase with confidence |
| 54 | +- **Type Inference**: Compiler knows types, you don't specify them twice |
| 55 | +- **Immediate Feedback**: Errors at compile time, not runtime |
| 56 | + |
| 57 | +## API Design |
| 58 | + |
| 59 | +### Commands |
| 60 | + |
| 61 | +```zig |
| 62 | +// Define options |
| 63 | +const Options = struct { name: []const u8 }; |
| 64 | +
|
| 65 | +// Create command - options auto-generated! |
| 66 | +var cmd = try cli.command(Options).init(allocator, "mycmd", "Description"); |
| 67 | +defer cmd.deinit(); |
| 68 | +
|
| 69 | +// Set action |
| 70 | +_ = cmd.setAction(myAction); |
| 71 | +``` |
| 72 | + |
| 73 | +**What happens:** |
| 74 | +1. `cli.command(Options)` - Returns `TypedCommand(Options)` type |
| 75 | +2. Struct introspection at comptime generates CLI options |
| 76 | +3. Field types → Option types (string, int, bool, enum) |
| 77 | +4. Defaults/optionals → CLI defaults/optional flags |
| 78 | + |
| 79 | +### Context |
| 80 | + |
| 81 | +```zig |
| 82 | +fn myAction(ctx: *cli.Context(Options)) !void { |
| 83 | + // Compile-time validated enum field access |
| 84 | + const name = ctx.get(.name); |
| 85 | + // ^^^^^ Must be a field of Options |
| 86 | +
|
| 87 | + // Or parse entire struct |
| 88 | + const opts = try ctx.parse(); |
| 89 | +} |
| 90 | +``` |
| 91 | + |
| 92 | +**Type safety:** |
| 93 | +- `.name` is an enum value checked at compile time |
| 94 | +- Return type inferred from struct field type |
| 95 | +- No optionals for required fields |
| 96 | + |
| 97 | +### Config |
| 98 | + |
| 99 | +```zig |
| 100 | +const AppConfig = struct { |
| 101 | + database: struct { |
| 102 | + host: []const u8, |
| 103 | + port: u16, |
| 104 | + }, |
| 105 | + log_level: enum { debug, info } = .info, |
| 106 | +}; |
| 107 | +
|
| 108 | +var config = try cli.config.load(AppConfig, allocator, "config.toml"); |
| 109 | +defer config.deinit(); |
| 110 | +
|
| 111 | +// Direct field access - fully typed! |
| 112 | +const host = config.value.database.host; // []const u8 |
| 113 | +const port = config.value.database.port; // u16 |
| 114 | +``` |
| 115 | + |
| 116 | +**Benefits:** |
| 117 | +- Schema validation at load time |
| 118 | +- Type conversion automatic |
| 119 | +- Enum values checked |
| 120 | +- Nested structs supported |
| 121 | + |
| 122 | +### Middleware |
| 123 | + |
| 124 | +```zig |
| 125 | +const AuthData = struct { |
| 126 | + user_id: []const u8 = "", |
| 127 | + role: enum { admin, user } = .user, |
| 128 | +}; |
| 129 | +
|
| 130 | +fn authMiddleware(ctx: *cli.middleware(AuthData)) !bool { |
| 131 | + ctx.set(.user_id, "12345"); |
| 132 | + ctx.set(.role, .admin); // Enum - type checked! |
| 133 | +
|
| 134 | + if (ctx.get(.role) == .admin) { |
| 135 | + // ... |
| 136 | + } |
| 137 | +
|
| 138 | + return true; |
| 139 | +} |
| 140 | +``` |
| 141 | + |
| 142 | +## No String-Based Lookups |
| 143 | + |
| 144 | +Traditional CLI libraries: |
| 145 | +```zig |
| 146 | +// ❌ String-based (error-prone) |
| 147 | +const name = ctx.getOption("name"); |
| 148 | +const port_str = ctx.getOption("port") orelse "8080"; |
| 149 | +const port = try std.fmt.parseInt(u16, port_str, 10); |
| 150 | +``` |
| 151 | + |
| 152 | +zig-cli: |
| 153 | +```zig |
| 154 | +// ✅ Type-safe (compile-time validated) |
| 155 | +const name = ctx.get(.name); |
| 156 | +const port = ctx.get(.port); |
| 157 | +``` |
| 158 | + |
| 159 | +## No Duplication |
| 160 | + |
| 161 | +**One way to define commands**: Struct-based |
| 162 | +**One way to access options**: `ctx.get(.field)` |
| 163 | +**One way to load config**: `config.load(T, ...)` |
| 164 | + |
| 165 | +No "advanced vs simple" APIs. No "typed vs untyped" paths. Just one elegant, type-safe approach. |
| 166 | + |
| 167 | +## Implementation Details |
| 168 | + |
| 169 | +### How It Works |
| 170 | + |
| 171 | +1. **Struct Introspection**: |
| 172 | + ```zig |
| 173 | + const fields = @typeInfo(T).Struct.fields; |
| 174 | + inline for (fields) |field| { |
| 175 | + // Generate options at compile time |
| 176 | + } |
| 177 | + ``` |
| 178 | + |
| 179 | +2. **Type Mapping**: |
| 180 | + - `[]const u8` → String option |
| 181 | + - `u8`-`u64`, `i8`-`i64` → Integer option |
| 182 | + - `f32`, `f64` → Float option |
| 183 | + - `bool` → Boolean flag |
| 184 | + - `enum` → Validated enum values |
| 185 | + - `?T` → Optional option |
| 186 | + |
| 187 | +3. **Accessor Generation**: |
| 188 | + ```zig |
| 189 | + pub fn get(self: *Self, comptime field: std.meta.FieldEnum(T)) FieldType(T, field) { |
| 190 | + comptime { |
| 191 | + // Validate field exists |
| 192 | + _ = std.meta.fieldInfo(T, field); |
| 193 | + } |
| 194 | + const str = self.parse_context.getOption(@tagName(field)).?; |
| 195 | + return parseValue(FieldType(T, field), str); |
| 196 | + } |
| 197 | + ``` |
| 198 | + |
| 199 | +### Performance |
| 200 | + |
| 201 | +| Operation | Runtime Cost | |
| 202 | +|-----------|--------------| |
| 203 | +| Struct introspection | **Compile-time only** | |
| 204 | +| Field validation | **Compile-time only** | |
| 205 | +| Type generation | **Compile-time only** | |
| 206 | +| Option parsing | Same as manual parsing | |
| 207 | +| Field access | **Zero overhead** (direct access) | |
| 208 | + |
| 209 | +**Result**: Identical performance to hand-written parsing, but with full type safety. |
| 210 | + |
| 211 | +## Supported Types |
| 212 | + |
| 213 | +### Primitives |
| 214 | +- ✅ `bool` |
| 215 | +- ✅ `i8`, `i16`, `i32`, `i64`, `i128` |
| 216 | +- ✅ `u8`, `u16`, `u32`, `u64`, `u128` |
| 217 | +- ✅ `f32`, `f64` |
| 218 | + |
| 219 | +### Strings |
| 220 | +- ✅ `[]const u8` |
| 221 | + |
| 222 | +### Complex Types |
| 223 | +- ✅ Enums (any Zig enum) |
| 224 | +- ✅ Optionals (`?T`) |
| 225 | +- ✅ Nested structs (arbitrary depth) |
| 226 | +- ✅ Fixed arrays (`[N]T`) |
| 227 | + |
| 228 | +### Not Supported |
| 229 | +- ❌ Slices of non-u8 (`[]T` where T != u8) |
| 230 | +- ❌ Dynamic arrays (`ArrayList`) |
| 231 | +- ❌ Hashmaps |
| 232 | +- ❌ Unions (except tagged unions/enums) |
| 233 | +- ❌ Function pointers |
| 234 | + |
| 235 | +## Examples |
| 236 | + |
| 237 | +### Simple CLI |
| 238 | + |
| 239 | +```zig |
| 240 | +const Options = struct { |
| 241 | + input: []const u8, |
| 242 | + output: []const u8, |
| 243 | + verbose: bool = false, |
| 244 | +}; |
| 245 | +
|
| 246 | +fn process(ctx: *cli.Context(Options)) !void { |
| 247 | + const opts = try ctx.parse(); |
| 248 | + std.debug.print("Processing {s} -> {s}\n", .{opts.input, opts.output}); |
| 249 | +} |
| 250 | +``` |
| 251 | + |
| 252 | +### With Enum |
| 253 | + |
| 254 | +```zig |
| 255 | +const Options = struct { |
| 256 | + mode: enum { fast, slow, balanced } = .balanced, |
| 257 | + threads: u8 = 4, |
| 258 | +}; |
| 259 | +``` |
| 260 | + |
| 261 | +### Nested Config |
| 262 | + |
| 263 | +```zig |
| 264 | +const Config = struct { |
| 265 | + server: struct { |
| 266 | + host: []const u8, |
| 267 | + port: u16, |
| 268 | + tls: ?struct { |
| 269 | + cert: []const u8, |
| 270 | + key: []const u8, |
| 271 | + } = null, |
| 272 | + }, |
| 273 | + database: struct { |
| 274 | + url: []const u8, |
| 275 | + pool_size: u32 = 100, |
| 276 | + }, |
| 277 | +}; |
| 278 | +``` |
| 279 | + |
| 280 | +## Migration Guide |
| 281 | + |
| 282 | +If you have string-based CLI code: |
| 283 | + |
| 284 | +### Before |
| 285 | +```zig |
| 286 | +fn action(ctx: *Command.ParseContext) !void { |
| 287 | + const name = ctx.getOption("name") orelse return error.Missing; |
| 288 | + const port_str = ctx.getOption("port") orelse "8080"; |
| 289 | + const port = try std.fmt.parseInt(u16, port_str, 10); |
| 290 | +} |
| 291 | +``` |
| 292 | + |
| 293 | +### After |
| 294 | +```zig |
| 295 | +const Options = struct { |
| 296 | + name: []const u8, |
| 297 | + port: u16 = 8080, |
| 298 | +}; |
| 299 | +
|
| 300 | +fn action(ctx: *cli.Context(Options)) !void { |
| 301 | + const opts = try ctx.parse(); |
| 302 | + // opts.name and opts.port are ready to use! |
| 303 | +} |
| 304 | +``` |
| 305 | + |
| 306 | +## Philosophy Recap |
| 307 | + |
| 308 | +1. **One True Way**: No API duplication, one typed approach |
| 309 | +2. **Compile-Time First**: Leverage Zig's strengths |
| 310 | +3. **Zero Cost**: No runtime overhead whatsoever |
| 311 | +4. **Self-Documenting**: Types are documentation |
| 312 | +5. **IDE-Friendly**: Full autocomplete and refactoring support |
| 313 | + |
| 314 | +**zig-cli: Type-safe CLIs. The Zig way.** |
0 commit comments