Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/filip26/hydrogen-yaml

An intelligent YAML generator
https://github.com/filip26/hydrogen-yaml

java strictyaml yaml yaml-api yaml-generator yaml-processor

Last synced: 7 days ago
JSON representation

An intelligent YAML generator

Host: GitHub
URL: https://github.com/filip26/hydrogen-yaml
Owner: filip26
License: apache-2.0
Created: 2020-08-21T16:54:17.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2023-04-03T21:11:02.000Z (over 1 year ago)
Last Synced: 2024-10-28T01:18:26.602Z (2 months ago)
Topics: java, strictyaml, yaml, yaml-api, yaml-generator, yaml-processor
Language: Java
Homepage: https://apicatalog.com
Size: 297 KB
Stars: 0
Watchers: 2
Forks: 1
Open Issues: 5
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # Java API for YAML Processing

![Java CI with Maven](https://github.com/filip26/hydrogen-yaml/workflows/Java%20CI%20with%20Maven/badge.svg)

[![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/filip26/hydrogen-yaml.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/filip26/hydrogen-yaml/context:java)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=filip26_hydrogen-yaml&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=filip26_hydrogen-yaml)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=filip26_hydrogen-yaml&metric=coverage)](https://sonarcloud.io/dashboard?id=filip26_hydrogen-yaml)

[![Maven Central](https://img.shields.io/maven-central/v/com.apicatalog/hydrogen-yaml.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.apicatalog%22%20AND%20a:%22hydrogen-yaml%22)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Hydrogen YAML is the simplest human-readable data-serialization language inspired by [StrictYAML](https://github.com/crdoconnor/strictyaml). Some YAML features are not intentionally supported.

## Hydrogen Features

- Fully decoupled data model from a representation

- Implicit serialization style

  * an intelligent YAML generator

  * customizable print style

- Explicit typing

  * target class adapters

## Unsupported YAML Features

- Implicit typing

- Duplicate keys

- Explicit tags

- Node anchors and refs

- Flow style (except scalars and simple sequences)

- Complex mapping keys

- Directives

See [What YAML features does StrictYAML remove?](https://hitchdev.com/strictyaml/features-removed/) for more details.

Presence of a removed feature raises an exception during parsing.

## Usage

Maven

```xml

    com.apicatalog

    hydrogen-yaml

    0.2.1

```

Gradle

```gradle

compile group: 'com.apicatalog', name: 'hydrogen-yaml', version: '0.2.1'

```

## Examples

```javascript

YamlNode node = Yaml.createMappingBuilder()

                    .add("key", "value")

                    .add("sequence", Yaml.createSequenceBuilder()

                                         .add("item")

                    ).build();

     

Yaml.createWriter(OutputStream|Writer).write(YamlNode);

```

## Roadmap

- [x] ~0.1 Document API~

- [x] ~0.2 Writer API~

- [ ] 0.3 Parser API

- [ ] 0.5 Flow Sequence of Scalars

- [ ] 0.6 Multi-documents

- [ ] 0.8 Beans Binding