DotNetCore.Configuration.Formatter 6.4.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package DotNetCore.Configuration.Formatter --version 6.4.1                
NuGet\Install-Package DotNetCore.Configuration.Formatter -Version 6.4.1                
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="DotNetCore.Configuration.Formatter" Version="6.4.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DotNetCore.Configuration.Formatter --version 6.4.1                
#r "nuget: DotNetCore.Configuration.Formatter, 6.4.1"                
#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 DotNetCore.Configuration.Formatter as a Cake Addin
#addin nuget:?package=DotNetCore.Configuration.Formatter&version=6.4.1

// Install DotNetCore.Configuration.Formatter as a Cake Tool
#tool nuget:?package=DotNetCore.Configuration.Formatter&version=6.4.1                

DotNetCore Configuration Templates

DotNetCore.Configuration.Formatter is a simple Configuration ASP.NET Core Templates for Microsoft.Extensions.Configuration. It is used Configuration Providers for generating configuration value text output by substituting Configuration Key with its Value.

Annotations '{...}' in the template refer to elements of the configuration data structure. It allows to application configuration values to be resloved and formatted with using key values of other configuration sections and providers.

Nuget.org

Version: 6.4.1

  • Add {Key??{DefaultKey}} full support

Version: 6.4.0

  • Big configuration perfomance improvement

Version: 6.3.x

.Net Core App support

  • Supports: net 6.0, net48, netstandard2.0, netstandard2.1
  • Azure Function Support
    • ResolveKeyValue
    • ResolveAllKeyValues
    • AllConfigurationKeys
    • {Key??} feature
    • {Key??null} feature

Annotation format syntax

Annotation Definition
{ Key } If the Key reference will be resolved; it will be replaced with a value. If {Key} is not found, it will not be replaced and recursive references substitution will be cancelled,i.e JSON frendly.
{{{Key3}Key2}Key1} Supports recursive references substitution, it will be replaced with a final constructed reference value.
{Key??DefaultValue} If the Key reference will not be resolved in it will be replaced with the Default.
{Key??{DefaultKey}} If the Key reference will not be resolved in it will be replaced with the DefaultKey value.
{Key??} If the Key reference will not be resolved in it will be replaced with the string.Empty.
{Key??null} If the Key reference will not be resolved in it will be replaced with null.

Azure Key Vault Integration

Can be used in conjunction with DotNetCore Azure Configuration KeyVault Secrets. Can be used in conjunction with DotNetCore Azure Configuration KeyVault Certificates

How to use

For example you have the following:

Environment Variables set to :
DOTNET_RUNNING_IN_CONTAINER=true
...
host_environmet=datacenter
Secret KeyValaut Configuration Provider loads the following secrets:

DotNetCore.Azure.Configuration.KvSecrets

"secret:BusConnection":"... azure bus endpoint ... ... "
"secret:DbConnection":"... sql connection string ... ... "
"secret:CosmosDbConnection":"... mongo db connection string ... ... "
Web Service has the following appsettings.json:
{
  ApplicationConfiguration:{
     "IsDocker": "{DOTNET_RUNNING_IN_CONTAINER??false}",
     "RunLocation":"{host_environmet??local}"
     "BusConnection":"{secret:BusConnection}"
     "DbConnection":"{secret:DbConnection}",
     "CosmosDbConnection":"{secret:CosmosDbConnection}"
  }
}
Web Service has the ApplicationConfiguration.cs

public class ApplicationConfiguration 
{
     public bool IsDocker {get; set;}
     public string RunLocation {get; set;}
     public string BusConnection {get; set;}
     public string DbConnection {get; set;}
     public string CosmosDbConnection {get; set;}
}
Web Service has the Startup.cs

     var applicationConfig = Configuration.UseFormater()
     .GetSection(nameof(ApplicationConfiguration))
     .Get<ApplicationConfiguration>();

or with shorthand


     var applicationConfig = Configuration.GetTypeNameFormatted<ApplicationConfiguration>();

The Web Service will be provided with filly resolved configuration with Azure Key Vault secrets.

Azure Function Support

Some software used a dynamic IConfiguration in the code. In this case "DotNetCore Configuration Templates" doesn't work. For example it is Azure Functions. There added a special feature ResolveKeyValue.

    var configuration = ... // Get IConfiguration
    var keyToResolve = "MyConfigurationKey".
    var isUpdated = configuration.ResolveKeyValue(keyToResolve);

Resolve all keys in a configuration.

    var configuration = ... // Get IConfiguration
    var isUpdated = configuration.ResolveAllKeyValues();

Dot Net Core

Example for a string formatting:
 var keyValues = new Dictionary<string, string>()
 {
     ["Key-1"] = "Value-1",
     ["Key-Value-1"] = "Complex-Value-1"
 };
 var format = "Get the {Key-1} and complex: {Key-{Key-1}} and {none??Default} and {NotFound}";
 var formatted = format.FormatString(keyValues);

Formated string will be 
    "Get the Value-1 and complex: Complex-Value-1 and Default {NotFound}"
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 is compatible.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
8.0.0 724 11/18/2023
7.2.1 222 4/22/2023
7.1.1 286 3/8/2023
7.0.2 328 12/15/2022
7.0.0 556 11/12/2022
6.4.1 245 4/22/2023
6.3.1 258 3/8/2023
6.2.2 332 12/15/2022
6.1.1 494 2/13/2022
6.0.2 303 12/28/2021
6.0.1 1,101 12/1/2021
6.0.0 356 11/16/2021
5.0.1 432 3/11/2021
3.1.1 401 3/11/2021

Supports net6.0;net48;netstandard2.1;netstandard2.0. JSON frendly.