SimplerConfig 1.0.4
dotnet add package SimplerConfig --version 1.0.4
NuGet\Install-Package SimplerConfig -Version 1.0.4
<PackageReference Include="SimplerConfig" Version="1.0.4" />
paket add SimplerConfig --version 1.0.4
#r "nuget: SimplerConfig, 1.0.4"
// Install SimplerConfig as a Cake Addin #addin nuget:?package=SimplerConfig&version=1.0.4 // Install SimplerConfig as a Cake Tool #tool nuget:?package=SimplerConfig&version=1.0.4
SimplerConfig
This package provides you with a simple-config option for your C# project.
Usage
using SimplerConfig;
var setting = SConfig.Instance["KEY"];
var nestedSetting = SConfig.Instance["TopKey:SubKey"];
Options
- Default Configurations should be placed in
appsettings.json
. - It will be overwritten by settings in
custom.conf.json
- Those settings can be overwritten by Enviroment Variables.
- Finally you can pass settings as CommandLine arguments.
Format
You access sub-elements of JSON
with :
.
Example:
{
"plugin":
{
"name":"SimpleConfig"
}
}
Access with
SimplerConfig.SConfig.Instance["plugin:name"]
You can overwrite it by
- changing it in
custom.conf.json
- setting
plugin:name="YourName"
- or by passing
--plugin:name="AnotherName"
If you can think of a simple way please open an issue 😃
Using Commandline Arguments
To enable the use of commandline arguments
add this at the start of your Main(string[] args)
:
SimplerConfig.Instance.StartArgs = args;
Including JSON Config
By default appsettings.json
and custom.conf.json
aren't copied on build.
If you want to include the settings with your build you have to add the following to your .csproj
file:
[...]
<ItemGroup>
<None Include="custom.conf.json" CopyToOutputDirectory="Always" CopyToPublishDirectory="Always"/>
<None Include="appsettings.json" CopyToOutputDirectory="Always" CopyToPublishDirectory="Always"/>
</ItemGroup>
</Project>
Packaging
This project was packaged with
dotnet pack
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. 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. |
.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. |
-
.NETStandard 2.0
- Microsoft.Extensions.Configuration (>= 5.0.0)
- Microsoft.Extensions.Configuration.CommandLine (>= 5.0.0)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 5.0.0)
- Microsoft.Extensions.Configuration.Json (>= 5.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Moved to SConfig