YamlConfiguration 1.0.1

YamlConfiguration

YamlConfiguration is a small library to support the YAML format for .NET configuration files, nothing else.

Note Package code it's an adaptation of YAML functionality from a popular (but obsolete) FlexibleConfiguration NuGet package. Unlike FlexibleConfiguration it uses .NET native configuration infrastructure and SharpYaml instead of YamlDotNet to support YAML.

Supported Platforms

• .NET 5 and higher
• .NET Core 2.0 and higher
• .NET Framework 4.6.1 and higher

Getting the Code

• Nuget: install-package YamlConfiguration or dotnet add package YamlConfiguration
• Source code: git clone git@github.com:RedKorshun/YamlConfiguration.git

How to use

Example for console application:

using System;
using System.IO;
using System.Threading.Tasks;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

namespace YamlConfigurationHowTo
{
    internal sealed class Startup
    {
        internal static async Task Main(String[] args)
        {
            IHostBuilder hostBuilder = new HostBuilder()
                .ConfigureAppConfiguration(ConfigureConfiguration)
                .ConfigureServices(ConfigureServices);

            await hostBuilder.RunConsoleAsync();
        }

        private static void ConfigureConfiguration(IConfigurationBuilder config)
        {
            config
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddYamlFile("appsettings.yaml", optional: false) // <-- Exactly what this package provides
            ;
        }

        private static void ConfigureServices(IServiceCollection services)
        {
            services
                .AddHostedService<ApplicationManager>() // <-- Your IHostedService implementation
                // Your dependency injection bindings
            ;
        }
    }
}

License

Expat for YamlConfiguration and Apache 2.0 for the source code from FlexibleConfiguration.

Alternatives

• NetEscapades.Configuration.Yaml - uses YamlDotNet which is an old and popular but currently its further developing is on hold.
• other.