DotNetCore.Configuration.Formatter 3.1.1

There is a newer version of this package available.
See the version list below for details.
Install-Package DotNetCore.Configuration.Formatter -Version 3.1.1
dotnet add package DotNetCore.Configuration.Formatter --version 3.1.1
<PackageReference Include="DotNetCore.Configuration.Formatter" Version="3.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DotNetCore.Configuration.Formatter --version 3.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: DotNetCore.Configuration.Formatter, 3.1.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. 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=3.1.1

// Install DotNetCore.Configuration.Formatter as a Cake Tool
#tool nuget:?package=DotNetCore.Configuration.Formatter&version=3.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

DotNetCore Configuration formatter

Development Supported by JetBrains Open Source Program:

Rider <a href=""> <img src="" Width="40p" /></a> Fast & powerful, cross platform .NET IDE

ReSharper <a href=""> <img src="" Width="40p" /></a> The Visual Studio Extension for .NET Developers

Version 3.1.0
  • Support SDK v.3.1-*

DotNetCore.Configuration.Formatter is a simple formatter implements configuration-driven templates Microsoft.Extensions.Configuration for generating configuration textual output.

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

For example referencing to values from "secret" section of configuration provider for Example: "Password":"{secret:db-{{environment}}-password}"

Annotation format syntax

Annotation Definition
{Key} If the Key reference will be located/resolved it will be replaced with a value.
{NotFound} If the NotFound reference will not be located it will be replaced with the ?NotFound?.
{NotFound}??Default If the NotFound reference will not be located in it will be replaced with the Default.
{Complex{Complex{ComplexKey3}Key2}Key1} Supports recursive references substitution, it will be replaced with a final constructed reference value.

Asp Net Core

The main area of using is to format (i.e. substitute ) configuration values with other value defined in other configuration providers like Azure KeyVault Secrets, AppRuntime.

Example of using

You have the following

Environment Variables set to :


Secret KeyValaut Configuration Provider loads the following secrets:


"secret:BusConnection":"... azure bus endpoint ... ... "

"secret:DbConnection":"... sql connection string ... ... "

"secret:CosmosDbConnection":"... mongo db connection string ... ... "
Web Service has the following appsettings.json:
     "IsDocker": "{DOTNET_RUNNING_IN_CONTAINER??false}",
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()

or with shorthand

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

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

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?"
  • .NETCoreApp 3.1

    • No dependencies.

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
6.0.2 46 12/28/2021
6.0.1 833 12/1/2021
6.0.0 104 11/16/2021
5.0.1 163 3/11/2021
3.1.1 150 3/11/2021

Supports only net 5.0