Philiprehberger.EnvValidator 0.2.9

Philiprehberger.EnvValidator

Declarative environment variable validation for .NET — attribute-based binding with type coercion.

Installation

dotnet add package Philiprehberger.EnvValidator

Usage

using Philiprehberger.EnvValidator;

// Define your config class
public class AppConfig
{
    [EnvVar("DATABASE_URL")]
    public string DatabaseUrl { get; set; } = "";

    [EnvVar("PORT", Default = "3000")]
    public int Port { get; set; }

    [EnvVar("LOG_LEVEL", Required = false, Choices = new[] { "debug", "info", "warn", "error" })]
    public string LogLevel { get; set; } = "info";

    [EnvVar("ENABLE_CACHE", Default = "true")]
    public bool EnableCache { get; set; }

    [EnvVar("REQUEST_TIMEOUT", Default = "00:00:30")]
    public TimeSpan RequestTimeout { get; set; }
}

// Validate from environment
var config = EnvValidator.Validate<AppConfig>();

// Validate from a dictionary (useful for testing)
var config = EnvValidator.Validate<AppConfig>(new Dictionary<string, string>
{
    ["DATABASE_URL"] = "postgresql://localhost/mydb",
    ["PORT"] = "8080",
});

Enum Support

Enum properties are parsed case-insensitively. Invalid values produce an error listing all valid options.

public enum Environment { Development, Staging, Production }

public class AppConfig
{
    [EnvVar("APP_ENV", Default = "Development")]
    public Environment AppEnv { get; set; }
}

Setting APP_ENV=production will correctly parse to Environment.Production.

Pattern Validation

Use the Pattern property to validate values against a regex before type conversion.

public class AppConfig
{
    [EnvVar("API_KEY", Pattern = @"^sk-[a-zA-Z0-9]{32}$")]
    public string ApiKey { get; set; } = "";

    [EnvVar("PORT", Pattern = @"^\d{4,5}$", Default = "3000")]
    public int Port { get; set; }
}

If the value doesn't match, validation fails with: Variable 'API_KEY' does not match required pattern '^sk-[a-zA-Z0-9]{32}$'.

Collection Parsing

Properties of type string[], int[], List<string>, or List<int> are parsed by splitting the value on a separator (comma by default). Whitespace around each element is trimmed.

public class AppConfig
{
    [EnvVar("ALLOWED_ORIGINS")]
    public string[] AllowedOrigins { get; set; } = [];

    [EnvVar("RETRY_DELAYS")]
    public List<int> RetryDelays { get; set; } = [];

    [EnvVar("TAGS", Separator = ";")]
    public List<string> Tags { get; set; } = [];
}

Setting ALLOWED_ORIGINS=https://example.com, https://app.example.com parses into a two-element string array. Use the Separator property to change the delimiter.

Error Handling

try
{
    var config = EnvValidator.Validate<AppConfig>();
}
catch (ValidationException ex)
{
    foreach (var error in ex.Errors)
        Console.WriteLine(error);
}

API

EnvValidator

EnvVarAttribute

Supported Types

string, int, long, double, bool, Uri, TimeSpan, enums, string[], int[], List<string>, List<int>

Bool accepts: true/false, 1/0, yes/no, on/off

Attribute Properties

Development

dotnet build src/Philiprehberger.EnvValidator.csproj --configuration Release

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT