Skip to content

feat(dotenv): Adding support for dotenv files #710

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(dotenv): Adding support for dotenv files #710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ yaml = ["yaml-rust2"]
ini = ["rust-ini"]
json5 = ["json5_rs", "dep:serde-untagged"]
corn = ["dep:corn"]
dotenv = ["dep:dotenvy"]
convert-case = ["convert_case"]
preserve_order = ["indexmap", "toml?/preserve_order", "serde_json?/preserve_order", "ron?/indexmap"]
async = ["async-trait"]
Expand All @@ -143,6 +144,7 @@ rust-ini = { version = "0.21.3", optional = true }
ron = { version = "0.8.1", optional = true }
json5_rs = { version = "0.4.1", optional = true, package = "json5" }
corn = { version = "0.10.0", optional = true, package = "libcorn" }
dotenvy = { version = "0.15.7", optional = true }
indexmap = { version = "2.11.4", features = ["serde"], optional = true }
convert_case = { version = "0.6.0", optional = true }
pathdiff = "0.2.3"
Expand Down
19 changes: 19 additions & 0 deletions src/file/format/dotenv.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
use std::error::Error;
use std::io::Cursor;

use crate::map::Map;
use crate::value::{Value, ValueKind};

pub(crate) fn parse(
uri: Option<&String>,
text: &str,
) -> Result<Map<String, Value>, Box<dyn Error + Send + Sync>> {
let mut map: Map<String, Value> = Map::new();
let str_iter = dotenvy::Iter::new(Cursor::new(text));
for item in str_iter {
let (key, value) = item?;
map.insert(key, Value::new(uri, ValueKind::String(value)));
}

Ok(map)
}
17 changes: 17 additions & 0 deletions src/file/format/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ mod json5;
#[cfg(feature = "corn")]
mod corn;

#[cfg(feature = "dotenv")]
mod dotenv;

/// File formats provided by the library.
///
/// Although it is possible to define custom formats using [`Format`] trait it is recommended to use `FileFormat` if possible.
Expand Down Expand Up @@ -57,6 +60,10 @@ pub enum FileFormat {
/// Corn (parsed with `libcorn`)
#[cfg(feature = "corn")]
Corn,

/// Dotenv (parsed with `dotenvy`)
#[cfg(feature = "dotenv")]
Dotenv,
Comment on lines +63 to +66
Copy link
Contributor

@epage epage Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this work as another FileFormat / Source? I suspect there is a lot of design overlap with Environment that we'd want to make this functionality on that.

Copy link
Author

@chickencoding123 chickencoding123 Oct 23, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is another FileFormat. You can see the usage from the tests (added snippet for ref. here). It is similar to existing file formats. Also dotenvy dependency will take care of the overlap, if any. However I ensured OS env take precedence as per existing file formats.

 let s = Config::builder()
        .add_source(config::File::from_str(
            r#"
                FOO=bar
                BAZ=qux
            "#,
            config::FileFormat::Dotenv,
        ))
        .build()
        .unwrap();

Copy link
Contributor

@epage epage Oct 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI resolving conversations that aren't ready for it can make PR reviews more difficult on maintainers. You should be pretty confident that you understood the concern and responded to it as the maintainer expected to resolve it. That was not the case here.

Some traits of dotenv are

  • Stringly typed (so is ini)
  • Unstructured

Both of these characteristics are shared with Environment which has a lot of functionality for solving these problems. In fact, this is another form of environment variables! The only difference is it also shares some of the file loading characteristics of file formats.

Copy link
Contributor

@epage epage Oct 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've raised this (and other questions) at #16 (comment) as I prefer to work out high level designs in Issues rather than PRs.

Copy link
Author

@chickencoding123 chickencoding123 Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated to strike a balance between dotenv ambitions and preferences of this repository.

Copy link
Contributor

@epage epage Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not aware of any dotenv "ambitions" that come in conflict with "preferences of this repository". Also, for any "preferences" I'm giving, they are about fully supporting dotenv rather than doing it party way.

}

impl FileFormat {
Expand All @@ -76,6 +83,8 @@ impl FileFormat {
FileFormat::Json5,
#[cfg(feature = "corn")]
FileFormat::Corn,
#[cfg(feature = "dotenv")]
FileFormat::Dotenv,
]
}

Expand All @@ -102,13 +111,17 @@ impl FileFormat {
#[cfg(feature = "corn")]
FileFormat::Corn => &["corn"],

#[cfg(feature = "dotenv")]
FileFormat::Dotenv => &["dotenv"],

#[cfg(all(
not(feature = "toml"),
not(feature = "json"),
not(feature = "yaml"),
not(feature = "ini"),
not(feature = "ron"),
not(feature = "json5"),
not(feature = "dotenv"),
))]
_ => unreachable!("No features are enabled, this library won't work without features"),
}
Expand Down Expand Up @@ -141,13 +154,17 @@ impl FileFormat {
#[cfg(feature = "corn")]
FileFormat::Corn => corn::parse(uri, text),

#[cfg(feature = "dotenv")]
FileFormat::Dotenv => dotenv::parse(uri, text),

#[cfg(all(
not(feature = "toml"),
not(feature = "json"),
not(feature = "yaml"),
not(feature = "ini"),
not(feature = "ron"),
not(feature = "json5"),
not(feature = "dotenv"),
))]
_ => unreachable!("No features are enabled, this library won't work without features"),
}
Expand Down
3 changes: 3 additions & 0 deletions tests/testsuite/.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
foobar="I am FOOBAR envfile"
foo="I am foo envfile"
bar="I am BAR envfile"
3 changes: 3 additions & 0 deletions tests/testsuite/.env.local
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
foobar="I am FOOBAR envfile local"
foo="I am foo envfile local"
bar="I am BAR envfile local"
Loading