Add phpstan-baseline Composer script to root composer.json

Is there a way to overwrite the current baseline with this starter file?

It runs much more consistently and with lower memory starting empty:

<?php declare(strict_types = 1);

$ignoreErrors = [];


return ['parameters' => ['ignoreErrors' => $ignoreErrors]];

This would definitely be useful. I've added ddev commands for now:

$ cat .ddev/commands/web/phpstan-generate
#!/usr/bin/env bash

./vendor/bin/phpstan analyze  --configuration=./core/phpstan.neon.dist --generate-baseline=core/.phpstan-baseline.php

And a phpstan without the --generate-baseline.

I think we should drop the word "generate" and just have:

composer phpstan
composer phpstan-baseline

I think we should also use these commands in ci for consistency. Then if we need to tweak it in future it will be updated in both places.

the CI job runs phpstan like 3 times with different output formats and arguments, so I don't think we can reuse that.

I figured out why I needed the empty baseline.

It was because during the conversion there were thousands of changes. A normal baseline process doesn't need that.

Adding related issue

it also require to set memory limit

For my setup I need to also set the memory limit to -1. Should we include that here too?

I would RTBC but can't do the T part until next week

This is kind of funny. First, because I had no idea the phpcs/phpcbf commands existed in the composer.json file. I guess I don't spend much time looking at it. Second, because I just use good ol' bash aliases. The recent mock object issues prompted me to finally add entries for PHPStan alongside the aliases for other CLI utilities when I had to regenerate baselines so often. So this is pretty fresh in my mind.

alias phpstan='ddev exec vendor/bin/phpstan analyze --configuration=core/phpstan.neon.dist --memory-limit=-1'
alias baseline='ddev exec vendor/bin/phpstan analyze --configuration=./core/phpstan.neon.dist --memory-limit=-1 --generate-baseline=core/.phpstan-baseline.php'

But putting them in Composer is good! I'm sure it will save someone time down the road. Especially if anyone ends up on a fresh dev environment for any reason (I'm thinking ahead to when this laptop needs to be replaced). They'll always be here for us.

Anyway, the new commands exactly match the examples given in our own PHPStan in Core documentation. I tested them all (including the old ones) out on my local environment. They worked just like I expected based on my experience with my old aliases. LGTM.

I am updating the issue summary to match the MR that is now RTBC.

Everything has been addressed here and I have updated credit.

Committed and pushed fd70826e021 to main and 567eff6ff11 to 11.x. Thanks!

FYI (in case this helps some contrib module maintainer): Canvas did something similar a few months ago over at #3575399: DX+CI: Add `composer run phpstan-regenerate-ignores-for-11.3-and-higher` — to simplify updating baseline errors due to PHPStan running on 11.2, fail CI job if out of sync — although Canvas' baseline is intentionally different: Canvas started with PHPStan level 8 (so in principle: empty baseline).

Many contrib modules — including Canvas — target some core minor as the minimum supported version. For Canvas, that's 11.2.x. And of course, like any contrib module, we try to be as forward-compatible as possible. That means for example already providing a default_content event subscriber. Which in turn triggers PHPStan errors (because we execute PHPStan against the minimum supported core version — 11.2.x in our case).

So, Canvas' baseline is specifically for PHPStan errors specific to upcoming Drupal core versions. For example:

		-
			message: '#^Access to property \$metadata on an unknown class Drupal\\Core\\DefaultContent\\PreEntityImportEvent\.$#'
			identifier: class.notFound
			count: 4
			path: src/EventSubscriber/DefaultContentSubscriber.php

Canvas provides composer run phpstan-regenerate-ignores-for-11.3-and-higher to simplify keeping this up-to-date.

See #3575399: DX+CI: Add `composer run phpstan-regenerate-ignores-for-11.3-and-higher` — to simplify updating baseline errors due to PHPStan running on 11.2, fail CI job if out of sync.