Json5.Configuration 1.0.2

.NET 8.0

dotnet add package Json5.Configuration --version 1.0.2

NuGet\Install-Package Json5.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="Json5.Configuration" Version="1.0.2" />

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

<PackageVersion Include="Json5.Configuration" Version="1.0.2" />
                    

                            Directory.Packages.props

<PackageReference Include="Json5.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 Json5.Configuration --version 1.0.2

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

#r "nuget: Json5.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 Json5.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=Json5.Configuration&version=1.0.2
                    

                            Install as a Cake Addin

#tool nuget:?package=Json5.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.

The Json5.Configuration package integrates JSON5 files with the Microsoft.Extensions.Configuration infrastructure, so you can use JSON5 anywhere standard JSON configuration is used.

AddJson5File

using Json5;

var config = new ConfigurationBuilder()
    .AddJson5File("appsettings.json5")
    .AddJson5File("appsettings.Development.json5", optional: true, reloadOnChange: true)
    .Build();

The file supports all JSON5 extensions — comments, trailing commas, unquoted keys, etc.:

// appsettings.json5
{
    Logging: {
        LogLevel: {
            Default: "Information",
            // Silence noisy namespaces
            "Microsoft.AspNetCore": "Warning",
        },
    },
    ConnectionStrings: {
        Default: "Server=localhost;Database=MyApp",
    },
}

AddJson5Stream

using Json5;

using var stream = File.OpenRead("config.json5");

var config = new ConfigurationBuilder()
    .AddJson5Stream(stream)
    .Build();

Json5ReaderOptions

Pass Json5ReaderOptions via the source action to control special number handling, max depth, and auto-dedent:

var config = new ConfigurationBuilder()
    .AddJson5File(source =>
    {
        source.Path = "appsettings.json5";
        source.Optional = true;
        source.ReloadOnChange = true;
        source.Json5ReaderOptions = new Json5ReaderOptions
        {
            AutoDedent = true,
            SpecialNumbers = SpecialNumberHandling.AsNull
        };
    })
    .Build();

Open Source Maintenance Fee

To ensure the long-term sustainability of this project, users of this package who generate revenue must pay an Open Source Maintenance Fee. While the source code is freely available under the terms of the License, this package and other aspects of the project require adherence to the Maintenance Fee.

To pay the Maintenance Fee, become a Sponsor at the proper OSMF tier. A single fee covers all of Devlooped packages.