Download the PHP package jdecool/phpstan-report without Composer
On this page you can find all versions of the php package jdecool/phpstan-report. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jdecool/phpstan-report
More information about jdecool/phpstan-report
Files in jdecool/phpstan-report
Package phpstan-report
Short Description Enhance PHPStan analysis by providing report analysis
License MIT
Informations about the package phpstan-report
PHPStan Report
A simple wrapper around PHPStan to extends PHPStan's functionality by providing a customizable report generation feature. It allows you to run PHPStan analysis and generate reports on ignored errors in various formats.
Installation
You can install the package via composer:
Usage
This package provides two main commands:
Analyze Command
The analyze command runs PHPStan analysis and generates reports on ignored errors:
Options
--report-output-format: Specify the output format for the report--report-without-analyze: Generate a report without running the PHPStan analysis--report-continue-on-error: Continue report generation even if the analysis fails--report-maximum-allowed-errors: Set the maximum number of allowed errors--report-sort-by: Sort the report results (options: identifier, occurrence)--report-exclude-identifier: Identifier to exclude from the report (accepts multiple values)--report-file-<format>: Export report in an output file for a particular format--report-http-target-url: The target URL to send the report to (available only if output format ishttp)--report-http-add-header: Add a header to the HTTP request (available only if output format ishttp)--report-gitlab-severity-mapping: JSON string mapping error identifiers to GitLab severity levels (available only if output format isgitlab)
Available formats are: text, html, http, json, gitlab and heatmap.
For a full list of options, run:
View Command
The view command displays detailed information about specific ignored errors from the PHPStan result cache:
This command allows you to examine specific error identifiers without running a new analysis.
Options
--refresh-cache: Refresh PHPStan cache by running a new analysis before viewing errors
The view command takes error identifiers as arguments and displays detailed information about those errors in a table format showing:
- Error identifier
- Error message
- File path
- Line number
For help with the view command, run:
Examples
Run analysis and generate a text report:
Generate an HTML report without running analysis:
Run analysis, continue on error, and save report to a file:
Generate a heatmap report of files with most ignored errors:
Generate a GitLab report with custom severity mapping:
For more details on GitLab severity mapping, see docs/gitlab-severity-mapping.md.
View Command Examples
View details about a specific error identifier:
View details about multiple error identifiers:
All versions of phpstan-report with dependencies
monolog/monolog Version ^2.0 || ^3.0
phpstan/phpstan Version ^1.11 || ^2.0
psr/log Version ^2.0 || ^3.0
symfony/config Version ^5.4 || ^6.0 || ^7.1
symfony/console Version ^5.4 || ^6.0 || ^7.1
symfony/dependency-injection Version ^5.4 || ^6.0 || ^7.1
symfony/filesystem Version ^5.4 || ^6.0 || ^7.1
symfony/finder Version ^5.4 || ^6.0 || ^7.1
symfony/polyfill-intl-icu Version ^1.31