README

解析 YAML 并提供与它们的行号以及文档结构的任何给定键的行号相对应的注释。

用法

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

获取此文档的注释行

print_r($parseResult->getComments());

Array
(
    [3] => # Messing up line numbers with comments, yay!
    [13] =>   # Some comment here.
)

获取特定键的行号

print $parseResult->getLineNumber('name');
1
print $parseResult->getLineNumber('description');
4
print $parseResult->getLineNumber(['dependencies', 3]);
14

klausi / yaml_comments

维护者

详细信息

README

用法