README.md

Zdotenv is a simple .env parser and a port of godotenv and ruby dotenv, but with a smidge more simplicity.

Usage:

Add zdotenv to your zig project:

zig fetch --save https://github.com/BitlyTwiser/zdotenv/archive/refs/tags/v0.1.0.tar.gz

Add to build file:

    const zdotenv = b.dependency("zdotenv", .{});
    exe.root_module.addImport("zdotenv", zdotenv.module("zdotenv"));

Zdotenv has 2 pathways:

1. Absolute path to .env

• Expects an absolute path to the .env (unix systems expect a preceding / in the path)

const z = try Zdotenv.init(std.heap.page_allocator);
// Must be an absolute path!
try z.loadFromFile("/home/<username>/Documents/gitclones/zdotenv/test-env.env");

2. relaltive path:

• Expects the .env to be placed alongside the calling binary

const z = try Zdotenv.init(std.heap.page_allocator);
try z.load();

Example from Main:

const std = @import("std");
const zdotenv = @import("lib.zig");
const assert = std.debug.assert;

///  The binary main is used for testing the package to showcase the API
pub fn main() !void {
    var arena = std.heap.ArenaAllocator.init(std.heap.page_allocator);
    defer arena.deinit();
    const allocator = arena.allocator();

    var dotenv = try zdotenv.Zdotenv.init(allocator);
    try dotenv.load();

    const env_map = try std.process.getEnvMap(allocator);
    const pass = env_map.get("PASSWORD") orelse "foobar";

    assert(std.mem.eql(u8, pass, "I AM ALIVE!!"));
}

Importing this into your own library, you will use @import("zdotenv"). Otherwise, this would be the same :)

C usage:

Zig (at the time of this writing) does not have a solid way of directly adjusting the env variables. Doing things like:

        var env_map = std.process.getEnvMap(std.heap.page_allocator);
        env_map.put("t", "val");

will only adjust the env map for the scope of this execution (i.e. scope of the current calling function). After function exit, the map goes back to its previous state.

Therefore, we do make a C call to store the env variables that are parsed. So linking libC and running tests with --library c is needed

Using the package is as simple as the above code examples. import below using zig zon, load the .env, and access the variables as needed using std.process.EnvMap :)