klausi/yaml_comments

YAML parser that also reads/writes comment lines

YamlComments

Parses YAML and provides comments with their line numbers as well as the line number of any given key of the document structure., _(*1)

The parser was copied and modified from the Symfony YAML component, MIT license Copyright (c) 2004-2017 Fabien Potencier, _(*2)

Usage

use Klausi\YamlComments\YamlComments;

$exampleYaml = <<<'EOF'
name: Node
type: module
# Messing up line numbers with comments, yay!
description: 'Allows content to be submitted to the site and displayed on pages.'
package: Core
version: VERSION
core: 8.x
configure: entity.node_type.collection
dependencies:
  - text
  - drupal:rest
  - views
  # Some comment here.
  - rules
EOF;

$parseResult = YamlComments::parse($exampleYaml);

Get the comment lines of this document:, _(*3)

print_r($parseResult->getComments());

``` Array ( [3] => # Messing up line numbers with comments, yay! [13] => # Some comment here. ), <sub>(*4)</sub>

Get the line number of a particular key:
```php
print $parseResult->getLineNumber('name');
1
print $parseResult->getLineNumber('description');
4
print $parseResult->getLineNumber(['dependencies', 3]);
14