NYamlConfigHelper 1.0.1

NYamlConfigHelper

YAML configuration library for .NET Framework 4.7.2 and .NET Standard 2.0. It supports complete object, list, item, and dictionary serialization plus atomic updates of individual keys in nested configuration trees.

Object and list serialization

var serializer = new NYamlConfig<MySettings>();
serializer.Serialize(path, settings);
MySettings loaded = serializer.Deserialize(path);

var items = new NYamlConfig<MyItem>();
items.SerializeList(path, source);
List<MyItem> loadedItems = items.DeserializeList(path);

Work with one list item

int index = items.AddItem(path, newItem);
MyItem item = items.ReadItem(path, index);

items.WriteItem(path, index, changedItem);
MyItem removed = items.RemoveItem(path, index);

List indexes are zero-based. Item changes rewrite the list atomically.

Read and write nested keys

var config = new YamlConfigFile(path);

config.WriteValue("mainUI", "machineName", "EVI-01");
config.WriteValue("motion/axisX", "timeoutMs", 3000);

string machineName = config.ReadValue("mainUI", "machineName", "Unknown");
int timeout = config.ReadValue("motion/axisX", "timeoutMs", 1000);

The result is normal YAML:

mainUI:
  machineName: EVI-01
motion:
  axisX:
    timeoutMs: 3000

Tree paths accept / or \. Updating one key preserves unrelated trees and values.

Use a variable name as its key

string machineName = "EVI-01";
config.WriteVariable("mainUI", () => machineName);

machineName = config.ReadVariable("mainUI", () => machineName);

Local variables, fields, and properties are supported.

Dictionary serialization

Write a complete dictionary to its own YAML file:

NYamlConfig.SerializeDictionary(path, values);

Dictionary<string, int> loaded =
    NYamlConfig.DeserializeDictionary<string, int>(path);

Or merge a string-keyed dictionary into a configuration tree:

config.WriteDictionary("motion/timeouts", values);

Dictionary<string, int> loaded =
    config.ReadDictionary<int>("motion/timeouts");

Additional operations include ContainsValue, ReadTree, WriteValues, WriteEntries, ReplaceAll, RemoveValue, and RemoveTree. All writes use a same-directory temporary file before replacing the destination.

Licensed under the MIT License. YAML parsing and serialization are powered by YamlDotNet.