TheKrystalShip.Tools.Configuration 1.0.2

.NET Standard 2.0

dotnet add package TheKrystalShip.Tools.Configuration --version 1.0.2

NuGet\Install-Package TheKrystalShip.Tools.Configuration -Version 1.0.2

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="TheKrystalShip.Tools.Configuration" Version="1.0.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="TheKrystalShip.Tools.Configuration" Version="1.0.2" />
                    

                            Directory.Packages.props

<PackageReference Include="TheKrystalShip.Tools.Configuration" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add TheKrystalShip.Tools.Configuration --version 1.0.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: TheKrystalShip.Tools.Configuration, 1.0.2"

#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.

#:package TheKrystalShip.Tools.Configuration@1.0.2

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=TheKrystalShip.Tools.Configuration&version=1.0.2
                    

                            Install as a Cake Addin

#tool nuget:?package=TheKrystalShip.Tools.Configuration&version=1.0.2
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

TheKrystalShip.Tools.Configuration

This library is a static wrapper around Microsoft.Extensions.IConfiguration, exposing exisitng methods through a static Configuration class. Configuration only works with .json files for now.

Usage

There's a couple methods in the Configuration class that need to be called at startup, shown below.

1. Setting the base path

Configuration.SetBasePath(Path.Combine("path", "to", "config", "files"));

2. Adding configuration files

Just specify the file name, they are added as optional with reloadOnChange set to true

Configuration.AddFiles("file1.json", "file2.json", ...);

Using the ConfigurationFile class

// ConfigurationFile[]
Configuration.AddFiles(new ConfigurationFile[] {
	new ConfigurationFile("file1.json", optional: true, reloadOnChange: false),
	new ConfigurationFile("file2.json", optional: false, reloadOnChange: true),
	// etc
});

// IEnumerable<ConfigrationFile>
Configration.AddFiles(new List<ConfigurationFile> { new ConfigurationFile(path: "file1.json", optional: true, reloadOnChange: true) });

// ConfigurationFile
Configuration.AddFile(new ConfigurationFile(path: "file1.json", optional: true, reloadOnChange: true));

Read value

string myValue = Configuration.Get("someKey");

Set value

Configuration.Set("someKey", "myNewValue")

Here's a list of all methods that Configuration offers:

void SetBasePath(string path);
void AddFiles(params string[] files);
void AddFiles(params ConfigurationFiles[] files);
void AddFiles(IEnumerable<ConfigurationFile> files);
string Get(string key);
void Set(string key, string newValue);
string GetConnectionString(string key);
IConfigurationSection GetSection(string key);
IEnumerable<IConfigurationSection> GetChildren();
IChangeToken GetReloadToken();

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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.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.

.NETStandard 2.0
- Microsoft.Extensions.Configuration (>= 2.2.0)
- Microsoft.Extensions.Configuration.Json (>= 2.2.0)

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.2	1,398	2/17/2019

Added ConfigurationFile class to allow per-file path, optional and reloadOnChange properties.
Added a couple method overloads to Configuration.AddFiles(); that use either an array or a IEnumerable<> of ConfigurationFile.
Added single Configuration.AddFile(); method accepting a ConfigurationFile instance.