allan2 / dotenvy

A well-maintained fork of the dotenv crate

dotenvy

A well-maintained fork of the dotenv crate.

This crate is the suggested alternative for dotenv in security advisory RUSTSEC-2021-0141.

Components

1. dotenvy - A well-maintained fork of the dotenv crate.
2. dotenvy_macro - A macro for compile-time .env inspection. This is a fork of dotenv_codegen.
3. dotenvy-macros - A runtime macro library containing the load attribute macro.
4. dotenvy binary that loads an env file before executing a specified command.

What is an environment file?

An environment file, or env file, is a plain text file consisting of key-value pairs.

.env

HOST=foo
PORT=3000

Common names for env files are .env, .env.dev, .env.prod, but any name can be used. The default path for this crate is .env.

Variables can span multiple lines and can also be substituted. For an explanation of substituion rules, refer to the .env-substitution example file.

Usage

This library contains two APIs, a non-environment-modifying API and an environment-modifying API.

Runtime loading

The non-modifying API is recommended for most use cases.

Non-modifying API

use dotenvy::{EnvLoader};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let env_map = EnvLoader::new().load()?;
    println!("HOST={}", env_map.var("HOST")?);
    Ok(())
}

Configuration

// from a file
let loader1 = EnvLoader::with_path("./.env").sequence(EnvSequence::InputThenEnv);
let loader2 = EnvLoader::new();  // shorthand for loader1

// from a string
let s = "HOST=foo\nPORT=3000";
let str_loader = EnvLoader::with_reader(Cursor::new(s));

// will load from the env file, override exiting values in the program environment
let overriding_loader = EnvLoader::new().sequence(EnvSequence::EnvThenInput);

Loader constuction is infallible. When reading from a path, I/O is deferred until the load call. This is to support configurations such as dev/prod and optional loading.

Modifying API

There are situations where modifying the environment is necessary. For example, you may be spawning a child process that reads the environment.

dotenvy provides the load attribute macro for this purpose. To use it, enable the macros feature.

#[dotenvy::load]
#[tokio::main]
async fn main() {
    println!("HOST={}", std::env::var("HOST").unwrap());
}

Because set_var is not thread-safe, the load attribute macro modifies the environment before the async runtime is started. The expansion of this macro is here.

Configuration

load is configurable. The default configuration expands to:

#[dotenvy::load(path = "./env", required = true, override_ = false)]

For more advanced usage, EnvLoader::load_and_modify can be used.

Compile-time loading

The dotenv! macro provided by dotenvy_macro crate can be used.

Minimum Supported Rust Version

We aim to support the latest 8 rustc versions - approximately 1 year. Increasing MSRV is not considered a semver-breaking change.

Why does this fork exist?

The original dotenv crate has not been updated since June 26, 2020. Attempts to reach the authors and present maintainer were not successful (dotenv-rs/dotenv #74).

This fork intends to serve as the development home for the dotenv implementation in Rust.

What are the differences from the original?

This repo adds:

• non-modifying API
• configurable EnvLoader
• optional loading, ergonomic dev/prod handling
• reader support, such as reading from any reader that is io::Read
• more informative Error type, containing the file path and variable name
• load attribute macro
• multiline support
• more examples and docs

For a full list of changes, refer to the changelog.

Contributing

Contributions are welcome! If you are thinking of contributing, please refer to CONTRIBUTING.md.

The legend

Legend has it that the Lost Maintainer will return, merging changes from dotenvy into dotenv with such thrust that all Cargo.tomls will lose one keystroke. Only then shall the Rust dotenv crateverse be united in true harmony.

Until then, this repo dutifully carries on the dotenv torch. It is actively maintained.