phpstan.neon

includes:
    - vendor/symplify/phpstan-rules/config/rector-rules.neon

rules:
    - Rector\Utils\PHPStan\Rule\RegisterRelatedPolyfillRectorRule
    - Rector\Utils\PHPStan\Rule\NoScopeFetchBeforeCheapGuardRule
    - Rector\Utils\PHPStan\Rule\NarrowReturnToUnionParamRule

parameters:
    level: 8

    # reportUnmatchedIgnoredErrors: false
    errorFormat: symplify

    # see https://phpstan.org/writing-php-code/phpdoc-types#global-type-aliases
    typeAliases:
        StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\FileNode | \PhpParser\Node\Stmt\Declare_

    # requires exact closure types
    checkMissingCallableSignature: true
    treatPhpDocTypesAsCertain: false

    paths:
        - bin
        - config
        - src
        - rules
        - scripts
        # tests
        - tests
        - rules-tests
        - utils
        - scripts
        - rector.php
        - e2e/e2eTestRunner.php

    scanDirectories:
        - stubs

    excludePaths:
        - '*tests/*/Fixture/*'
        - '*tests/*/Fixture*'
        - '*tests/*/Source/*'
        - '*tests/*/Source*'
        # standalone dev benchmark, shells out and parses getopt by hand
        - 'scripts/rector-jobsize-benchmark.php'
        - 'scripts/rector-ab-benchmark.php'

    # see https://github.com/symplify/phpstan-rules
    symplify:
        pathStrings: true
        naming: true
        complexity: true
        configurable: true
        static: true
        phpunit: true
        mocks: true
        ctor: true

    # see https://github.com/TomasVotruba/type-coverage
    type_coverage:
        return_type: 99
        param_type: 99
        property_type: 99
        constant_type: 99
    type_perfect:
        no_mixed: true
        null_over_false: true
        narrow_param: true
        narrow_return: true

    # offload breaks cold-cache parallel runs, keep collector data in result cache
    shipmonkDeadCode:
        cache:
            offloadCollectorData: false

    ignoreErrors:
        # called magically by parent
        -
            message: '#^Unused Rector\\PhpParser\\Printer\\BetterStandardPrinter\:\:(pInterpolatedStringPart|pStmt_FileNode)$#'
            identifier: shipmonk.deadMethod
            path: src/PhpParser/Printer/BetterStandardPrinter.php

        # deprecated, to be removed
        -
            message: '#^Unused Rector\\Set\\Contract\\SetInterface\:\:(.*?)$#'
            identifier: shipmonk.deadMethod
            path: src/Set/Contract/SetInterface.php

        # the deprecated set objects are still resolved internally, until every extension bonds its rules
        -
            message: '#deprecated (class|interface) Rector\\(Set|Bridge)\\#'
            path: src/Configuration/RectorConfigBuilder.php

        # EARLY_RETURN set is deprecated (empty, merged into code-quality), still mapped internally until removed
        -
            identifier: classConstant.deprecated
            paths:
                - src/Configuration/RectorConfigBuilder.php

        # the deprecated SetList::PHP_* constants are still resolved internally by the level sets and their tests
        -
            identifier: classConstant.deprecated
            paths:
                - config/set/level
                - tests/Bridge/SetRectorsResolverTest.php

        # the deprecated github/gitlab output formatters are still tested until removed in next minor version
        -
            identifier: new.deprecatedClass
            path: tests/ChangesReporting/Output/GitHubOutputFormatterTest.php

        -
            identifier: method.deprecatedClass
            path: tests/ChangesReporting/Output/GitHubOutputFormatterTest.php

        -
            identifier: argument.templateType
            path: rules/TypeDeclaration/Rector/FunctionLike/AddClosureParamTypeForArrayReduceRector.php

        -
            identifier: argument.type
            message: '#(.*?) class\-string, string given#'

        -
            identifier: argument.type
            message: '#Parameter \#1 \$phpVersion of method Rector\\Config\\RectorConfig\:\:phpVersion\(\) expects 50200\|50300\|50400\|50500\|50600\|70000\|70100\|70200\|70300\|70400\|80000\|80100\|80200\|80300\|80400\|80500\|80600\|100000, 79999 given#'

        # node vs stmts mix
        -
            identifier: argument.type
            message: '#expects array<PhpParser\\Node\\Stmt>, array<PhpParser\\Node> given#'

        # false positive, can accept non-class string
        -
            identifier: argument.type
            message: '#Parameter \#1 \$name of method PHPStan\\BetterReflection\\Reflection\\Adapter\\ReflectionClass\:\:getAttributes\(\) expects class\-string\|null, string given#'

        # false positive, checked above
        -
            identifier: argument.type
            message: '#Parameter \#1 \$items of class PhpParser\\Node\\Expr\\Array_ constructor expects array<PhpParser\\Node\\ArrayItem>, array<PhpParser\\Node\\ArrayItem\|null> given#'
            path: rules/Php71/Rector/List_/ListToArrayDestructRector.php

        # scope vs mutating scope
        -
            identifier: argument.type
            message: '#Parameter \#3 \$nodeCallback of method PHPStan\\Analyser\\NodeScopeResolver\:\:processNodes\(\) expects callable\(PhpParser\\Node, PHPStan\\Analyser\\Scope\)\: void, callable\(PhpParser\\Node, PHPStan\\Analyser\\MutatingScope\)\: void given#'

        # list vs array
        -
            identifier: argument.type
            message: '#Parameter (.*?) expects list<(.*?)>, array<(.*?)> given#'

        -
            identifier: argument.type
            paths:
                - rules/Privatization/TypeManipulator/TypeNormalizer.php
                - rules/TypeDeclaration/Rector/FunctionLike/AddClosureParamTypeForArrayReduceRector.php
                - rules/TypeDeclarationDocblocks/Rector/Class_/AddVarArrayDocblockFromDimFetchAssignRector.php
                - src/NodeTypeResolver/PHPStan/Type/TypeFactory.php

        # classes are part of *.php.inc fixture
        -
            identifier: class.notFound
            message: '#Class (.*?) not found#'
            paths:
                - rules-tests/Arguments/Rector/ClassMethod/ReplaceArgumentDefaultValueRector/config
                - rules-tests/TypeDeclaration/Rector/ClassMethod/AddReturnTypeDeclarationRector/config
                - rules-tests/Renaming/Rector/Name/RenameClassRector/config
                - rules-tests/Renaming/Rector/MethodCall/RenameMethodRector/config
                - rules-tests/Arguments/Rector/ClassMethod/ArgumentAdderRector/config

        -
            identifier: deadCode.unreachable
            paths:
                - src/Console/Notifier.php
                - src/Util/FileHasher.php

        # stmts aware/expression generics
        -
            identifier: generics.notGeneric
            message: '#PhpParser\\Node\\Stmt\\Expression is not generic#'

        # runtime php id
        -
            identifier: greaterOrEqual.alwaysTrue
            path: src/Util/FileHasher.php

        # runtime comparison
        -
            identifier: greaterOrEqual.alwaysTrue
            message: '#Comparison operation ".*" between int<\d+, \d+> and \d+ is always true#'

        # known value object, nullable due to typed property
        -
            identifier: method.nonObject
            message: '#Cannot call method (.*?)\(\) on (.*?)\\ProcessPool\|null#'
            path: src/Parallel/Application/ParallelFileProcessor.php

        # required generics on interface array, not helpful
        -
            identifier: missingType.generics
            message: '#Method (.*?)\:\:__construct\(\) has parameter#'

        -
            identifier: missingType.generics
            message: '#(.*?) with generic interface (.*?)Interface does not specify its types#'

        # generated class in /vendor
        -
            identifier: nullCoalesce.offset
            message: '#Offset (.*?) on null on left side of \?\? does not exist#'
            path: src/Bootstrap/ExtensionConfigResolver.php

        # false positive
        -
            identifier: offsetAccess.invalidOffset
            path: src/CustomRules/SimpleNodeDumper.php

        -
            identifier: offsetAccess.nonArray
            path: src/PhpParser/NodeTraverser/RectorNodeTraverser.php

        -
            identifier: offsetAccess.notFound
            message: '#Offset float\|int\|string might not exist on string#'
            path: rules/Php70/EregToPcreTransformer.php

        # phpstan internalls
        - identifier: phpstanApi.class
        - identifier: phpstanApi.classConstant
        - identifier: phpstanApi.constructor
        - identifier: phpstanApi.instanceofAssumption
        - identifier: phpstanApi.method

        # buggy, # see https://github.com/rectorphp/rector-src/actions/runs/11798721617/job/32865546672?pr=6422#step:5:110
        -
            identifier: phpstanApi.instanceofType
            message: '#Doing instanceof PHPStan\\Type\\.+ is error\-prone and deprecated#'

        # is nested expr
        -
            identifier: property.notFound
            paths:
                - rules/DeadCode/NodeManipulator/LivingCodeManipulator.php
                - src/PhpParser/Printer/BetterStandardPrinter.php
                - src/CustomRules/SimpleNodeDumper.php

        -
            identifier: rector.noClassReflectionStaticReflection
            paths:
                - scripts
                - src/Configuration/OnlyRuleResolver.php
                - src/Util/Reflection/PrivatesAccessor.php

        # the local instanceof for known types
        -
            identifier: rector.noInstanceOfStaticReflection
            message: '#Instead of "instanceof/is_a\(\)" use ReflectionProvider service or "\(new ObjectType\(<desired_type>\)\)\->isSuperTypeOf\(<element_type>\)" for static reflection to work#'

        # outside sets on purpose, as risky
        -
            identifier: rector.upgradeDowngradeRegisteredInSet
            paths:
                - rules/Php81/Rector/FuncCall/NullToStrictStringFuncCallArgRector.php
                - rules/Php80/Rector/NotIdentical/MbStrContainsRector.php

        # lack of generic array in nikic/php-parser
        -
            identifier: return.type
            message: '#Method (.*?) should return array<PhpParser\\Node\\(.*?)\> but returns array<PhpParser\\Node\>#'

        # generics nullable bugs
        -
            identifier: return.type
            paths:
                - src/PhpParser/Node/BetterNodeFinder.php
                - rules/DeadCode/Rector/Class_/RemoveRefactorDuplicatedNodeInstanceCheckRector.php

        # known value
        -
            identifier: return.type
            message: '#Method (.*?) should return 50200\|50300\|50400\|50500\|50600\|70000\|70100\|70200\|70300\|70400\|80000\|80100\|80200\|80300\|80400\|80500\|80600\|100000 but returns int#'

        # from constant string
        -
            identifier: return.type
            message: '#Method Rector\\.*::filterPolyfillPackages\(\) should return array\<#'

        -
            identifier: return.type
            paths:
                - src/NodeTypeResolver/PHPStan/Type/TypeFactory.php
                - rules/Arguments/ArgumentDefaultValueReplacer.php

        # from mapper interface
        -
            identifier: return.unusedType
            message: '#mapToPhpParserNode\(\) never returns PhpParser\\.* so it can be removed from the return#'

        # false positive
        -
            identifier: return.unusedType
            message: '#Method (.*?)refactor\(\) (never returns|should return) (.*?)#'
            path: rules/Php70/Rector/If_/IfToSpaceshipRector.php

        -
            identifier: symplify.forbiddenFuncCall
            message: '#Function "property_exists\(\)" cannot be used/left in the code#'
            paths:
                - src/NodeNameResolver/NodeNameResolver.php
                - src/BetterPhpDocParser/PhpDocParser/BetterPhpDocParser.php
                - src/BetterPhpDocParser/NodeDecorator/DoctrineAnnotationDecorator.php

        -
            identifier: symplify.forbiddenFuncCall
            message: '#Function "class_exists\(\)" cannot be used/left in the code#'
            paths:
                - bin/rector.php
                - src/Bootstrap/ExtensionConfigResolver.php
                - src/Configuration/RectorConfigBuilder.php
                - src/Validation/RectorConfigValidator.php
                - src/Testing/PHPUnit/AbstractLazyTestCase.php
                - src/Configuration/OnlyRuleResolver.php

        # debug and internal functions
        -
            identifier: symplify.forbiddenFuncCall
            paths:
                - src/functions/node_helper.php
                - tests/debug_functions.php
                - src/Util/Reflection/PrivatesAccessor.php

        # it may return array<Node|null> in case of empty array( , , ), very rare and would nullify all other types
        - '#Method Rector\\PhpParser\\NodeTraverser\\RectorNodeTraverser\:\:traverseArray\(\) should return array<PhpParser\\Node> but returns array<PhpParser\\Node\|null>#'

        # checks for rector always autoloaded rules only
        -
            identifier: symplify.forbiddenFuncCall
            message: '#Function "(class_exists|interface_exists)\(\)" cannot be used/left in the code\: use ReflectionProvider\->has\*\(\) instead#'
            paths:
                - src/Skipper/Skipper/Skipper.php

        -
            identifier: symplify.noConstructorOverride
            path: src/StaticTypeMapper/ValueObject/Type/SimpleStaticType.php

        # dynamic printer
        -
            identifier: symplify.noDynamicName
            message: '#Use explicit names over dynamic ones#'

        # reference params in legacy/perf code, kept as original
        -
            identifier: symplify.noReference
            message: '#Use explicit return value over magic &reference#'
            paths:
                - src/PhpDocParser/PhpDocParser/PhpDocNodeTraverser.php
                - rules/Php70/EregToPcreTransformer.php
                - src/BetterPhpDocParser/PhpDocManipulator/PhpDocClassRenamer.php
                - src/NodeTypeResolver/PHPStan/Type/TypeFactory.php
                - rules/CodeQuality/NodeAnalyzer/VariableDimFetchAssignResolver.php
                - src/Parallel/Experimental/ExperimentalParallelFileProcessor.php

        -
            identifier: symplify.noNullableServiceInConstructor
            path: src/NodeTypeResolver/PHPStan/ObjectWithoutClassTypeWithParentTypes.php

        - identifier: symplify.commandHasAsCommandAttribute

        # fixture Rector rules
        -
            identifier: symplify.seeAnnotationToTest
            paths:
                - tests/Issues/
                - tests/PhpParser/NodeTraverser/StopTraverseOnTypeChange/Class_

        # known types
        -
            identifier: varTag.nativeType
            path: src/BetterPhpDocParser/PhpDocParser/StaticDoctrineAnnotationParser.php