Configuration Module¶

The Configuration module has two complementary concerns:

• [ConfigRoot] — host-level, generates strongly-typed configuration providers with interfaces, DI registration, JSON Schema output, and secrets management. This is where config files (schema, settings, secrets) are generated.
• [ConfigModule] — context-level, provides typed config access via runtime effects. Use this to compose configuration into effect pipelines with compile-time capability constraints.

Quick Start¶

using Deepstaging.Config;

// Define config types
public sealed record SmtpSettings(string Host, int Port);

public class SmtpSecrets
{
    [Secret]
    public string Password { get; init; } = "";
}

// Host-level: ConfigRoot generates config files, schema, DI registration
[ConfigRoot(Section = "Smtp")]
[Exposes<SmtpSettings>]
[Exposes<SmtpSecrets>]
public sealed partial class SmtpConfigRoot;

// Context-level: ConfigModule provides effect-based config access
[ConfigModule]
[Exposes<SmtpSettings>]
public static partial class SmtpConfigModule;

[ConfigRoot] generates:

• ISmtpConfigRoot — interface exposing the configuration properties
• Partial class implementation — binds properties from IConfiguration["Smtp"]
• DI extension method — services.AddSmtpConfigRoot(configuration)
• Configuration source method — builder.ConfigureSmtpConfigRootSources()

[ConfigModule] generates:

• SmtpConfigModuleProvider — wraps IOptions<T> for each exposed type
• IHasSmtpConfigModule — capability interface for runtime constraints
• Effect accessor — SmtpConfigModule.SmtpSettings<RT>()
• DI extension — services.AddSmtpConfigModule()

Access configuration in effect compositions via [ConfigModule]:

from settings in SmtpConfigModule.SmtpSettings<AppRuntime>()
let host = settings.Host

Sub-pages¶

Diagnostics¶