Download the PHP package permafrost-dev/coverage-check without Composer
On this page you can find all versions of the php package permafrost-dev/coverage-check. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download permafrost-dev/coverage-check
More information about permafrost-dev/coverage-check
Files in permafrost-dev/coverage-check
Package coverage-check
Short Description Check a project's code coverage, optionally enforcing a minimum value
License MIT
Homepage https://github.com/permafrost-dev/coverage-check
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package coverage-check
coverage-check
Display the code coverage for a project using a clover.xml file, optionally enforcing a minimum code coverage percentage.
This package is designed to be used in your CI/CD or automated testing process (i.e., using GitHub Workflows).
The concept for this package is based on this article.
``
Note on PHP 7.x support: If you are using PHP 7.x, use the 1.x version of this package.
Installation
Usage
Specify a valid clover.xml file and (optionally) a minimum coverage percentage to require using the --require or -r flag. A percentage can be either a whole number (integer) or a decimal (float).
If you specify the --require/-r flag, the check will fail if coverage percent is below the value you provide, and the process exit code will be non-zero.
If you don't specify the --require/-r flag, only the percentage of code coverage will be displayed and the exit code will always be zero.
Available Options
| Option | Description |
|---|---|
--coverage-only or -C |
Only display the code coverage value |
--metric or -m <name> |
Use the specified metric field for calculating coverage. Valid values are element (default), method, or statement |
--precision or -p <value> |
Use the specified precision when calculating the code coverage percentage, where <value> is an integer (default: 4) |
--require or -r <value> |
Enforce a minimum code coverage value, where <value> is an integer or decimal value |
Metric fields
The field that is used to calculate code coverage can be specified using the --metric=<name> or -m <name> option.
Valid field names are element (the default), statement, and method.
Generating clover-format coverage files
PHPUnit can generate coverage reports in clover format:
Sample Github Workflow
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Patrick Organ
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
