Clone this repo:
  1. 01589b3 prep for publishing 2.0.3 (#22) by Devon Carew · 5 months ago main 2.0.3
  2. 0b74d85 Update pubspec.yaml (#20) by Devon Carew · 5 months ago
  3. fca8585 Ignore hint in test – not sure we want to refactor this (yet) (#19) by Kevin Moore · 6 months ago
  4. 4fadb43 Prepare 2.0.2 release (#7) by Jonas Finnemann Jensen · 6 months ago 2.0.2
  5. 46eb45d Do not add trailing whitespace to new map keys (#16) by Sam Rawlins · 6 months ago

Dart CI pub package package publisher

A library for YAML manipulation while preserving comments.

Usage

A simple usage example:

import 'package:yaml_edit/yaml_edit.dart';

void main() {
  final yamlEditor = YamlEditor('{YAML: YAML}');
  yamlEditor.update(['YAML'], "YAML Ain't Markup Language");
  print(yamlEditor);
  // Expected output:
  // {YAML: YAML Ain't Markup Language}
}

Testing

Testing is done in two strategies: Unit testing (/test/editor_test.dart) and Golden testing (/test/golden_test.dart). More information on Golden testing and the input/output format can be found at /test/testdata/README.md.

These tests are automatically run with pub run test.

Limitations

  1. Users are not allowed to define tags in the modifications.
  2. Map keys will always be added in the flow style.