/YamlDotNet

YamlDotNet is a .NET library for YAML

Primary LanguageC#MIT LicenseMIT

YamlDotNet

YamlDotNet is a .NET library for YAML. YamlDotNet provides low level parsing and emitting of YAML as well as a high level object model similar to XmlDocument. A serialization library is also included that allows to read and write objects from and to YAML streams.

Currently, YamlDotNet supports version 1.1 of the YAML specification.

What is YAML?

YAML, which stands for "YAML Ain't Markup Language", is described as "a human friendly data serialization standard for all programming languages". Like XML, it allows to represent about any kind of data in a portable, platform-independent format. Unlike XML, it is "human friendly", which means that it is easy for a human to read or produce a valid YAML document.

The YamlDotNet library

The library has now been successfully used in multiple projects and is considered fairly stable.

More information

More information can be found in the official page of the project.

Installing

Just install the YamlDotNet NuGet package:

PM> Install-Package YamlDotNet

If you do not want to use NuGet, you can download binaries here.

YamlDotNet is also available on the Unity Asset Store.

Contributing

Please read CONTRIBUTING.md for guidelines.

Changelog

Version 4.0.0

This a major release that introduces a few breaking changes.

Breaking changes

  • The constructors of Serializer and Deserializer are now obsolete
    Except for the parameterless versions. The SerializerBuilder and DeserializerBuilder classes should now be used to configure and create instances of the (de)serializer.

  • Replaced the IYamlSerializable interface with IYamlConvertible
    The IYamlSerializable is now obsolete, but will be kept until the next major release.

  • Removed EventReader
    EventReader was a wrapper over IParser that offered some abstractions for parsing, but also had some design flaws. It has been replaced by extension methods for IParser. The extension methods provide the same functionality, and allow to always use the same type to represent the parser.

  • Dropped support for YamlAliasAttribute
    This class has been obsolete for many releases, and it was time to let it go.

New features

  • SerializerBuilder and DeserializerBuilder
    This is an important change that adds "builders" that can be used to configure the Serializer and Deserializer through a fluent syntax. The main objective of this is to allow more control over the composition of services performed by these two classes. This means that every aspect of the composition should be extensible / overridable. Things like injecting a custom TypeInspector or replacing the the default ArrayNodeDeserializer with an alternative implementation become possible and easy.
    In order to avoid breaking existing code, the constructors of Serializer and Deserializer have been kept but marked as obsolete. In a future release they will be discarded.

  • Added the IYamlConvertible interface
    This new interface differs in that its methods receive a delegate that can be used to reuse the current serializer or deserializer.

  • Improved the usability of YamlDocument
    and other RepresentationModel classes:

    • Added conversion operators and indexers for easier parsing and construction of YamlNodes.
    • YamlMappingNode, YamlSequenceNode and YamlScalarNode now implement IYamlConvertible, which means that these types can appear in the middle of an object that is being serialized or deserialized, and produce the expected result.

  • Added support for alternative Boolean values

    • True: true, y, yes, on
    • False: false, n, no, off.

Bug fixes

Version 3.9.0

New features:

  • Add YamlVisitorBase as an improved replacement for YamlVisitor
    • YamlVisitor is now obsolete, and will be removed in a future release.
  • Ensure compatibility with AOT compilation, for platforms that do not allow dynamic code generation, such as IOS or PS4.
  • Add Yaml attribute overrides feature, similar to XML Serializer attribute overrides behavior.
  • Add a YamlNodeType enumeration property to nodes.

Bug fixes:

  • Fix #166 - Guid conversion to JSON is unquoted.
  • Ignore enum value case during deserialization.
  • Improve newline handling
    • In some cases, consecutive newlines were incorrectly parsed or emitted.
  • Fix #177 - double.MaxValue serialization.
  • Register custom type converters with higher precedence than the built-in converters.

Version 3.8.0

New features:

  • Add support for different scalar integer bases.
    Addresses issue #113. Adds basic support for deserializing scalar integers written in binary, octal, decimal, hex, and base 60, as allowed in the YAML specification; see http://yaml.org/type/int.html. Adds unit tests for each of these bases as well.
  • Add dnx compatibility to the NuGet packages.
  • Do not throw exception if a tag does not contain a valid type name.

Fixes and improvements:

  • Cache type metadata.
  • Fix wrong type when deserializing UInt16.
  • Fix handling of special float values, such as NaN, PositiveInfinity and NegativeInfinity.
  • Properly quote empty strings.
  • Properly handle non-Unicode encodings when emitting scalars.

Version 3.7.0

This is a minor update that simply adds an overload of YamlStream.Load to be able to specify the EventReader.

Version 3.6.1

Bug fixes:

  • Bug in the GetPublicMethods implementation for portable.

Version 3.6.0

New features:

  • Ability to opt out of anchor assignment during YamlStream.Save().
  • Allow the style of scalar properties to be specified through the YamlMember attribute.
  • Add solution configuration to target "Unity 3.5 .net Subset Base Class Libraries".

Bug fixes:

  • Do not compare nodes by value while assigning anchors. It is the responsibility of the user to use the same reference if they want an alias.
  • Fixed #121: Finding properties in parent interfaces

Version 3.5.1

Fix bug:

  • Scalars returned by the scanner do not have their Start and End properties set.

Version 3.5.0

  • Add native support of System.Guid serialization.
  • Add properties to YamlMemberAttribute:
    • Order: specifies the order of the members when they are serialized.
    • Alias: instructs the deserializer to use a different field name for serialization.
  • The YamlAliasAttribute is now obsolete. New code should use YamlMemberAttribute instead.
  • Throw proper exceptions, with correct marks, when deserialization of a node fails.

Version 3.4.0

Changes and fixes on the Scanner to make it more usable:

  • Report the location of comments correctly, when the scanner is created with "skipComments = false"
  • In case of syntax error, do not report an empty range and skip to the next token.
  • Make the scanner and related types serializable, so that the state of the scanner can be captured and then restored later (assuming that the TextReader is also serializable).

Version 3.3.1

This release adds a signed package and portable versions of the library.

Version 3.3.0

  • Make types in YamlDotNet.RepresentationModel serializable.

Version 3.2.1

  • Fix AnchorNotFoundException when another exception occurs during deserialization.

Version 3.2.0

This release adds merge key support: http://yaml.org/type/merge.html

Example from BackreferencesAreMergedWithMappings unit test:

var reader = new EventReader(new MergingParser(new Parser(stream)));
var result = Deserializer.Deserialize<Dictionary<string, Dictionary<string, string>>>(parser);

Version 3.1.1

This is a bugfix release that fixes issue #90.

Version 3.1.0

  • Add a parameter to the deserializer to ignore unmapped properties in YAML.

Version 3.0.0

  • Fix issue #26: Use the actual type of the objects instead of the statically detected one.
  • Merged the Core, Converters and RepresentationModel assemblies. The NuGet packages YamlDotNet.Core and YamlDotNet.RepresentationModel are now a single package, named YamlDotNet.
  • Removed YamlDotNet.Configuration and YamlDotNet.Converters.
  • Line numbers in error messages now start at one.
  • TypeConverter is now used to cast list items.
  • Various code improvements.
  • More and better unit tests.

Version 2.2.0

TODO

Version 2.1.0

TODO

Version 2.0.0

  • YamlSerializer has been replaced by the Deserializer class. It offer the same functionality of YamlSerializer but is easier to maintain and extend.

    • Breaking change: DeserializationOverrides is no longer supported. If you need this, please file a bug and we will analyze it.
    • Breaking change: IDeserializationContext is no longer supported. If you need this, please file a bug and we will analyze it.
    • Tag mappings are registered directly on the Deserializer using RegisterTagMapping()
    • ObjectFactory is specified in the constructor, if required.

  • Bug fixes to the Serializer:

    • Fix bug when serializing lists with nulls inside. e9019d5f224f266e88d9882502f83f0c6865ec24

  • Adds a YAML editor add-in for Visual Studio 2012. Available on the Visual Studio Gallery.