[DX] Add strict PHPStan rules - step #5 (#1334)

Co-authored-by: GitHub Action <action@github.com>
rectorphp · Nov 28, 2021 · 21c4a84 · 21c4a84
1 parent 185ee1b
commit 21c4a84
Show file tree

Hide file tree

Showing 69 changed files with 191 additions and 163 deletions.
diff --git a/build/target-repository/docs/rector_rules_overview.md b/build/target-repository/docs/rector_rules_overview.md
@@ -3684,8 +3684,8 @@ Remove unused parameter in required autowire method
      private $visibilityManipulator;
 
      #[Required]
--    public function autowireSomeService(VisibilityManipulator $visibilityManipulator)
-+    public function autowireSomeService()
+-    public function autowire(VisibilityManipulator $visibilityManipulator)
++    public function autowire()
      {
      }
  }

diff --git a/packages/BetterPhpDocParser/PhpDocManipulator/PhpDocClassRenamer.php b/packages/BetterPhpDocParser/PhpDocManipulator/PhpDocClassRenamer.php
@@ -96,7 +96,7 @@ private function processSerializerTypeTagValueNode(array $oldToNewClasses, PhpDo
         foreach ($oldToNewClasses as $oldClass => $newClass) {
             $className = $doctrineAnnotationTagValueNode->getSilentValue();
 
-            if ($className) {
+            if (is_string($className)) {
                 if ($className === $oldClass) {
                     $doctrineAnnotationTagValueNode->changeSilentValue($newClass);
                     continue;

diff --git a/packages/BetterPhpDocParser/PhpDocManipulator/PhpDocTypeChanger.php b/packages/BetterPhpDocParser/PhpDocManipulator/PhpDocTypeChanger.php
@@ -133,7 +133,7 @@ public function changeParamType(PhpDocInfo $phpDocInfo, Type $newType, Param $pa
     public function copyPropertyDocToParam(Property $property, Param $param): void
     {
         $phpDocInfo = $property->getAttribute(AttributeKey::PHP_DOC_INFO);
-        if (! $phpDocInfo) {
+        if (! $phpDocInfo instanceof PhpDocInfo) {
             return;
         }
 

diff --git a/packages/BetterPhpDocParser/PhpDocParser/StaticDoctrineAnnotationParser/PlainValueParser.php b/packages/BetterPhpDocParser/PhpDocParser/StaticDoctrineAnnotationParser/PlainValueParser.php
@@ -33,7 +33,7 @@ public function __construct(
     }
 
     #[Required]
-    public function autowirePlainValueParser(
+    public function autowire(
         StaticDoctrineAnnotationParser $staticDoctrineAnnotationParser,
         ArrayParser $arrayParser
     ): void {

diff --git a/packages/BetterPhpDocParser/Printer/PhpDocInfoPrinter.php b/packages/BetterPhpDocParser/Printer/PhpDocInfoPrinter.php
@@ -169,7 +169,7 @@ private function printPhpDocNode(PhpDocNode $phpDocNode): string
         $output = $this->printEnd($output);
 
         // fix missing start
-        if (! StringUtils::isMatch($output, self::DOCBLOCK_START_REGEX) && $output) {
+        if (! StringUtils::isMatch($output, self::DOCBLOCK_START_REGEX) && $output !== '') {
             $output = '/**' . $output;
         }
 

diff --git a/packages/ChangesReporting/Output/ConsoleOutputFormatter.php b/packages/ChangesReporting/Output/ConsoleOutputFormatter.php
@@ -90,7 +90,7 @@ private function reportFileDiffs(array $fileDiffs): void
             if ($fileDiff->getRectorChanges() !== []) {
                 $this->outputStyle->writeln('<options=underscore>Applied rules:</>');
                 $this->outputStyle->listing($rectorsChangelogsLines);
-                $this->outputStyle->newLine();
+                $this->outputStyle->newline();
             }
         }
     }
@@ -107,12 +107,12 @@ private function reportErrors(array $errors): void
             $message = sprintf(
                 'Could not process "%s" file%s, due to: %s"%s".',
                 $error->getRelativeFilePath(),
-                $error->getRectorClass() ? ' by "' . $error->getRectorClass() . '"' : '',
+                $error->getRectorClass() !== null ? ' by "' . $error->getRectorClass() . '"' : '',
                 PHP_EOL,
                 $errorMessage
             );
 
-            if ($error->getLine()) {
+            if ($error->getLine() !== null) {
                 $message .= ' On line: ' . $error->getLine();
             }
 

diff --git a/packages/FileFormatter/Formatter/XmlFileFormatter.php b/packages/FileFormatter/Formatter/XmlFileFormatter.php
@@ -35,7 +35,7 @@ final class XmlFileFormatter implements FileFormatterInterface
      */
     private const IS_CLOSING_TAG_REGEX = '#^\s*<\/#';
 
-    private ?int $depth = null;
+    private int $depth = 0;
 
     private int $indent = 4;
 
@@ -79,7 +79,7 @@ private function formatXml(string $xml, EditorConfigConfiguration $editorConfigC
         $parts = $this->getXmlParts($xml);
 
         if (str_starts_with($parts[0], '<?xml')) {
-            $output = array_shift($parts) . $editorConfigConfiguration->getNewline();
+            $output = array_shift($parts) . $editorConfigConfiguration->getNewLine();
         }
 
         foreach ($parts as $part) {
@@ -104,10 +104,10 @@ private function getOutputForPart(string $part, EditorConfigConfiguration $edito
         $this->runPre($part);
 
         if ($this->preserveWhitespace) {
-            $output .= $part . $editorConfigConfiguration->getNewline();
+            $output .= $part . $editorConfigConfiguration->getNewLine();
         } else {
             $part = trim($part);
-            $output .= $this->getPaddedString($part) . $editorConfigConfiguration->getNewline();
+            $output .= $this->getPaddedString($part) . $editorConfigConfiguration->getNewLine();
         }
 
         $this->runPost($part);

diff --git a/packages/FileSystemRector/ValueObject/AddedFileWithNodes.php b/packages/FileSystemRector/ValueObject/AddedFileWithNodes.php
@@ -11,7 +11,7 @@
 final class AddedFileWithNodes implements AddedFileInterface, FileWithNodesInterface
 {
     /**
-     * @param Node[] $nodes
+     * @param Node\Stmt[] $nodes
      */
     public function __construct(
         private string $filePath,
@@ -25,7 +25,7 @@ public function getFilePath(): string
     }
 
     /**
-     * @return Node[]
+     * @return Node\Stmt[]
      */
     public function getNodes(): array
     {

diff --git a/packages/NodeNameResolver/Contract/NodeNameResolverInterface.php b/packages/NodeNameResolver/Contract/NodeNameResolverInterface.php
@@ -6,12 +6,18 @@
 
 use PhpParser\Node;
 
+/**
+ * @template TNode as Node
+ */
 interface NodeNameResolverInterface
 {
     /**
-     * @return class-string<Node>
+     * @return class-string<TNode>
      */
     public function getNode(): string;
 
+    /**
+     * @param TNode $node
+     */
     public function resolve(Node $node): ?string;
 }
diff --git a/packages/NodeNameResolver/Error/InvalidNameNodeReporter.php b/packages/NodeNameResolver/Error/InvalidNameNodeReporter.php
@@ -46,7 +46,7 @@ public function reportInvalidNodeForName(MethodCall | StaticCall $node): void
         $backtrace = debug_backtrace();
         $rectorBacktrace = $this->matchRectorBacktraceCall($backtrace);
 
-        if ($rectorBacktrace) {
+        if ($rectorBacktrace !== null) {
             // issues to find the file in prefixed
             if (file_exists($rectorBacktrace[self::FILE])) {
                 $smartFileInfo = new SmartFileInfo($rectorBacktrace[self::FILE]);

diff --git a/packages/NodeNameResolver/NodeNameResolver/ClassConstFetchNameResolver.php b/packages/NodeNameResolver/NodeNameResolver/ClassConstFetchNameResolver.php
@@ -10,19 +10,19 @@
 use Rector\NodeNameResolver\NodeNameResolver;
 use Symfony\Contracts\Service\Attribute\Required;
 
+/**
+ * @implements NodeNameResolverInterface<ClassConstFetch>
+ */
 final class ClassConstFetchNameResolver implements NodeNameResolverInterface
 {
     private NodeNameResolver $nodeNameResolver;
 
     #[Required]
-    public function autowireClassConstFetchNameResolver(NodeNameResolver $nodeNameResolver): void
+    public function autowire(NodeNameResolver $nodeNameResolver): void
     {
         $this->nodeNameResolver = $nodeNameResolver;
     }
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNode(): string
     {
         return ClassConstFetch::class;

diff --git a/packages/NodeNameResolver/NodeNameResolver/ClassConstNameResolver.php b/packages/NodeNameResolver/NodeNameResolver/ClassConstNameResolver.php
@@ -10,19 +10,19 @@
 use Rector\NodeNameResolver\NodeNameResolver;
 use Symfony\Contracts\Service\Attribute\Required;
 
+/**
+ * @implements NodeNameResolverInterface<ClassConst>
+ */
 final class ClassConstNameResolver implements NodeNameResolverInterface
 {
     private NodeNameResolver $nodeNameResolver;
 
     #[Required]
-    public function autowireClassConstNameResolver(NodeNameResolver $nodeNameResolver): void
+    public function autowire(NodeNameResolver $nodeNameResolver): void
     {
         $this->nodeNameResolver = $nodeNameResolver;
     }
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNode(): string
     {
         return ClassConst::class;

diff --git a/packages/NodeNameResolver/NodeNameResolver/ClassNameResolver.php b/packages/NodeNameResolver/NodeNameResolver/ClassNameResolver.php
@@ -5,32 +5,31 @@
 namespace Rector\NodeNameResolver\NodeNameResolver;
 
 use PhpParser\Node;
-use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassLike;
 use Rector\NodeNameResolver\Contract\NodeNameResolverInterface;
 use Rector\NodeNameResolver\NodeNameResolver;
 use Symfony\Contracts\Service\Attribute\Required;
 
+/**
+ * @implements NodeNameResolverInterface<ClassLike>
+ */
 final class ClassNameResolver implements NodeNameResolverInterface
 {
     private NodeNameResolver $nodeNameResolver;
 
     #[Required]
-    public function autowireClassNameResolver(NodeNameResolver $nodeNameResolver): void
+    public function autowire(NodeNameResolver $nodeNameResolver): void
     {
         $this->nodeNameResolver = $nodeNameResolver;
     }
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNode(): string
     {
         return ClassLike::class;
     }
 
     /**
-     * @param Class_ $node
+     * @param ClassLike $node
      */
     public function resolve(Node $node): ?string
     {

diff --git a/packages/NodeNameResolver/NodeNameResolver/EmptyNameResolver.php b/packages/NodeNameResolver/NodeNameResolver/EmptyNameResolver.php
@@ -8,11 +8,11 @@
 use PhpParser\Node\Expr\Empty_;
 use Rector\NodeNameResolver\Contract\NodeNameResolverInterface;
 
+/**
+ * @implements NodeNameResolverInterface<Empty_>
+ */
 final class EmptyNameResolver implements NodeNameResolverInterface
 {
-    /**
-     * @return class-string<Node>
-     */
     public function getNode(): string
     {
         return Empty_::class;

diff --git a/packages/NodeNameResolver/NodeNameResolver/FuncCallNameResolver.php b/packages/NodeNameResolver/NodeNameResolver/FuncCallNameResolver.php
@@ -12,16 +12,16 @@
 use Rector\NodeNameResolver\Contract\NodeNameResolverInterface;
 use Rector\NodeTypeResolver\Node\AttributeKey;
 
+/**
+ * @implements NodeNameResolverInterface<FuncCall>
+ */
 final class FuncCallNameResolver implements NodeNameResolverInterface
 {
     public function __construct(
         private ReflectionProvider $reflectionProvider
     ) {
     }
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNode(): string
     {
         return FuncCall::class;

diff --git a/packages/NodeNameResolver/NodeNameResolver/FunctionNameResolver.php b/packages/NodeNameResolver/NodeNameResolver/FunctionNameResolver.php
@@ -10,11 +10,11 @@
 use Rector\NodeNameResolver\Contract\NodeNameResolverInterface;
 use Rector\NodeTypeResolver\Node\AttributeKey;
 
+/**
+ * @implements NodeNameResolverInterface<Function_>
+ */
 final class FunctionNameResolver implements NodeNameResolverInterface
 {
-    /**
-     * @return class-string<Node>
-     */
     public function getNode(): string
     {
         return Function_::class;
@@ -33,7 +33,7 @@ public function resolve(Node $node): ?string
         }
 
         $namespaceName = $scope->getNamespace();
-        if ($namespaceName) {
+        if ($namespaceName !== null) {
             return $namespaceName . '\\' . $bareName;
         }
 

diff --git a/packages/NodeNameResolver/NodeNameResolver/NameNameResolver.php b/packages/NodeNameResolver/NodeNameResolver/NameNameResolver.php
@@ -11,16 +11,16 @@
 use Rector\NodeNameResolver\Contract\NodeNameResolverInterface;
 use Rector\NodeTypeResolver\Node\AttributeKey;
 
+/**
+ * @implements NodeNameResolverInterface<Name>
+ */
 final class NameNameResolver implements NodeNameResolverInterface
 {
     public function __construct(
         private FuncCallNameResolver $funcCallNameResolver
     ) {
     }
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNode(): string
     {
         return Name::class;

diff --git a/packages/NodeNameResolver/NodeNameResolver/ParamNameResolver.php b/packages/NodeNameResolver/NodeNameResolver/ParamNameResolver.php
@@ -10,19 +10,19 @@
 use Rector\NodeNameResolver\NodeNameResolver;
 use Symfony\Contracts\Service\Attribute\Required;
 
+/**
+ * @implements NodeNameResolverInterface<Param>
+ */
 final class ParamNameResolver implements NodeNameResolverInterface
 {
     private NodeNameResolver $nodeNameResolver;
 
     #[Required]
-    public function autowireParamNameResolver(NodeNameResolver $nodeNameResolver): void
+    public function autowire(NodeNameResolver $nodeNameResolver): void
     {
         $this->nodeNameResolver = $nodeNameResolver;
     }
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNode(): string
     {
         return Param::class;

diff --git a/packages/NodeNameResolver/NodeNameResolver/PropertyNameResolver.php b/packages/NodeNameResolver/NodeNameResolver/PropertyNameResolver.php
@@ -10,19 +10,19 @@
 use Rector\NodeNameResolver\NodeNameResolver;
 use Symfony\Contracts\Service\Attribute\Required;
 
+/**
+ * @implements NodeNameResolverInterface<Property>
+ */
 final class PropertyNameResolver implements NodeNameResolverInterface
 {
     private NodeNameResolver $nodeNameResolver;
 
     #[Required]
-    public function autowirePropertyNameResolver(NodeNameResolver $nodeNameResolver): void
+    public function autowire(NodeNameResolver $nodeNameResolver): void
     {
         $this->nodeNameResolver = $nodeNameResolver;
     }
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNode(): string
     {
         return Property::class;

diff --git a/packages/NodeNameResolver/NodeNameResolver/UseNameResolver.php b/packages/NodeNameResolver/NodeNameResolver/UseNameResolver.php
@@ -10,19 +10,19 @@
 use Rector\NodeNameResolver\NodeNameResolver;
 use Symfony\Contracts\Service\Attribute\Required;
 
+/**
+ * @implements NodeNameResolverInterface<Use_>
+ */
 final class UseNameResolver implements NodeNameResolverInterface
 {
     private NodeNameResolver $nodeNameResolver;
 
     #[Required]
-    public function autowireUseNameResolver(NodeNameResolver $nodeNameResolver): void
+    public function autowire(NodeNameResolver $nodeNameResolver): void
     {
         $this->nodeNameResolver = $nodeNameResolver;
     }
 
-    /**
-     * @return class-string<Node>
-     */
     public function getNode(): string
     {
         return Use_::class;