{"id":16476007,"url":"https://github.com/softprops/zig-envy","last_synced_at":"2025-03-23T11:32:57.982Z","repository":{"id":208152878,"uuid":"720651427","full_name":"softprops/zig-envy","owner":"softprops","description":"parse env variables into zig structs","archived":false,"fork":false,"pushed_at":"2024-06-20T14:36:14.000Z","size":35,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-17T12:00:05.982Z","etag":null,"topics":["environment-variables","zig","zig-package","zigdex-lib"],"latest_commit_sha":null,"homepage":"","language":"Zig","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/softprops.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"softprops"}},"created_at":"2023-11-19T06:18:44.000Z","updated_at":"2024-07-14T07:45:09.000Z","dependencies_parsed_at":"2024-02-28T15:50:31.721Z","dependency_job_id":"0060b4ec-30d2-43d7-ba44-83b014104364","html_url":"https://github.com/softprops/zig-envy","commit_stats":null,"previous_names":["softprops/zig-envy"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softprops%2Fzig-envy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softprops%2Fzig-envy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softprops%2Fzig-envy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/softprops%2Fzig-envy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/softprops","download_url":"https://codeload.github.com/softprops/zig-envy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245097158,"owners_count":20560311,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["environment-variables","zig","zig-package","zigdex-lib"],"created_at":"2024-10-11T12:41:16.384Z","updated_at":"2025-03-23T11:32:57.588Z","avatar_url":"https://github.com/softprops.png","language":"Zig","funding_links":["https://ko-fi.com/softprops"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n    envy\n\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n    deserialize environment variables into typesafe structs\n\u003c/div\u003e\n\n---\n\n[![Main](https://github.com/softprops/zig-envy/actions/workflows/main.yml/badge.svg)](https://github.com/softprops/zig-envy/actions/workflows/main.yml) ![License Info](https://img.shields.io/github/license/softprops/zig-envy) ![Release](https://img.shields.io/github/v/release/softprops/zig-envy) [![Zig Support](https://img.shields.io/badge/zig-0.12.0-black?logo=zig)](https://ziglang.org/documentation/0.12.0/)\n\n## 🍬 features\n\n- fail fast on faulty application configuration\n- supports parsable std lib types out of the box\n- fail at compile time for unsupported field types\n\n## examples\n\n```zig\nconst std = @import(\"std\");\nconst envy = @import(\"envy\");\n\nconst Config = struct {\n    foo: u16,\n    bar: bool,\n    baz: []const u8,\n    boom: ?u64\n};\n\npub fn main() !void {\n    var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);\n    defer arena.deinit();\n    const allocator = arena.allocator();\n\n    const config = envy.parse(Config, allocator, .{}) catch |err| {\n        std.debug.print(\"error parsing config from env: {any}\", err);\n        return;\n    };\n    std.debug.println(\"config {any}\", .{ config });\n}\n```\n\n## 📼 installing\n\nCreate a new exec project with `zig init-exe`. Copy the echo handler example above into `src/main.zig`\n\nCreate a `build.zig.zon` file to declare a dependency\n\n\u003e .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\n\nStarting in zig `0.12.0`, you can use\n\n```sh\nzig fetch --save https://github.com/softprops/zig-envy/archive/refs/tags/v0.2.1.tar.gz\n```\n\nto manually add it as follows\n\n```diff\n.{\n    .name = \"my-app\",\n    .version = \"0.1.0\",\n    .dependencies = .{\n+        // 👇 declare dep properties\n+        .envy = .{\n+            // 👇 uri to download\n+            .url = \"https://github.com/softprops/zig-envy/archive/refs/tags/v0.2.1.tar.gz\",\n+            // 👇 hash verification\n+            .hash = \"{current-hash}\",\n+        },\n    },\n    .paths = .{\"\"},\n}\n```\n\n\u003e 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.\n\nAdd the following in your `build.zig` file\n\n```diff\nconst std = @import(\"std\");\n\npub fn build(b: *std.Build) void {\n    const target = b.standardTargetOptions(.{});\n\n    const optimize = b.standardOptimizeOption(.{});\n+    // 👇 de-reference envy dep from build.zig.zon\n+    const envy = b.dependency(\"envy\", .{\n+        .target = target,\n+        .optimize = optimize,\n+    }).module(\"envy\");\n    var exe = b.addExecutable(.{\n        .name = \"your-exe\",\n        .root_source_file = b.path(\"src/main.zig\"),\n        .target = target,\n        .optimize = optimize,\n    });\n+    // 👇 add the envy module to executable\n+    exe.root_module.addImport(\"envy\", envy);\n\n    b.installArtifact(exe);\n}\n```\n\n## 🥹 for budding ziglings\n\nDoes 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\n\n- [the official zig website](https://ziglang.org/)\n- [zig's one-page language documentation](https://ziglang.org/documentation/0.13.0/)\n- [ziglearn](https://ziglearn.org/)\n- [ziglings exercises](https://github.com/ratfactor/ziglings)\n\n\\- softprops 2023\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftprops%2Fzig-envy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoftprops%2Fzig-envy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftprops%2Fzig-envy/lists"}