通过
搜索
搜索hanneskod / readme-tester
验证README文件中的代码示例
2.0.0-beta1
2020-12-25 14:25 UTC
Requires
- php: >=8.0
- amphp/parallel-functions: ^1
- crell/tukio: ^1
- fig/event-dispatcher-util: ^1
- psr/container: ^1
- psr/event-dispatcher: ^1
- symfony/console: ^5
- symfony/dependency-injection: ^5
- symfony/finder: ^5
- symfony/process: ^5
- symfony/yaml: ^5
Requires (Dev)
This package is auto-updated.
Last update: 2024-08-28 21:36:20 UTC
README
验证文档中的PHP代码示例。
本文件描述了使用php8属性的第
2版。
关于使用docblock风格注解的第
1版，请参阅此链接。
为什么？
你是否更新了库，但忘记更新README中的代码示例？你的用户是否在抱怨示例中的语法错误？你是否觉得手动测试所有示例太麻烦？Readme-Tester让你自动化验证文档文件中PHP代码示例的过程。
一个简单的示例
Readme-Tester在HTML注释中使用php8风格属性（以便在例如GitHub上渲染后使其不可见）来指定代码示例的预期结果。
以下简单示例断言代码输出内容。
<!--
#[ReadmeTester\ExpectOutput('/foo/')]
-->
```php
echo "foobar";
```
有关更多信息，请阅读文档。
安装
使用phive（推荐）
使用phive安装
phive install hanneskod/readme-tester
作为phar存档
从发行版标签中下载最新phar存档。
可选地将readme-tester.phar重命名为readme-tester以获得更好的体验。
使用composer
将其作为composer依赖项安装
composer require --dev hanneskod/readme-tester
这将使readme-tester作为vendor/bin/readme-tester可用。
从源代码
要构建，你需要make
make sudo make install
构建脚本使用composer处理依赖项，并使用phive处理构建工具。如果它们未作为composer或phive安装，则可以使用类似以下的方法
make COMPOSER_CMD=./composer.phar PHIVE_CMD=./phive.phar
入门
使用命令行工具非常简单
readme-tester README.md
要获取更详细的信息，请使用
readme-tester -h