Aniel.SimpleConf 1.0.1

dotnet add package Aniel.SimpleConf --version 1.0.1
NuGet\Install-Package Aniel.SimpleConf -Version 1.0.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="Aniel.SimpleConf" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Aniel.SimpleConf --version 1.0.1
#r "nuget: Aniel.SimpleConf, 1.0.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 Aniel.SimpleConf as a Cake Addin
#addin nuget:?package=Aniel.SimpleConf&version=1.0.1

// Install Aniel.SimpleConf as a Cake Tool
#tool nuget:?package=Aniel.SimpleConf&version=1.0.1

Aniel.SimpleConf

This is a small Helper for consuming strong typed json config files from a path.

Available via nuget

Changelog

1.0.1

  • Fix: Environment variable gets ignored

1.0.0

  • First Release

Usage

//TestConfig.cs
public class TestConfig
{
  public string TestValue1 { get; set; }
}
//TestConfig.json
{
  "TestValue1": "Conf Test Value 2"
}
var conf = Loader.LoadFile<TestConfig>("TestConf.json");
conf.TestValue1; //Conf Test Value 2

Advanced Usage

It is possible to specify that parts of your config come from other files

//TestConfig.cs
public class TestConfig
{
  public string TestValue1 { get; set; }

  [FileSource("SubFile.json")]
  public TestSubFileConfig subConfig { get; set; }
}

TestConfig.json stays the same

//SubFile.json
{
  "SubFileValue": "SubFileValue Test value"
}
var conf = Loader.LoadFile<TestConfig>("TestConf.json");
conf.TestValue1; //Conf Test Value 2
conf.subConfig.SubFileValue; //SubFileValue Test value

Setting the file config root

You can set the config root

Aniel.SimpleConf.Loader.ConfigRoot = "<path to folder with config files>";

//Make sure you set useConfigRoot
Loader.LoadFile<TestConfig>("TestConf.json", useConfigRoot: true);

Overwriting config root with environment variables

If you set the environment variable CONFIG_ROOT_PATH you can overwrite the config root.

If you want to change the name of the environment variable you can use:

Aniel.SimpleConf.SimpleConfConstants.EnvironmentConfigPathName = "<yor environment variable name>";
Product 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 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 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  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
1.0.1 1,801 2/10/2018
1.0.0 1,088 12/4/2017