json2yaml 1.0.1

Dart package to render JSON data to YAML

json2yaml

Dart package to render JSON data to YAML

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));

This function is implemented in a very basic and perhaps naive way, please let me know if it does not work for you.

Usage

To use json2yaml, add the following dependency to pubspec.yaml:

dependencies:
  json2yaml: ^1.0.0

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) -- generic Yaml rendering
• YamlStyle.pubspecYaml -- Yaml formatting style mimicking pubspec.yaml files
• YamlStyle.pubspecLock -- Yaml formatting style mimicking pubspec.lock files generated by Dart pub

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<String, dynamic> json, {
  YamlStyle yamlStyle = YamlStyle.generic,
});