Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mavimo/phpstan-junit
PHPStan JUnit error reporter
https://github.com/mavimo/phpstan-junit
jenkins junit phpstan phpstan-extension
Last synced: 12 days ago
JSON representation
PHPStan JUnit error reporter
- Host: GitHub
- URL: https://github.com/mavimo/phpstan-junit
- Owner: mavimo
- Archived: true
- Created: 2018-06-08T18:42:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T16:54:53.000Z (about 2 years ago)
- Last Synced: 2025-01-20T10:46:05.884Z (15 days ago)
- Topics: jenkins, junit, phpstan, phpstan-extension
- Language: PHP
- Homepage:
- Size: 68.4 KB
- Stars: 12
- Watchers: 3
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PHPStan JUnit error reporter
[](http://opensource.org/licenses/MIT)
[](https://codecov.io/gh/mavimo/phpstan-junit?branch=master)
[](https://www.codacy.com/manual/mavimo/phpstan-junit)
[](https://packagist.org/packages/mavimo/phpstan-junit)
[](https://packagist.org/packages/mavimo/phpstan-junit)
[](https://packagist.org/packages/mavimo/phpstan-junit)
[](https://packagist.org/packages/mavimo/phpstan-junit)
The main scope for this project is to create error report in **JUnit** format that can be easly integrated in _Jenkins_ or other tools that use this information.
## DEPRECATION
> **Warning**
> This project is not needed anymore since this feature is now built-in into PHPStan itself
## How to use it
### Install
You need to include this library in your project as dev-dependency, it dependes on the version of phpstan you're using you should use a different version of `mavimo/phpstan-junit` library, this table will give you a dependency map:
| `phpstan/phpstan` version | `mavimo/phpstan-junit` version |
| ------------------------- | ------------------------------ |
| `0.10.x` | `0.1.x` |
| `0.11.x` | `0.2.x` |
| `0.12.x` | `0.3.x` |
But if alredy specified the `phpstan/phpstan` version you can just use:
```bash
composer require --dev mavimo/phpstan-junit
```
If you also install [phpstan/extension-installer](https://github.com/phpstan/extension-installer) then you're all set, otherwise take a look to _manual setup_ section below.
Manual setup for PHPStan 0.11 and next
if you don't want to use `phpstan/extension-installer`, you should require the `extension.neon` file on your `phpstan.neon.dist` file in the root of your project (or on the file you specify to phpstan using the `--config` flag):
```yaml
includes:
- vendor/mavimo/phpstan-junit/extension.neon
```
or declaring the service via:
```yaml
services:
errorFormatter.junit:
class: Mavimo\PHPStan\ErrorFormatter\JunitErrorFormatter
```
Manual setup for PHPStan 0.10
You should require this extension on `phpstan.neon` file in the root of your project or the file you specify to phpstan using the `--config` flag by referencing `extension.neon` file:
```yaml
includes:
- vendor/mavimo/phpstan-junit/phpstan.neon
```
or declaring the service via:
```yaml
services:
errorFormatter.junit:
class: Mavimo\PHPStan\ErrorFormatter\JunitErrorFormatter
```
### Generate JUnit report
You should gnerate JUnit report with the flag `--error-format=junit`, eg:
```bash
vendor/bin/phpstan --error-format=junit --no-progress --no-interaction analyse src
```
## Contributing
Contributions are welcome!
PR's will be merged only if:
- _phpunit_ is :white_check_mark:, you can run it using `vendor/bin/phpunit`
- _phpstan_ is :white_check_mark:, you can run it using `vendor/bin/phpstan analyse`
- _phpcs_ is :white_check_mark:, you can run it using `vendor/bin/phpcs`
- _code coverage_ will not decrease (or there are good reason to decrease it), you can check the current coverage using `phpdbg -qrr ./vendor/bin/phpunit --coverage-text`
If you have any question feel free to open a issue or contact me!