SharpDotYaml.Extensions.Configuration 0.3.1

.NET 6.0 .NET Standard 2.0 
dotnet add package SharpDotYaml.Extensions.Configuration --version 0.3.1
NuGet\Install-Package SharpDotYaml.Extensions.Configuration -Version 0.3.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="SharpDotYaml.Extensions.Configuration" Version="0.3.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add SharpDotYaml.Extensions.Configuration --version 0.3.1
#r "nuget: SharpDotYaml.Extensions.Configuration, 0.3.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 SharpDotYaml.Extensions.Configuration as a Cake Addin
#addin nuget:?package=SharpDotYaml.Extensions.Configuration&version=0.3.1

// Install SharpDotYaml.Extensions.Configuration as a Cake Tool
#tool nuget:?package=SharpDotYaml.Extensions.Configuration&version=0.3.1

icon

SharpDotYaml

SharpDotYaml is a C# library designed to support reading and loading YAML files as configuration providers. The parsing is done by YamlDotNet

Features

  • Load YAML files as configuration Microsoft.Extensions.Configuration providers

Installation

To enable SharpDotYaml configuration provider install the NuGet package:

dotnet add package SharpDotYaml.Extensions.Configuration

Usage with Microsoft.Extensions.Configuration

Here's a basic example of how to use SharpDotYaml with Microsoft.Extensions.Configuration:

Install the NuGet package:

dotnet add package SharpDotYaml.Extensions.Configuration

Create a new file at the root of your project called example.yaml with the following contents:

EXAMPLE_VALUE: this is only a test
ExampleSettings:
  Nested:
    Value: this is a nested value

Update the .csproj file for your project and add the following to include the file in the build directory:

  <ItemGroup>
    <None Include="example.yaml">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
  </ItemGroup>

Read the configuration in your project:

using Microsoft.Extensions.Configuration;

var config = new ConfigurationBuilder()
    .AddYamlFile("example.yaml")
    .Build();

// Read values from the configuration
Console.WriteLine("value: {0}, equals: {1}",
    config["EXAMPLE_VALUE"],
    config["EXAMPLE_VALUE"] == "this is only a test");

Console.WriteLine("value: {0}, equals: {1}",
    config["ExampleSettings:Nested:Value"],
    config["ExampleSettings:Nested:Value"] == "this is a nested value");

See also examples/SharpDotYaml.ConfigurationExample

License

SharpDotYaml is licensed under the MIT License

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  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 is compatible.  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 is compatible.  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 is compatible. 
.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
0.3.1 342 2/24/2024
0.3.0 4,608 11/15/2023
0.2.1 112 11/10/2023
0.2.0 89 11/9/2023
0.1.0 94 11/3/2023

• Update YamlDotNet to 15.1.1
• Document current PublicAPI to keep track of breaking changes

Full changelog at https://github.com/vipentti/SharpDotYaml/blob/main/CHANGELOG.md