[TASK] Use Rector 2.0

simonschaufi · simonschaufi · commit cd239acb237d · 2025-05-02T14:06:03.000+02:00
diff --git a/composer.json b/composer.json
@@ -19,7 +19,7 @@
         "helmich/typo3-typoscript-parser": "^2.6",
         "nette/utils": "^4.0",
         "ondram/ci-detector": "^4.2",
-        "phpstan/phpstan": "^1.10.9",
+        "phpstan/phpstan": "^2.0.0",
         "sebastian/diff": "^4.0 || ^5.0 || ^6.0",
         "simonschaufi/pretty-xml": "^3.0.0",
         "symfony/config": "^5.4 || ^6.4 || ^7.0",
@@ -34,9 +34,9 @@
     "require-dev": {
         "composer/composer": "^2.7",
         "ergebnis/composer-normalize": "^2.42",
-        "phpstan/phpstan-phpunit": "^1.3",
+        "phpstan/phpstan-phpunit": "^2.0.0",
         "phpunit/phpunit": "^10.5",
-        "rector/rector": "^1.2.6",
+        "rector/rector": "^2.0.0",
         "symplify/easy-coding-standard": "^12.3",
         "symplify/monorepo-builder": "^11.2",
         "symplify/rule-doc-generator": "12.1.3"
diff --git a/packages/fractor-phpstan-rules/composer.json b/packages/fractor-phpstan-rules/composer.json
@@ -16,7 +16,7 @@
     "require": {
         "php": "^8.2",
         "a9f/fractor": "^0.5",
-        "phpstan/phpstan": "^1.10.9"
+        "phpstan/phpstan": "^2.0.0"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,
diff --git a/packages/fractor-phpstan-rules/src/Rules/AddChangelogDocBlockForFractorRule.php b/packages/fractor-phpstan-rules/src/Rules/AddChangelogDocBlockForFractorRule.php
@@ -13,6 +13,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Type\FileTypeMapper;
 
 /**
@@ -72,7 +73,11 @@ public function processNode(Node $node, Scope $scope): array
 
         $docComment = $node->getDocComment();
         if (! $docComment instanceof Doc) {
-            return [sprintf(self::ERROR_MESSAGE, $className)];
+            return [
+                RuleErrorBuilder::message(sprintf(self::ERROR_MESSAGE, $className))
+                    ->identifier('change.docblock')
+                    ->build(),
+            ];
         }
 
         $resolvedPhpDoc = $this->fileTypeMapper->getResolvedPhpDoc(
@@ -88,6 +93,10 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        return [sprintf(self::ERROR_MESSAGE, $className)];
+        return [
+            RuleErrorBuilder::message(sprintf(self::ERROR_MESSAGE, $className))
+                ->identifier('change.docblock')
+                ->build(),
+        ];
     }
 }
diff --git a/packages/fractor-phpstan-rules/tests/Rules/AddChangelogDocBlockForFractorRule/AddChangelogDocBlockForFractorRuleTest.php b/packages/fractor-phpstan-rules/tests/Rules/AddChangelogDocBlockForFractorRule/AddChangelogDocBlockForFractorRuleTest.php
@@ -16,9 +16,9 @@
 final class AddChangelogDocBlockForFractorRuleTest extends RuleTestCase
 {
     /**
-     * @param array<int, mixed> $expectedErrorsWithLines
+     * @param list<array{0: string, 1: int, 2?: string|null}> $expectedErrorsWithLines
      */
-    #[DataProvider(methodName: 'provideData')]
+    #[DataProvider('provideData')]
     public function testRule(string $filePath, array $expectedErrorsWithLines): void
     {
         $this->analyse([$filePath], $expectedErrorsWithLines);
diff --git a/packages/fractor-typoscript/src/Contract/TypoScriptNodeVisitor.php b/packages/fractor-typoscript/src/Contract/TypoScriptNodeVisitor.php
@@ -13,7 +13,7 @@
 interface TypoScriptNodeVisitor
 {
     /**
-     * @param list<Statement> $statements
+     * @param Statement[] $statements
      */
     public function beforeTraversal(File $file, array $statements): void;
 
@@ -22,7 +22,7 @@ public function enterNode(Statement $node): Statement|int;
     public function leaveNode(Statement $node): void;
 
     /**
-     * @param list<Statement> $statements
+     * @param Statement[] $statements
      */
     public function afterTraversal(array $statements): void;
 }
diff --git a/packages/fractor-typoscript/src/TypoScriptStatementsIterator.php b/packages/fractor-typoscript/src/TypoScriptStatementsIterator.php
@@ -19,12 +19,12 @@
     public const REMOVE_NODE = 3;
 
     /**
-     * @var array<TypoScriptNodeVisitor>
+     * @var TypoScriptNodeVisitor[]
      */
     private iterable $visitors;
 
     /**
-     * @param list<TypoScriptNodeVisitor> $visitors
+     * @param TypoScriptNodeVisitor[] $visitors
      */
     public function __construct(iterable $visitors)
     {
@@ -34,8 +34,8 @@ public function __construct(iterable $visitors)
     }
 
     /**
-     * @param list<Statement> $statements
-     * @return list<Statement>
+     * @param Statement[] $statements
+     * @return Statement[]
      */
     public function traverseDocument(File $file, array $statements): array
     {
@@ -53,8 +53,8 @@ public function traverseDocument(File $file, array $statements): array
     }
 
     /**
-     * @param list<Statement> $statements
-     * @return list<Statement>
+     * @param Statement[] $statements
+     * @return Statement[]
      */
     private function processStatementList(array $statements): array
     {
diff --git a/packages/fractor-xml/src/XmlFileProcessor.php b/packages/fractor-xml/src/XmlFileProcessor.php
@@ -9,6 +9,7 @@
 use a9f\Fractor\Caching\Detector\ChangedFilesDetector;
 use a9f\Fractor\Exception\ShouldNotHappenException;
 use a9f\Fractor\ValueObject\Indent;
+use a9f\FractorXml\Contract\DomNodeVisitor;
 use a9f\FractorXml\Contract\Formatter;
 use a9f\FractorXml\Contract\XmlFractor;
 use a9f\FractorXml\ValueObjectFactory\DomDocumentFactory;
@@ -35,6 +36,9 @@ public function canHandle(File $file): bool
         return $file->getFileExtension() === 'xml';
     }
 
+    /**
+     * @param list<DomNodeVisitor> $appliedRules
+     */
     public function handle(File $file, iterable $appliedRules): void
     {
         $fileHasChanged = \false;
diff --git a/packages/fractor-xml/tests/DomDocumentIteratorTest.php b/packages/fractor-xml/tests/DomDocumentIteratorTest.php
@@ -217,7 +217,7 @@ private function getCollectingDomNodeVisitor(): CollectingDomNodeVisitor
     }
 
     /**
-     * @param list<string> $recorder
+     * @param list<non-empty-string> $recorder
      */
     private function getCallRecordingDomNodeVisitor(string $visitorName, array &$recorder): DomNodeVisitor
     {
diff --git a/packages/fractor/src/ChangesReporting/Output/ConsoleOutputFormatter.php b/packages/fractor/src/ChangesReporting/Output/ConsoleOutputFormatter.php
@@ -17,9 +17,6 @@ class ConsoleOutputFormatter implements OutputFormatterInterface
      */
     public const NAME = 'console';
 
-    /**
-     * @readonly
-     */
     private SymfonyStyle $symfonyStyle;
 
     public function setSymfonyStyle(SymfonyStyle $symfonyStyle): void
diff --git a/packages/fractor/src/Configuration/AllowedFileExtensionsResolver.php b/packages/fractor/src/Configuration/AllowedFileExtensionsResolver.php
@@ -20,7 +20,7 @@ public function __construct(
     }
 
     /**
-     * @return list<non-empty-string>
+     * @return array<int<0, max>, non-empty-string>
      */
     public function resolve(): array
     {
diff --git a/packages/fractor/src/Configuration/ConfigurationFactory.php b/packages/fractor/src/Configuration/ConfigurationFactory.php
@@ -19,9 +19,12 @@ public function __construct(
 
     public function createFromInput(InputInterface $input): Configuration
     {
+        /** @var list<non-empty-string> $paths */
+        $paths = (array) $this->parameterBag->get(Option::PATHS);
+
         return new Configuration(
             $this->allowedFileExtensionsResolver->resolve(),
-            (array) $this->parameterBag->get(Option::PATHS),
+            $paths,
             (array) $this->parameterBag->get(Option::SKIP),
             (bool) $input->getOption(Option::DRY_RUN),
             (bool) $input->getOption(Option::QUIET)
@@ -30,7 +33,7 @@ public function createFromInput(InputInterface $input): Configuration
 
     /**
      * @api used in tests
-     * @param string[] $paths
+     * @param list<non-empty-string> $paths
      */
     public function createForTests(array $paths): Configuration
     {
diff --git a/packages/fractor/src/Helper/FileHasher.php b/packages/fractor/src/Helper/FileHasher.php
@@ -37,11 +37,6 @@ public function hashFiles(array $files): string
 
     private function getAlgo(): string
     {
-        //see https://php.watch/articles/php-hash-benchmark
-        if (\PHP_VERSION_ID >= 80100) {
-            // if xxh128 is available use it, as it is way faster
-            return 'xxh128';
-        }
-        return 'md4';
+        return 'xxh128';
     }
 }
diff --git a/packages/fractor/src/Testing/PHPUnit/AbstractFractorTestCase.php b/packages/fractor/src/Testing/PHPUnit/AbstractFractorTestCase.php
@@ -139,6 +139,9 @@ private function bootContainer(): void
         );
     }
 
+    /**
+     * @param non-empty-string $originalFilePath
+     */
     private function doTestFileMatchesExpectedContent(
         string $originalFilePath,
         string $expectedFileContents,
@@ -162,6 +165,9 @@ private function doTestFileMatchesExpectedContent(
         self::assertSame(trim($expectedFileContents), trim($changedContents), $failureMessage);
     }
 
+    /**
+     * @param non-empty-string $filePath
+     */
     private function processFilePath(string $filePath): FractorTestResult
     {
         $configurationFactory = $this->getService(ConfigurationFactory::class);
@@ -175,6 +181,9 @@ private function processFilePath(string $filePath): FractorTestResult
         return new FractorTestResult($changedFileContents, $processResult);
     }
 
+    /**
+     * @return non-empty-string
+     */
     private function createInputFilePath(string $fixtureFilePath): string
     {
         $inputFileDirectory = \dirname($fixtureFilePath);
diff --git a/packages/typo3-fractor/rules/TYPO3v12/TypoScript/RenameTcemainLinkHandlerMailKeyFractor.php b/packages/typo3-fractor/rules/TYPO3v12/TypoScript/RenameTcemainLinkHandlerMailKeyFractor.php
@@ -6,7 +6,6 @@
 
 use a9f\FractorTypoScript\AbstractTypoScriptFractor;
 use Helmich\TypoScriptParser\Parser\AST\NestedAssignment;
-use Helmich\TypoScriptParser\Parser\AST\ObjectPath;
 use Helmich\TypoScriptParser\Parser\AST\Operator\Assignment;
 use Helmich\TypoScriptParser\Parser\AST\Statement;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
@@ -23,10 +22,6 @@ public function refactor(Statement $statement): null|Statement|int
             return null;
         }
 
-        if (! $statement->object instanceof ObjectPath) {
-            return null;
-        }
-
         if ($statement->object->absoluteName !== 'TCEMAIN.linkHandler.mail') {
             return null;
         }
diff --git a/phpstan.neon b/phpstan.neon
@@ -16,3 +16,7 @@ parameters:
         - packages/**/tests/**/Fixture/*
         - packages/**/tests/Fixtures/*
         - packages/fractor-rule-generator/templates
+    treatPhpDocTypesAsCertain: false
+    ignoreErrors:
+        - identifier: return.unusedType
+        - identifier: varTag.nativeType

Original file line number	Diff line number	Diff line change
`@@ -16,9 +16,9 @@`
`16`	`16`	`final class AddChangelogDocBlockForFractorRuleTest extends RuleTestCase`
`17`	`17`	`{`
`18`	`18`	`/**`
`19`		`- * @param array<int, mixed> $expectedErrorsWithLines`
	`19`	`+ * @param list<array{0: string, 1: int, 2?: string\|null}> $expectedErrorsWithLines`
`20`	`20`	`*/`
`21`		`- #[DataProvider(methodName: 'provideData')]`
	`21`	`+ #[DataProvider('provideData')]`
`22`	`22`	`public function testRule(string $filePath, array $expectedErrorsWithLines): void`
`23`	`23`	`{`
`24`	`24`	`$this->analyse([$filePath], $expectedErrorsWithLines);`
Original file line number	Diff line number	Diff line change
`@@ -217,7 +217,7 @@ private function getCollectingDomNodeVisitor(): CollectingDomNodeVisitor`
`217`	`217`	`}`
`218`	`218`
`219`	`219`	`/**`
`220`		`- * @param list<string> $recorder`
	`220`	`+ * @param list<non-empty-string> $recorder`
`221`	`221`	`*/`
`222`	`222`	`private function getCallRecordingDomNodeVisitor(string $visitorName, array &$recorder): DomNodeVisitor`
`223`	`223`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public function __construct(`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`/**`
`23`		`- * @return list<non-empty-string>`
	`23`	`+ * @return array<int<0, max>, non-empty-string>`
`24`	`24`	`*/`
`25`	`25`	`public function resolve(): array`
`26`	`26`	`{`