README.md

Environment.Configuration

Adds strictly declared configuration to your project when using environment variables.

Usage

Install package

Run the following command in your project root: dotnet add package Environment.Configuration

Create your configuration

Assuming the following environment variables:

MY_CONNECTION_STRING=some://connection.string
MY_BOOLEAN_SETTING=false

public class MyConfiguration : ConfigurationSection
{
    private const string Path = "MyConfguration";

    public MyConfiguration(IConfiguration root) : base(root, Path)
    {
    }

    [ConfigurationProperty("MY_CONNECTION_STRING", IsRequired = true)]
    public string MyConnectionString => Convert.ToString(this["MY_CONNECTION_STRING"]);

    [ConfigurationProperty("MY_BOOLEAN_SETTING", IsRequired = false]]
    public bool MyBooleanSetting => Convert.ToBoolean(this["MY_BOOLEAN_SETTING"]);

    // etc.
}

Use your configuration

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public  IConfiguration Configuration { get; }

    public void ConfigureServices(IServiceCollection services)
    {
        var myConfig = Configuration.GetEnvironmentSection<MyConfiguration>();

        services.AddDbContext<SqlDatabaseContext>(options => 
        {
            options.UseSqlServer(myConfig.MyConnectionString);
        });

        // etc.
    }
}

Error handling

When a property is marked as required by IsRequired = true in the ConfigurationProperty but could not be loaded from the environment or results empty, a ConfigurationErrorsException is thrown telling you which variable is missing.