Skip to content

Latest commit

 

History

History
92 lines (64 loc) · 5.03 KB

README.md

File metadata and controls

92 lines (64 loc) · 5.03 KB
Raw

eo-yaml

eo-yaml-logo

Build Status Coverage Status

Managed By Self XDSD DevOps By Rultor.com We recommend IntelliJ IDEA OpenJDK Quality Outreach

winner

YAML for Java 8 and above. Based on spec 1.2.

From the specification: YAML™ is a human-friendly, cross language, Unicode based data serialization language.

To get the latest release from Maven Central, simply add the following to your pom.xml:

<dependency>
    <groupId>com.amihaiemil.web</groupId>
    <artifactId>eo-yaml</artifactId>
    <version>5.2.0</version>
</dependency>

or download the fat jar.

If you use Gradle, add this to your dependencies:

implementation group: 'com.amihaiemil.web', name: 'eo-yaml', version: '5.2.0'

The releases are also available on Github Packages!

Usage

The API of this library is clean, intuitive and generally close to the javax.json API that most developers are used to. Just start form the com.amihaiemil.eoyaml.Yaml class, it offers all the builders and readers you may need.

See the Block Style Yaml wiki for a first glance.

Features detailed (ongoing work!)

Here is what we have so far:

  • Building and Reading Block YAML (wiki);
  • Support for Folded and Literal Block Scalars (wiki);
  • Convenience Type-Casting Methods (wiki);
  • Editing of YAML (wiki);
  • Support for Comments (wiki);
  • Convenient YamlPrinter (wiki);
  • Easy Extension Thanks to Interfaces (wiki);
  • Building and Reading YAML Streams, integrated with Java 8's Stream API (wiki);
  • Java Beans to YAML (wiki);
  • Others:
    • Automatic validation of the input's indentation (wiki).
    • Clear and detailed Exceptions. For instance, in the case of bad indentation, it will tell you exactly which line is problematic and why.
    • Fully encapsulated. The user works only with a few Java Interfaces.
    • All objects are immutable and thread-safe.
    • It can be used as a Java Module (if you're on JDK 9+).
    • It is lightweight! It has 0 dependencies.

Also, you can have a look under src/test/resources to see the kinds of YAML that the library can read and handle so far.

Here is what we're still missing and working on:

  • Flow and Recursive representation
  • Aliases and anchors
  • YAML to Java Bean

Keep in mind that the library is based on interfaces and OOP best practices, so you can probably extend/decorate the objects in order to create the functionality you need, if it's not yet implemented.

If you have some time and like the library, please consider contributing.

Contribute

Contributors are welcome!

  1. Open an issue regarding an improvement you thought of, or a bug you noticed, or ask to be assigned to an existing one.
  2. If the issue is confirmed, fork the repository, do the changes on a separate branch and make a Pull Request.
  3. After review and acceptance, the PR is merged and closed.

Make sure the maven build

$ mvn clean install -Pcheckstyle,itcases

passes before making a PR.