DotNetCore.Configuration.Formatter
3.1.1
See the version list below for details.
dotnet add package DotNetCore.Configuration.Formatter --version 3.1.1
NuGet\Install-Package DotNetCore.Configuration.Formatter -Version 3.1.1
<PackageReference Include="DotNetCore.Configuration.Formatter" Version="3.1.1" />
paket add DotNetCore.Configuration.Formatter --version 3.1.1
#r "nuget: DotNetCore.Configuration.Formatter, 3.1.1"
// 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
DotNetCore Configuration formatter
Development Supported by JetBrains Open Source Program:
Rider <a href="https://www.jetbrains.com/?from=XmlResult"> <img src="https://github.com/Wallsmedia/XmlResult/blob/master/Logo/rider/logo.png?raw=true" Width="40p" /></a> Fast & powerful, cross platform .NET IDE
ReSharper <a href="https://www.jetbrains.com/?from=XmlResult"> <img src="https://github.com/Wallsmedia/XmlResult/blob/master/Logo/resharper/logo.png?raw=true" Width="40p" /></a> The Visual Studio Extension for .NET Developers
DotNetCore.Configuration.Formatter
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}"
Nuget.org
- Nuget package DotNetCore.Configuration.Formatter
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 :
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.
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 | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 | netcoreapp3.1 is compatible. |
-
.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 |
---|---|---|
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 only net 5.0