hanneskod / exemplify
Validate code examples in readme files
Installs: 115
Dependents: 0
Suggesters: 0
Security: 0
Stars: 9
Watchers: 2
Forks: 1
Open Issues: 6
Type:project
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-11-06 18:43:27 UTC
README
Validate PHP code examples in documentation.
This file describes version
2
which uses php8 attributes.
For version
1
which uses docblock style annotations see this link.
Why?
Did you update your library, but forgot to update code examples in README? Are your users complaining on syntax errors in your examples? Do you find it too cumbersome to manually test all examples? Readme-Tester lets you automate the process of validating PHP code examples in documentation files.
A simple example
Readme-Tester uses php8 style attributes inside HTML-comments (to make them invisible after rendering on for example github) to specify the expected result of a code example.
The following simple example asserts that the code outputs content.
<!--
#[ReadmeTester\ExpectOutput('/foo/')]
-->
```php
echo "foobar";
```
For more information read the documentation.
Installation
Using phive (recommended)
Install using phive
phive install hanneskod/readme-tester
As a phar archive
Download the latest phar archive from the releases tab.
Optionally rename readme-tester.phar
to readme-tester
for a smoother experience.
Using composer
Install as a composer dependency
composer require --dev hanneskod/readme-tester
This will make readme-tester
avaliable as vendor/bin/readme-tester
.
From source
To build you need make
make sudo make install
The build script uses composer to handle dependencies and phive to
handle build tools. If they are not installed as composer
or phive
respectivly you can use something like
make COMPOSER_CMD=./composer.phar PHIVE_CMD=./phive.phar
Getting started
Using the command line tool is as simple as
readme-tester README.md
For more detailed information use
readme-tester -h