rectorphp
Get ready for PHPStan 2.0
Feature Request
Hi, I just started working on PHPStan 2.0 which will come with PHP-Parser 5. These are early days of the development, but you can already require phpstan/phpstan:^2.0 (with minimum-stability dev) and start working on making Rector compatible.
There will be more backward compatibility breaks coming in the next few months as I work towards to release, but you can already start getting rector-src ready for Rector 2.0 which will require PHPStan 2.0.
Please keep this issue open so we can discuss the next major PHPStan version. I'd also appreciate any feedback from your side. Thanks. 🤞
Sounds good 👍
We'll give this a priority by the end of the year and do upgrade of both PHPStan 2 and php-parser 5 at once.
We're now in the release candidate period https://github.com/phpstan/phpstan/discussions/11816
rector phpstan's extensions seems need to have compatible to phpstan 2 first:
Problem 1
- Root composer.json requires rector/type-perfect ^0.1.6 -> satisfiable by rector/type-perfect[0.1.6, 0.1.7, 0.1.8].
- rector/type-perfect[0.1.6, ..., 0.1.8] require phpstan/phpstan ^1.11 -> found phpstan/phpstan[1.11.0, ..., 1.12.x-dev] but it conflicts with your root composer.json require (^2.0).
Problem 2
- Root composer.json requires symplify/phpstan-extensions ^11.4 -> satisfiable by symplify/phpstan-extensions[11.4.0, 11.4.1, 11.4.2, 11.4.3].
- symplify/phpstan-extensions[11.4.0, ..., 11.4.3] require phpstan/phpstan ^1.10 -> found phpstan/phpstan[1.10.0, ..., 1.12.x-dev] but it conflicts with your root composer.json require (^2.0).
Problem 3
- Root composer.json requires symplify/phpstan-rules ^13.0 -> satisfiable by symplify/phpstan-rules[13.0.0, 13.0.1].
- symplify/phpstan-rules[13.0.0, ..., 13.0.1] require phpstan/phpstan ^1.10.30 -> found phpstan/phpstan[1.10.30, ..., 1.12.x-dev] but it conflicts with your root composer.json require (^2.0).
Problem 4
- Root composer.json requires tomasvotruba/unused-public ^0.3.10 -> satisfiable by tomasvotruba/unused-public[0.3.10, 0.3.11].
- tomasvotruba/unused-public[0.3.10, ..., 0.3.11] require phpstan/phpstan ^1.10.19 -> found phpstan/phpstan[1.10.19, ..., 1.12.x-dev] but it conflicts with your root composer.json require (^2.0).
Problem 5
- Root composer.json requires phpstan/phpstan-phpunit ^1.4 -> satisfiable by phpstan/phpstan-phpunit[1.4.0, 1.4.x-dev].
- phpstan/phpstan-phpunit 1.4.0 requires phpstan/phpstan ^1.11 -> found phpstan/phpstan[1.11.0, ..., 1.12.x-dev] but it conflicts with your root composer.json require (^2.0).
- phpstan/phpstan-phpunit 1.4.x-dev requires phpstan/phpstan ^1.12 -> found phpstan/phpstan[1.12.0, ..., 1.12.x-dev] but it conflicts with your root composer.json require (^2.0).
@TomasVotruba Today is 11.11. Do you plan to make Rector PHPStan 2 compatible this week?
@szepeviktor Depends how many only-in-Rector BC breaks we'll have to deal with. We use lot of internal code, so it might be a challange.
@samsonasik Could you look into it? rector/rector first, so we can keep it focused on single repository
@TomasVotruba sure, phpstan 2 require php-parser 5 so it will need revisit my old PR:
- https://github.com/rectorphp/rector-src/pull/2916
to be reincorporated ;)
I think best way to start is to enable bleeding edge and maybe install phpstan-deprecation-rules and start fixing stuff that pops up. We don't need to require 2.0 for that.
I created this PR for tomasvotruba/unused-public https://github.com/TomasVotruba/unused-public/pull/135, probably complementary to https://github.com/TomasVotruba/unused-public/pull/134
Another PR for tomasvotruba/type-coverage https://github.com/TomasVotruba/type-coverage/pull/46, complementary to https://github.com/TomasVotruba/type-coverage/pull/45
I am trying to install phpstan 2 and php-parser 5
- https://github.com/rectorphp/rector-src/pull/6431
the php-parser is patched, and currently got error on phpstan service:
44) Rector\Tests\Issues\AutoImport\AutoImportTest::test with data set #43 ('/Users/samsonasik/www/rector-...hp.inc')
_PHPStan_2a200beec\Nette\DI\ServiceCreationException: Service 'rectorParser' (type of PHPStan\Parser\RichParser): Unable to pass specified arguments to RichParser::__construct().
The parameter list seems different:
v1: https://github.com/phpstan/phpstan-src/blob/fd6a0f275f2a4d6dd21c450bb4d0a55d0ee1e43c/src/Parser/RichParser.php#L43-L45
v2: https://github.com/phpstan/phpstan-src/blob/2a200beec3f2edd913b2af3bf69fbb428018dd74/src/Parser/RichParser.php#L42-L44
Remove lexer params seems handle it https://github.com/rectorphp/rector-src/pull/6431/commits/f7e9549cc33ae47fa6b6de665e7384c6f0eb118b
will continue updating there at:
- https://github.com/rectorphp/rector-src/pull/6431
Another PR for rector/type-perfect https://github.com/rectorphp/type-perfect/pull/48
The upgrade process has been completed 🎉 🎉 🎉
- https://github.com/rectorphp/rector-src/pull/6431#issuecomment-2486747057
The upgrade process has been completed
Are there any plans for a new release?
@FabianKoestring We're testing the dev branch now in couple big projects. There are still breaks in docblocks we have to verify to avoid mess. I expect dev tagged with rc/beta mid next week. If stable enough, we can land stable within ~week after that.
Date 12. 12. seems like best :)
If you can try out latest Rector dev and report feedback from your project, it would speedup the process :slightly_smiling_face:
{
"require-dev": {
"phpstan/phpstan": "^2.0",
"rector/rector": "dev-main"
}
}
I've switched to the dev branch (so that I could install phpstan 2), and haven't had any issues. Granted, my use cases are fairly straightforward and common (just adding return types is a huge help!)
There is an issue going on with conditional return types. Had a few files that failed.
- https://github.com/rectorphp/rector/issues/8907
A really good project to also test is TYPO3 Rector. I've tried it out with:
"require": {
"php": "^7.4 || ^8.0",
"ext-json": "*",
"league/flysystem": "^2.0 || ^3.0",
"league/flysystem-memory": "^2.0 || ^3.0",
"nette/utils": "^3.2.10 || ^4.0.4",
"nikic/php-parser": "^4.18.0",
- "phpstan/phpstan": "^1.10.56",
- "rector/rector": "^1.1.0",
+ "phpstan/phpstan": "^2.0",
+ "rector/rector": "dev-main",
"symfony/console": "^5.4 || ^6.4 || ^7.0",
"symfony/filesystem": "^5.4 || ^6.4 || ^7.0",
"symfony/finder": "^5.4 || ^6.4 || ^7.0",
"symfony/polyfill-php80": "^1.28.0",
"symfony/polyfill-php81": "^1.28.0",
"symfony/string": "^5.4 || ^6.4 || ^7.0",
"webmozart/assert": "^1.11.0"
},
"require-dev": {
"ergebnis/composer-normalize": "^2.42.0",
"php-parallel-lint/php-parallel-lint": "^1.3.2",
"phpstan/extension-installer": "^1.3.1",
- "phpstan/phpstan-deprecation-rules": "^1.1.4",
- "phpstan/phpstan-phpunit": "^1.3.16",
"phpunit/phpunit": "^9.6.17 || ^10.0",
"symfony/config": "^5.0 || ^6.0 || ^7.0",
"symfony/dependency-injection": "^5.4.36 || ^6.4.2 || ^7.0.2",
"symfony/http-kernel": "^5.4.37 || ^6.4.2 || ^7.0.2",
"symplify/easy-coding-standard": "^12.1.14"
},
and then run:
composer update
vendor/bin/rector process
and I'm getting some phpstan error:
PHP Fatal error: Uncaught _PHPStan_c684505c9\Nette\Schema\ValidationException: Unexpected item 'parameters › featureToggles › disableRuntimeReflectionProvider'. in phar:///home/xxx/sabbelasichon/typo3-rector/vendor/phpstan/phpstan/phpstan.phar/vendor/nette/schema/src/Schema/Processor.php:75
@simonschaufi I created PR on typo-3 rector for that :)
- https://github.com/sabbelasichon/typo3-rector/pull/4450
I tried the new version with our project and could not find any problems. Rector was able to find several new issues, but all these finds were correct, they were genuine problems that had not been detected before
Our project is mid sized, about 1K PHP files with about 200K lines of code. We apply a lot of Rector rules, around 300
Found another issue, but don't understand why it happens:
$ vendor/bin/phpstan analyze --debug src-dev/Rector/
/Volumes/CS/www/cosmos/src-dev/Rector/StaticMoneyConstructorRector.php
PHP Fatal error: Dev\Rector\StaticMoneyConstructorRector::getRuleDefinition() has #[\Override] attribute, but no matching parent method exists in /Volumes/CS/www/cosmos/src-dev/Rector/StaticMoneyConstructorRector.php on line 26
Part of the rector:
<?php
declare(strict_types=1);
namespace Dev\Rector;
use Money\Currency;
use Money\Money;
use Override;
use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr\New_;
use PhpParser\Node\Expr\StaticCall;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Param;
use PhpParser\Node\Scalar\LNumber;
use PhpParser\Node\Scalar\String_;
use PhpParser\NodeTraverser;
use Rector\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
final class StaticMoneyConstructorRector extends AbstractRector
{
#[Override]
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition(
'Replace `new Money(10, new Currency("EUR"))` with `Money::EUR(10)`.',
[
new CodeSample(
<<<'CODE_SAMPLE'
new Money(10, new Currency("EUR"));
CODE_SAMPLE,
<<<'CODE_SAMPLE'
Money::EUR(10);
CODE_SAMPLE,
)],
);
}
// ...
}
I ran this:
$ composer update -W "phpstan/*" rector/rector phpdocumentor/type-resolver phpstan/phpdoc-parser
The reason I don't understand it, is that I'm overriding this, as it's part of a higher interface, no?
When I remove the #[Override] interface, PHPStan reports an error like this:
Method Dev\Rector\StaticMoneyConstructorRector::getRuleDefinition() overrides method Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface::getRuleDefinition() but is missing the #[\Override] attribute. method.missingOverride
Which is what I expect, because we enforce #[Override]
@ruudk It because of this PR:
- https://github.com/rectorphp/rector-src/pull/6438
getRuleDefinition() no longer exists in shipped rector/rector, to ease for write custom rule without define getRuleDefinition() method.
You can remove #[Override] on getRuleDefinition() and that should working again.
@ruudk I created PR for that for win win solution:
- https://github.com/rectorphp/rector-src/pull/6476
@ruudk That's expected. See the upgrade guide, the getDefinition() is no longer needed as it was way to enforce docs for Rector rules. https://github.com/rectorphp/rector-src/blob/main/UPGRADING.md#2-abstractrector-get-focused-on-code-the-getruledefinition-is-no-longer-required
@TomasVotruba does this mean that when we upgrade to Rector 2.0 we need to remove our getDefinition() functions or can they remain in place even if they are no longer needed?