Cannot get stats when output format is not console

[AndreyMZ]

Problem description

Psalm can output some interesting statistics like:

Checks took 1.02 seconds and used 54.968MB of memory
Psalm was able to infer types for 100% of the codebase

and even more statistics with the options --stats and/or --debug-performance.

But:

1. It can output it only when --output-format is console or phpstorm.
2. It can output it only to stdout.

So, in the case when one needs to have the report in other format (e.g. --output-format=json), he/she cannot get the statistics.

Root cause

psalm/src/Psalm/IssueBuffer.php

Lines 708 to 711 in 5370492

	if (in_array(
	$project_analyzer->stdout_report_options->format,
	[Report::TYPE_CONSOLE, Report::TYPE_PHP_STORM],
	)) {

Workaround

Run with the options --report=report.json --output-format=console and save both the report file and the stdout.

Cons:

1. Code issues printed to stdout are redundant.
2. Psalm needs write access to the file system to write the report into a separate file instead of stdout. This may create problems, for example if you run Psalm in a Docker container.

Possible solution

Write the statistics to stderr instead of stdout regardless of the --output-format. The stdout should be a place for code issue only (whether human-readable or machine-readable). The stderr may be a place for log, progress, statistics, etc.

[psalm-github-bot]

Hey @AndreyMZ, can you reproduce the issue on https://psalm.dev ?

[AndreyMZ]

No, I cannot. Stupid bot.