NanoYaml

NanoYaml is a specialized configuration format inspired by YAML 1.2.2, designed to provide a strict and simplified experience for data serialization and deserialization in C#. This project stands out by offering a lightweight, round-trip safe format that efficiently handles configurations and data storage for both human-readable local files and automated remote processes.

Key Features

• Strict Subset of YAML: Operates as an opinionated subset of the YAML specification, ensuring simplicity without unnecessary complexity. All NanoYaml files are valid YAML 1.1 and 1.2.2, making it straightforward to work within existing YAML ecosystems.
• High Performance: Provides exceptional performance, boasting throughput that can surpass traditional YAML parsers by over 10 times, which is essential for applications requiring quick data processing.
• Auto-Detection Profiles: Supports two profiles for document parsing, allowing for flexibility in how YAML data is processed. Files can be interpreted in either Strict or Compatible mode based on their content, while the output remains strictly conformant.
• Seamless Integration: The single-file implementation (NanoYaml.cs) facilitates easy integration into .NET 8+ projects, requiring minimal setup and configuration.

Usage Example

Serialization and deserialization can be performed with records, classes, and structs. The following is an example demonstrating how to use NanoYaml to serialize and deserialize data:

using System.Collections.Generic;
using Vaxquis.NanoYaml;

// Serializing and Deserializing data
string yaml;
var connectionRaw = new Dictionary<string, object> { ["Host"] = "localhost", ["Port"] = 8080 };

// Serialize
yaml = NanoYaml.Serialize(connectionRaw);

// Deserialize
var unyamlDict = NanoYaml.Deserialize<Dictionary<string, object>>(yaml);

The serialized output maintains a clear and conventional format:

%TAG ! nanoyaml:0.1.0:
---
Host: localhost
Port: 8080

Compatibility and Influence

NanoYaml is developed keeping in mind the limitations often encountered in traditional YAML formats. It is inspired by other projects such as StrictYAML and YamlRecords, yet aims to deliver a cleaner and more efficient experience. For a comprehensive feature comparison with YamlDotNet and StrictYAML, refer to the compatibility documentation available in the repository.

This project serves developers looking for a reliable YAML-like solution that addresses common criticisms of YAML while maintaining compliance with its fundamental principles.