lukezbihlyj/vdf-parser

一个开源的VDF解析器,用于Valve公司为Source游戏开发的专用格式。

1.0 2015-02-13 13:18 UTC

This package is auto-updated.

Last update: 2024-09-05 23:58:10 UTC


README

一个开源的VDF解析器,用于Valve公司为Source游戏开发的专用格式。本包100%经过测试,可在任何遵守MIT许可证的项目中使用。解析器目前支持VDF的所有功能,包括

  • 任意空白字符,包括制表符和空格。
  • 注释,在解析过程中将被忽略。
  • 转义字符串,允许在键和值内部使用反斜杠转义。
  • 嵌套数组,使用递归。

安装

通过Composer

将以下内容添加到您的composer.json文件中,并运行composer update以更新依赖项并引入新包。

"require": {
    "lukezbihlyj/vdf-parser": "~1.0"
}

使用方法

解析

$string = <<<VDF
{
    "key" "value"
}
VDF;

$parser = new VdfParser\Parser;
$result = $parser->parse($string);

//
// $result = [
//     'key' => 'value'
// ]
//

测试

单元测试可用,我们努力实现100%的代码覆盖率。运行测试套件非常简单。

$ composer install
$ php vendor/bin/phpunit -c test/phpunit.xml

除了phpunit结果输出到终端外,代码覆盖率文档也将生成在build/目录下。