Add Grouped Error Formatter #4002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Open

FeBe95 wants to merge 7 commits into phpstan:2.1.x

from FeBe95:grouped-error-formatter

Open

Add Grouped Error Formatter #4002

FeBe95 wants to merge 7 commits into phpstan:2.1.x from FeBe95:grouped-error-formatter

+275 −0

Conversation

@FeBe95

Copy link

Contributor

@FeBe95 FeBe95 commented May 20, 2025

Description

This PR introduces a new error formatter that groups all errors by their identifier. Groups are sorted in descending order based on the number of occurrences. The output format is a hybrid of the raw and table error formatters.

All error lines are clickable for easy code navigation. As with the table error formatter, the file:line format can be customized via the editorUrl and editorUrlTitle parameters.

Usage

vendor/bin/phpstan analyse --error-format=grouped

Use Case

This formatter is particularly useful when working with a large number of errors, for example, when introducing PHPStan to an existing codebase. Grouping by error identifier instead of by file helps speed up the review and fixing process.

Example Output

Note: Using configuration file C:\projects\test-project\phpstan.neon.
 123/123 [============================] 100%
[property.notFound] (4x):
 - C:\projects\test-project\Bar.php:21: Access to an undefined property App\Models\MyModel::$email.
 - C:\projects\test-project\Bar.php:71: Access to an undefined property App\Models\MyModel::$deleted_at.
 - C:\projects\test-project\Foo.php:20: Access to an undefined property App\Models\MyModel::$id.
 - C:\projects\test-project\Foo.php:55: Access to an undefined property App\Models\MyModel::$name.
[method.notFound] (3x):
 - C:\projects\test-project\Bar.php:25: Call to an undefined method App\Helper\SdkClientV3::delete().
 - C:\projects\test-project\Foo.php:276: Call to an undefined method App\Helper\SdkClientV3::update().
 - C:\projects\test-project\Foo.php:760: Call to an undefined method App\Helper\SdkClientV3::query().
[phpDoc.parseError] (2x):
 - C:\projects\test-project\Foo.php:13: PHPDoc tag @param has invalid value (int countryId ,): Unexpected token "countryId", expected variable at offset 93 on line 4
 - C:\projects\test-project\Foo.php:14: PHPDoc tag @param has invalid value (int productId ,): Unexpected token "productId", expected variable at offset 130 on line 5
[arguments.count] (1x):
 - C:\projects\test-project\Bar.php:46: Method Illuminate\Database\Eloquent\Builder<App\Models\MyModel>::orWhereNull() invoked with 2 parameters, 1 required.
 
 [ERROR] Found 10 errors

Screenshot

grafik

FeBe95 added 3 commits

May 20, 2025 12:53

@FeBe95


 add grouped error formatter

0cef5d0

@FeBe95


 add grouped error formatter test

7505e58

@FeBe95


 register grouped error formatter service

c2ca50d

@mvorisek

Copy link

Contributor

mvorisek commented May 20, 2025 •

edited

Loading

How is this helpful, should't the grouping be done on filename basis?

The reason is many different errors are related, thus errors for LoC close to each other should be reported together.

@FeBe95

Copy link

Contributor Author

FeBe95 commented May 20, 2025 •

edited

Loading

We introduced PHPStan to our codebase a few weeks ago. We started with level 0 and added all existing errors to the baseline file.

Then our workflow is as follows:

Delete all ignored errors from the baseline
Use this grouped error formatter for error analysis
Assign one developer to each error type
Fix the errors one at a time
Increase the level by 1
Repeat

Shouldn't the grouping be done by filename?

We have found it much easier to do research on one specific error type at a time. Often, you can find an answer right away on how to fix the underlying bugs, and then apply it to all similar ones.

FeBe95 added 4 commits

June 19, 2025 17:42

@FeBe95


 Merge branch '2.1.x' into grouped-error-formatter

e6c6b5a

# Conflicts:
#	conf/config.neon

@FeBe95


 add Autowired attributes

ac0c05e

@FeBe95


 fix code style

a668fb7

@FeBe95


 static dataProvider

913f05c

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Grouped Error Formatter #4002

Are you sure you want to change the base?

Add Grouped Error Formatter #4002

Conversation

@FeBe95 FeBe95 commented May 20, 2025

Description

Usage

Use Case

Example Output

Screenshot

Uh oh!

mvorisek commented May 20, 2025 •

edited

Loading

Uh oh!

Uh oh!

FeBe95 commented May 20, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Add Grouped Error Formatter #4002

Are you sure you want to change the base?

Add Grouped Error Formatter #4002

Conversation

@FeBe95 FeBe95 commented May 20, 2025

Description

Usage

Use Case

Example Output

Screenshot

Uh oh!

mvorisek commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FeBe95 commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mvorisek commented May 20, 2025 •

edited

Loading

FeBe95 commented May 20, 2025 •

edited

Loading