aemarcoToolboxAppOptions 3.1.10

There is a newer version of this package available.
See the version list below for details.
dotnet add package aemarcoToolboxAppOptions --version 3.1.10
NuGet\Install-Package aemarcoToolboxAppOptions -Version 3.1.10
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="aemarcoToolboxAppOptions" Version="3.1.10" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add aemarcoToolboxAppOptions --version 3.1.10
#r "nuget: aemarcoToolboxAppOptions, 3.1.10"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install aemarcoToolboxAppOptions as a Cake Addin
#addin nuget:?package=aemarcoToolboxAppOptions&version=3.1.10

// Install aemarcoToolboxAppOptions as a Cake Tool
#tool nuget:?package=aemarcoToolboxAppOptions&version=3.1.10

aemarcoToolboxAppOptions

<a href=https://www.nuget.org/packages/aemarcoToolboxAppOptions><img src="https://buildstats.info/nuget/aemarcoToolboxAppOptions"></a><br/>

Overview

This package provides a opinionated approach to the Options pattern described in the Microsoft docs. With minimal setup, all the Option classes will be registered in the IOC container and mapped to the IConfiguration source.

  • Automatic mapping of sections to classes (convention driven, but can be adjusted)
  • Beside registering the interfaces from Microsoft, registers the class itself as well (singleton)
  • Registers also interfaces which you put on the settings class
  • Allows text transformations between IConfiguration and the settings class
  • Option to use fluent validation on settings
  • Option to validate settings during startup (on by default, opt-out in options)

Get Started

During startup of the app

{
  services.AddConfigOptionsUtils(config);
}

Create your class representing your options

{
  public class MySettings : ISettingsBase
  {
    public string? Text { get; set; }
    public bool Enable { get; set; }
  }
}

In appsetting.json (or other IConfiguration source)

{
    "MySettings": {
        
        "Text": "SomeText",
        "Enable": true
    }
}

StringTransformation

String transformations will be executed in the order defined in the setup process. You could define your own, but PlaceholderTransformation is built in already.

{
    services.AddConfigOptionsUtils(
        config,
        x => x
            .AddStringTransformation(new PlaceholderTransformation());
}

PlaceholderTransformation does resolve placeholders {{{...}}} through the entire IConfguration by Key. That maybe usefull when piecing together file or url path.

{
    "Message": "Hello world!",
    "MySettings": {
        
        "Text": "The message is {{{Message}}}",
        "Enable": true
    }
}

Fluent Validation

Just define your Validators in the assemblies where setting classes are defined. The tool will register them, and use them if present. By default, Validation takes place at startup.

{
    services.AddConfigOptionsUtils(
        config,
        x => x
            .EnableValidationOnStartup(false); //on by default
}

Setting classes in multiple assemblies

The tool relies on assembly scanning during the setup. If your option classes are in other assemblies, you may pass one of the types as assembly marker, and/or use the assemblies itself.

{
    services.AddConfigOptionsUtils(
        config,
        x => x
            .AddAssemblyMarker(typeof(MySettings))
            // and/or
            .AddAssemblies(someAssemblies));
}

Mapping Path

By default, the class name is exactly matched to the root level of the configuration. You may define your own path in the settings class

{
  [SettingsPath("Settings")]
  public class MySettings : ISettingsBase
  {
    public string? Text { get; set; }
    public bool Enable { get; set; }
  }
}

would map to

{
    "Settings": {
        
        "Text": "SomeText",
        "Enable": true
    }
}

You could even do it nested, just use the colon seperated path as you would with GetSection().

{
  [SettingsPath("Settings:Nested")]
  public class MySettings : ISettingsBase
  {
    public string? Text { get; set; }
    public bool Enable { get; set; }
  }
}

would map to

{
    "Settings": {
        "Nested":{
            "Text": "SomeText",
            "Enable": true
        }
    }
}
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on aemarcoToolboxAppOptions:

Package Downloads
aemarcoWpfTools

c# wpf tools collection

aemarcoWebTools

c# web tools collection

aemarcoConsoleTools

c# console tools collection

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.1.17 76 4/12/2024
3.1.16 86 4/4/2024
3.1.15 101 3/22/2024
3.1.11 86 3/19/2024
3.1.10 83 2/16/2024
3.1.7 107 2/11/2024
3.1.6 91 2/11/2024
3.1.5 85 2/11/2024
3.1.4 85 2/11/2024
3.0.18 113 1/29/2024
3.0.17 73 1/29/2024
3.0.16 75 1/27/2024
3.0.15 74 1/27/2024
3.0.8 69 1/27/2024
3.0.7 132 1/13/2024
2.0.18 137 1/4/2024
2.0.17 147 1/1/2024
2.0.16 144 12/27/2023
2.0.15 131 12/26/2023
2.0.14 134 12/26/2023
2.0.13 115 12/25/2023
2.0.11 94 12/23/2023
2.0.10 139 12/16/2023
2.0.9 120 12/15/2023
2.0.8 132 12/14/2023
2.0.7 116 12/13/2023
2.0.5 141 12/11/2023
2.0.4 135 12/11/2023
2.0.2 141 12/10/2023
1.9.2 107 12/10/2023
1.8.4 152 12/10/2023
1.8.3 153 12/9/2023
1.8.2 143 12/9/2023
1.1.28 177 11/27/2023
1.1.27 134 11/26/2023
1.1.26 159 11/18/2023
1.1.25 119 11/17/2023
1.1.24 189 10/30/2023
1.1.23 164 10/29/2023
1.1.22 163 10/22/2023
1.1.21 175 10/17/2023
1.1.20 183 9/16/2023
1.1.19 246 8/27/2023
1.1.18 182 7/31/2023
1.1.17 219 7/16/2023
1.1.16 209 7/9/2023
1.1.15 231 7/8/2023
1.1.14 238 7/5/2023
1.1.13 218 6/29/2023
1.1.12 217 5/1/2023
1.1.11 401 3/5/2023
1.1.10 362 3/3/2023
1.1.9 368 2/28/2023
1.1.7 385 2/26/2023
1.1.6 375 2/26/2023
1.1.5 254 2/26/2023
1.1.3 244 2/25/2023