https://github.com/alexei-sintotski/json2yaml

Dart package to render JSON data to YAML
https://github.com/alexei-sintotski/json2yaml

dart flutter json yaml

Last synced: 11 days ago
JSON representation

Dart package to render JSON data to YAML

• Host: GitHub
• URL: https://github.com/alexei-sintotski/json2yaml
• Owner: alexei-sintotski
• License: mit
• Created: 2019-12-04T20:10:15.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-23T21:43:00.000Z (over 1 year ago)
• Last Synced: 2024-06-19T10:09:54.276Z (8 months ago)
• Topics: dart, flutter, json, yaml
• Language: Dart
• Size: 43 KB
• Stars: 15
• Watchers: 2
• Forks: 10
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# json2yaml ![Build Status](https://github.com/alexei-sintotski/json2yaml/actions/workflows/dart.yml/badge.svg?branch=master) [![pubspec_lock version](https://img.shields.io/pub/v/json2yaml?label=json2yaml)](https://pub.dev/packages/json2yaml)

Dart package to render JSON data to YAML:

* Correct handling of nested structures

* Built-in automatic beautifer

* Supports Dart pubspec.yaml conventions

* Compatible with conventions imposed by Dart pubspec.lock generator

## Known limitations

* Strings (single line and multiline) are always formatted as they are,

without word wrapping for better human readability

## json2yaml()

json2yaml is the function to format JSON data to YAML.

```

  const developerData = {

    'name': "Martin D'vloper",

    'job': 'Developer',

    'skill': 'Elite',

    'employed': true,

    'foods': ['Apple', 'Orange', 'Strawberry', 'Mango'],

    'languages': {

      'perl': 'Elite',

      'python': 'Elite',

      'pascal': 'Lame',

    },

    'education': '4 GCSEs\n3 A-Levels\nBSc in the Internet of Things'

  };

  print(json2yaml(developerData));

```

## Advanced usage: YAML formatting styles

json2yaml supports the optional argument to customize YAML formatting for various use cases.

At the moment, it supports the three following formatting styles:

- YamlStyle.generic (default) -- Default formatting style applicable in most cases

- YamlStyle.pubspecYaml -- YAML formatting style following pubspec.yaml formatting conventions

- YamlStyle.pubspecLock -- YAML formatting style following pubspec.lock formatting conventions

YAML style is supplied as an optional argument to json2yaml():

```

/// Yaml formatting control options

enum YamlStyle {

  generic,

  pubspecYaml,

  pubspecLock,

}

/// Converts JSON to YAML representation

String json2yaml(

  Map json, {

  YamlStyle yamlStyle = YamlStyle.generic,

});

```