Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/softprops/zig-envy
parse env variables into zig structs
https://github.com/softprops/zig-envy
environment-variables zig zig-package zigdex-lib
Last synced: 2 months ago
JSON representation
parse env variables into zig structs
- Host: GitHub
- URL: https://github.com/softprops/zig-envy
- Owner: softprops
- License: mit
- Created: 2023-11-19T06:18:44.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-20T14:36:14.000Z (7 months ago)
- Last Synced: 2024-10-12T12:41:18.533Z (3 months ago)
- Topics: environment-variables, zig, zig-package, zigdex-lib
- Language: Zig
- Homepage:
- Size: 34.2 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
envy
deserialize environment variables into typesafe structs
---
[](https://github.com/softprops/zig-envy/actions/workflows/main.yml)   [](https://ziglang.org/documentation/0.12.0/)
## 🍬 features
- fail fast on faulty application configuration
- supports parsable std lib types out of the box
- fail at compile time for unsupported field types
## examples
```zig
const std = @import("std");
const envy = @import("envy");
const Config = struct {
foo: u16,
bar: bool,
baz: []const u8,
boom: ?u64
};
pub fn main() !void {
var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
defer arena.deinit();
const allocator = arena.allocator();
const config = envy.parse(Config, allocator, .{}) catch |err| {
std.debug.print("error parsing config from env: {any}", err);
return;
};
std.debug.println("config {any}", .{ config });
}
```
## 📼 installing
Create a new exec project with `zig init-exe`. Copy the echo handler example above into `src/main.zig`
Create a `build.zig.zon` file to declare a dependency
> .zon short for "zig object notation" files are essentially zig structs. `build.zig.zon` is zigs native package manager convention for where to declare dependencies
Starting in zig `0.12.0`, you can use
```sh
zig fetch --save https://github.com/softprops/zig-envy/archive/refs/tags/v0.2.1.tar.gz
```
to manually add it as follows
```diff
.{
.name = "my-app",
.version = "0.1.0",
.dependencies = .{
+ // 👇 declare dep properties
+ .envy = .{
+ // 👇 uri to download
+ .url = "https://github.com/softprops/zig-envy/archive/refs/tags/v0.2.1.tar.gz",
+ // 👇 hash verification
+ .hash = "{current-hash}",
+ },
},
.paths = .{""},
}
```
> the hash below may vary. you can also depend any tag with `https://github.com/softprops/zig-envy/archive/refs/tags/v{version}.tar.gz` or current main with `https://github.com/softprops/zig-envy/archive/refs/heads/main/main.tar.gz`. to resolve a hash omit it and let zig tell you the expected value.
Add the following in your `build.zig` file
```diff
const std = @import("std");
pub fn build(b: *std.Build) void {
const target = b.standardTargetOptions(.{});
const optimize = b.standardOptimizeOption(.{});
+ // 👇 de-reference envy dep from build.zig.zon
+ const envy = b.dependency("envy", .{
+ .target = target,
+ .optimize = optimize,
+ }).module("envy");
var exe = b.addExecutable(.{
.name = "your-exe",
.root_source_file = b.path("src/main.zig"),
.target = target,
.optimize = optimize,
});
+ // 👇 add the envy module to executable
+ exe.root_module.addImport("envy", envy);
b.installArtifact(exe);
}
```
## 🥹 for budding ziglings
Does this look interesting but you're new to zig and feel left out? No problem, zig is young so most us of our new are as well. Here are some resources to help get you up to speed on zig
- [the official zig website](https://ziglang.org/)
- [zig's one-page language documentation](https://ziglang.org/documentation/0.13.0/)
- [ziglearn](https://ziglearn.org/)
- [ziglings exercises](https://github.com/ratfactor/ziglings)
\- softprops 2023