doc-exec — doctest для PHP. Выполняет блоки кода из README на текущем коде и сверяет вывод
$ composer require --dev rasuvaeff/doc-exec
```php doc-exec
2 + 3; // => 5
intdiv(1, 0); // throws DivisionByZeroError
echo "done"; // outputs done
network_call(); // skip: hits a real API
```vendor/bin/doc-exec docs/*.md
vendor/bin/doc-exec --bootstrap=tests/bootstrap.php README.mdDoctest для PHP: выполняет блоки кода из README на текущей кодовой базе и сверяет результат. Делает для PHP то же, что cargo test --doc для Rust.
Примеры в документации устаревают. API меняется, а README продолжает показывать код, который уже не работает. Здесь пример — это тест, поэтому сборка падает, когда он ломается.
php doc-exec. Обычные блоки php остаются иллюстрациями.// => expr, // throws FQCN, // outputs text, // skip.nikic/php-parser), а не поиском по шаблону.php. Без eval().--timeout на группу блоков (по умолчанию 30 с) убивает блоки, зациклившиеся навсегда.DocExec::check() возвращает DocumentResult со стабильными идентификаторами блоков.vendor/bin/doc-exec проверяет ./README.md.Маркеры в комментариях проверяют значение, исключение, вывод или пропускают выражение.
2 + 3;=> 5intdiv(1, 0);throws DivisionByZeroErrorecho "done";outputs donenetwork_call();skip: hits a real API
Запуск из CLI: по умолчанию проверяется README, можно указать файлы, bootstrap и таймаут; при ошибке код выхода 1.
vendor/bin/doc-exec # zero-config: checks ./README.md
vendor/bin/doc-exec docs/*.md # explicit file list
vendor/bin/doc-exec --bootstrap=tests/bootstrap.php README.md # explicit autoloader
vendor/bin/doc-exec --timeout=60 docs/slow.md # wall-clock budget per scope groupAPI DocExec возвращает результат по каждому выражению вместо консольного отчёта.
$result = (new DocExec(timeoutSeconds: 15))->check($document); printf("%s: %s\n", basename($document), $result->passed() ? 'all blocks passed' : 'some blocks failed'); foreach ($result->blocks as $block) { foreach ($block->statements as $statement) { printf( " %-4s line %d %s\n", match ($statement->outcome) { StatementOutcome::Pass => 'pass', StatementOutcome::Skip => 'skip', StatementOutcome::Fail => 'FAIL', }, $statement->statement->line, strtok($statement->statement->code, "\n"), ); }}
Пример из README пакета resilience выполняется через него при каждой сборке.
Блоки выполняют произвольный PHP с правами вызывающего. Таймаут ограничивает только время, но не память и не доступ к файловой системе. Версия 0.1.0.
Требует PHP 8.3–8.5, ext-tokenizer и nikic/php-parser ^5.7.
/ поиск · n N следующее, предыдущее · g G начало, конец · q к индексу