SimplerConfig 1.0.1

There is a newer version of this package available.
See the version list below for details.

dotnet add package SimplerConfig --version 1.0.1

NuGet\Install-Package SimplerConfig -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="SimplerConfig" Version="1.0.1" />

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

<PackageVersion Include="SimplerConfig" Version="1.0.1" />
                    

                            Directory.Packages.props

<PackageReference Include="SimplerConfig" />
                    

                            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 SimplerConfig --version 1.0.1

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

#r "nuget: SimplerConfig, 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.

#:package SimplerConfig@1.0.1

#: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=SimplerConfig&version=1.0.1
                    

                            Install as a Cake Addin

#tool nuget:?package=SimplerConfig&version=1.0.1
                    

                            Install as a Cake Tool

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

SimplerConfig

This package provides you with a simple-config option for your C# project.

Usage

using SimplerConfig;
var setting = Config.Instance["KEY"];
var nestedSetting = Config.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.Config.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>

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

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

Version	Downloads	Last Updated
1.0.4	27,000	8/18/2021
1.0.3	450	8/18/2021
1.0.2	603	3/28/2021
1.0.1	525	3/22/2021
1.0.0	1,585	9/18/2020

Moved to SConfig