Name: Cortex.Serialization.Yaml
Author: Buildersoft,EnesHoxha

Cortex.Serialization.Yaml v2.2.0 — nugetz

dotnet add package Cortex.Serialization.Yaml

using Cortex.Serialization.Yaml.Serialization;
using Cortex.Serialization.Yaml.Serialization.Conventions;

public sealed record Address(string Street, string City);
public sealed class Person
{
    public string FirstName { get; set; } = string.Empty;
    public string LastName  { get; set; } = string.Empty;
    public int Age { get; set; }
    public List<string> Tags { get; set; } = new();
    public Address? Address { get; set; }
}

var person = new Person
{
    FirstName = "Ada",
    LastName  = "Lovelace",
    Age = 36,
    Tags = ["math", "poet"],
    Address = new("12 St James's Sq", "London")
};

var serializer = new YamlSerializer(new YamlSerializerSettings
{
    NamingConvention = new SnakeCaseConvention(),
    EmitNulls = false
});

string yaml = serializer.Serialize(person);
Console.WriteLine(yaml);

var deserializer = new YamlDeserializer(new YamlDeserializerSettings
{
    NamingConvention = new SnakeCaseConvention()
});

var model = deserializer.Deserialize<Person>(yaml);
Console.WriteLine($"Hello {model.FirstName} {model.LastName}, {model.Age}");

var settings = new YamlSerializerSettings
{
    NamingConvention = new CamelCaseConvention(), // how CLR names map to YAML keys
    EmitNulls = true,                             // include null properties
    EmitDefaults = true,                          // include default(T) values
    SortProperties = false,                       // keep reflection order
    Indentation = 2                               // spaces per indent level
};

var settings = new YamlDeserializerSettings
{
    NamingConvention = new SnakeCaseConvention(),
    CaseInsensitive = true,
    IgnoreUnmatchedProperties = true
};

var yaml = """
first_name: Ada
last_name: Lovelace
age: 36
tags:
  - math
  - poet
address:
  street: 12 St James's Sq
  city: London
""";

var des = new YamlDeserializer(new YamlDeserializerSettings { NamingConvention = new SnakeCaseConvention() });
var p = des.Deserialize<Person>(yaml);

var s = new YamlSerializer(new YamlSerializerSettings { NamingConvention = new SnakeCaseConvention(), EmitNulls = false });
var outYaml = s.Serialize(p);

description: |
  First line kept
  Second line kept
note: >
  Lines are folded
  into a single paragraph

public sealed class Product
{
    [YamlProperty(Name = "product_id")] // explicit YAML key
    public Guid Id { get; set; }

    [YamlIgnore]
    public string? InternalNotes { get; set; }
}

public sealed class YesNoBoolConverter : IYamlTypeConverter
{
    public bool CanConvert(Type t) => t == typeof(bool);
    public object? Read(object? node, Type targetType) => string.Equals(node?.ToString(), "yes", StringComparison.OrdinalIgnoreCase);
    public object? Write(object? value, Type declared) => (bool?)value == true ? "yes" : "no";
}

var s = new YamlSerializer(new YamlSerializerSettings());
s.Converters.Add(new YesNoBoolConverter());

git checkout -b feature/YourFeature

git commit -m "Add your feature"

git push origin feature/YourFeature

Buildersoft/Cortex.Serialization.Yamlv2.2.0

Get Started

Readme

Cortex.Serialization.Yaml 🧠

🚀 Getting Started

Install via NuGet

🛠️ Quick Start

🔧 Configuration & Options

Serializer settings

Deserializer settings

📚 Examples

1) Lists and nested objects

2) Block scalars (| and >)

3) Attributes and explicit names

4) Custom converters

⚠️ Limits (current version)

💬 Contributing

💬 How to Contribute

📄 License

📚 Sponsorship

How to Sponsor

Contact