Name: Config.Net
Author: Ivan Gavryliuk (@aloneguid)

Config.Net v5.2.0 — nugetz

using Config.Net;

public interface IMySettings
{
    string AuthClientId { get; }

    string AuthClientSecret { get; }
}

IMySettings settings = new ConfigurationBuilder<IMySettings>()
   .UseAppConfig()
   .Build();

public interface IMySettings
{
   [Option(Alias = "clientId")]
   string AuthClientId { get; }
}

public interface IMySettings
{
   [Option(Alias = "clientId", DefaultValue = "n/a")]
   string AuthClientId { get; }
}

public interface IMySettings
{
   [Option(DefaultValue = "n/a")]
   string AuthClientId { get; }
}

public interface IMySettings
{
   [DefaultValue("n/a")]
   string AuthClientId { get; }
}

c.AuthClientId = "new value";

string AuthClientId { get; set; }

public interface ICreds
{
   string Username { get; }

   string Password { get; }
}

public interface IConfig
{
   ICreds Admin { get; }

   ICreds Normal { get; }
}

_config = new ConfigurationBuilder<IConfig>()
   .Use...
   .Build();

interface IMyConfig
{
   IEnumerable<int> Numbers { get; }
}

interface ICredentials
{
   string Username { get; }
   string Password { get; }
}

interface IMyConfig
{
   IEnumerable<ICredentials> AllCredentials { get; }
}

public interface ICallableConfig
{
   string GetName(string keyName);
}

public interface ICallableConfig
{
   [Option(Alias = "CustomName")]
   string GetName(string keyName);
}

public interface ICallableConfig
{
   string GetName(string keyName, string subKeyName);
}

public interface ICallableConfig
{
   void SetName(string keyName, string value);
}

public interface IMyConfiguration : INotifyPropertyChanged
{
   string Name { get; set; }
}

IMyConfiguration config = new ConfigurationBuilder<IMyConfiguration>()
   //...
   .Build();

config.PropertyChanged += (sender, e) =>
{
   Assert.Equal("Name", e.PropertyName);
};

config.Name = "test";   //this will trigger PropertyChanged delegate

//collection element
public interface IArrayElement
{
   string Username { get; }

   string Password { get; }
}

//top level configuration
public interface IConfig
{
   IEnumerable<IArrayElement> Creds { get; }
}

"Creds": [
   {
      "Username": "user1",
      "Password": "pass1"
   },
   {
      "Username": "user2",
      "Password":  "pass2"
   }
]

myapp.exe Creds.$l=2 Creds[0].Username=user1 Creds[0].Password=pass1 Creds[1].Username=user2 Creds[1].Password=pass2

public interface ISimpleArrays
{
   IEnumerable<int> Numbers { get; }
}

myapp.exe Numbers="1 2 3"

IMySettings settings = new ConfigurationBuilder<IMySettings>()
   .UseAppConfig()
   .Build();

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
   <configSections>
      <section name="MySection" type="System.Configuration.NameValueSectionHandler"/>
   </configSections>
   <appSettings>
      <add key="AppKey" value="TestValue"/>
   </appSettings>
   <connectionStrings>
      <add name="MyConnection" connectionString="testconn"/>
   </connectionStrings>
   <MySection>
      <add key="MyKey" value="MyCustomValue"/>
   </MySection>
</configuration>

   public interface IConfig
   {
      string AppKey { get; }

      string MyConnection { get; }

      [Option(Alias = "MySection.MyKey")]
      string MySectionKey { get; }
   }

IMySettings settings = new ConfigurationBuilder<IMySettings>()
   .UseCommandLine()
   .Build();

public interface IConsoleCommands
{
   [Option(DefaultValue = "download")]
   string Action { get; }

   string FilePath { get; }
}

//...


IConsoleCommands settings =
   new ConfigurationBuilder<IConsoleCommands>()
   .UseCommandLineArgs(
      new KeyValuePair<string, int>(nameof(IConsoleCommands.Action), 1),
      new KeyValuePair<string, int>(nameof(IConsoleCommands.FilePath), 2))
   .Build();

IMySettings settings = new ConfigurationBuilder<IMySettings>()
   .UseEnvironmentVariables()
   .Build();

IMySettings settings = new ConfigurationBuilder<IMySettings>()
   .UseDotEnvFile()
   .Build();

IMySettings settings = new ConfigurationBuilder<IMySettings>()
   .UseInMemoryDictionary()
   .Build();

IMySettings settings = new ConfigurationBuilder<IMySettings>()
   .UseIniFile(filePath)
   .Build();

IMySettings settings = new ConfigurationBuilder<IMySettings>()
   .UseIniString(contentsOfAnIniFile)
   .Build();

string MyOption { get; }

MyOption=my fancy value

[SectionOne]
MyOption=my fancy value

[Option(Alias = "SectionOne.MyOption")]
string MyOption { get; }

key1=value1 ;this comment is preserved
;this comments is preserved too

.UseIniFile(string iniFilePath, bool parseInlineComments = false);

// or

.UseIniString<TInterface>(string iniString, bool parseInlineComments = false);

IMySettings settings = new ConfigurationBuilder<IMySettings>()
   .UseJsonFile(path)
   .Build();

IMySettings settings = new ConfigurationBuilder<IMySettings>()
   .UseJsonString(path)
   .Build();

public interface IMySettings
{
   string AuthClientId { get; }
   string AuthClientSecreat { get; }
}

{
   "AuthClientId": "Id",
   "AuthClientSecret": "Secret"
}

public interface IMySettings
{
   string AuthClientId { get; }
   string AuthClientSecreat { get; }
   
   [Option(Alias = "WebService.Host")]
   string ExternalWebServiceHost { get; }
}

{
   "AuthClientId":"Id",
   "AuthClientSecret":"Secret",
   
   "WebService": {
       "Host": "http://blahblah.com:3000"
   }
}

aloneguid/Config.Netv5.2.0

Get Started

Readme

Config.Net

Quick Start

Declare settings interface

Which Data Types are Supported?

System.Net.NetworkCredential

String Arrays

Using Multiple Sources

Changing property behaviour

Aliases

Default values

DefaultValueAttribute

Writing Settings

Nested Interfaces

Collections

Primitive Types

Interfaces

Limitations

Binding To Methods

Multiple Parameters

Writing Values

INotifyPropertyChanged Support

Flatline Syntax

Complex Structures

Simple Structures

Configuration Sources

AppConfig Store

Collections

Command Line

Conventions

Unnamed parameters

Examples

Recognizable Parameters

Positional parameters

Collections

Environment Variables

Collections

.env files

InMemory

Collections

INI

Configuring

Mapping to file

Mapping to file contents

Using

Using Sections

Writing

Edge Cases

A note on INI comments

Collections

JSON

Configuring

Mapping to file

Mapping to file contents

Using

Using a setting that has a non trivial JSON Path

Using With

Azure Functions

Sponsorship

Why charge/sponsor for open source?

Backers

Sponsors

Special Thanks

`System.Net.NetworkCredential`

`.env` files