Download the PHP package ockcyp/covers-validator without Composer
On this page you can find all versions of the php package ockcyp/covers-validator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package covers-validator
covers-validator
PHPUnit @covers tags validator
Why?
PHPUnit fails to generate a coverage report when tests have invalid @covers tags.
This tool allows you to determine the tests that have invalid @covers tags without you needing to run the coverage.
Usually coverage reports are run less often than the tests as they take a long time to run. This tool validates your @covers tags quicker than you run your tests.
See: phpunit/issues/1758
Also see: phpunit/issues/1791
Abandoned alternative: dunkelfrosch/phpcoverfish
Getting Started
Prerequisites
- PHP 7.1+
- PHPUnit 6.0+
Installation
Composer
Recommended way of installing covers-validator is via Composer.
Phar
Download the covers-validator.phar
asset
from the latest release
or any other release from the releases.
Then run using the following:
[!NOTE] The usage documentation assumes you installed covers-validator using Composer, so please replace any reference to "vendor/bin/covers-validator" with "php covers-validator.phar".
[!NOTE] Only releases since v0.3.0 can be used as a phar.
Older versions
Latest version of covers-validator supports PHP 7.1+ and PHPUnit 7+. Please use version 0.5 for older PHP and PHPUnit versions.
PHPUnit version | Covers-validator version |
---|---|
< 6.0 | 0.5.x |
>= 6.0 | 1.x |
Usage
Run the validator using the following:
[!TIP] The command returns exit code 1 when any of the covers tags are invalid. Use this to fail your builds.
Override configuration file
Give optional -c
argument to load a particular PHPUnit configuration file:
Override PHPUnit bootstrap
Override the bootstrap
value specified in PHPUnit configuration:
Disable output
Disable output by providing the -q
argument
Adjust the verbosity:
Verbosity | Shows |
---|---|
-v |
Valid tests |
-vv |
Loaded configuration file |
-vvv |
Test name before validation is done |
Sample output
Normal verbosity
Maximum verbosity (debug)
Tests
To run the tests, execute:
Versioning
We use Semantic Versioning for versioning. For the versions available, see the releases or the CHANGELOG.md file.
Authors
- Oliver Radwell - @oradwell
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.txt file for details.
Acknowledgments
- Sebastian Bergmann for creating the PHPUnit project
- The contributors
All versions of covers-validator with dependencies
phpunit/phpunit Version >=7.0,<10.0
symfony/console Version >=2.7,<7.0