phpstan.neon.dist

includes:
  - phpstan-baseline.neon
  - vendor/phpstan/phpstan-phpunit/extension.neon

parameters:
  level: 5
  paths:
    - benchmark
    - src
    - tests
  excludePaths:
    - tests/Tests/Mapping/Driver/fixtures/User.php
    - tests/Hydrators/
    - tests/PersistentCollections/ (?)
    - tests/Proxies/
    # PHP 8.4-only fixtures (property hooks, virtual properties). They are only
    # autoloaded on PHP >= 8.4 while the package supports PHP 8.1, so PHPStan's
    # composer.json-derived version range rejects them. The property.hooksNotSupported
    # error is non-ignorable, so the directory must be excluded from analysis.
    - tests/Documents84/
  treatPhpDocTypesAsCertain: false
  ignoreErrors:
      # Ignore typing providers in tests
      - '#^Method Doctrine\\ODM\\MongoDB\\Tests\\[^:]+(Test)::(get\w+|data\w+|provide\w+)\(\) return type has no value type specified in iterable type (array|iterable)\.#'

      # Ignore circular references in Psalm types
      - message: '#^Circular definition detected in type alias#'
        path: src/Aggregation/

      # Keep type assertions even when type is declared
      - identifier: staticMethod.alreadyNarrowedType
        path: tests/Tests/

      - message: '#generic class Doctrine\\ODM\\MongoDB\\(Mapping\\ClassMetadata|Persisters\\DocumentPersister) (but )?does not specify its types\: T$#'
        identifier: missingType.generics

      - message: '#^(Constant|Used constant) DOCTRINE_MONGODB_DATABASE not found\.$#'
        identifier: constant.notFound
        path: tests/

      # Unused properties from test document classes
      - message: '#^Property (DoctrineGlobal_|Documents\\|Doctrine\\ODM\\MongoDB\\Tests\\)[^:]+(?<!Test)::\$[a-zA-Z0-9_]+ is unused\.$#'
        identifier: property.unused
        path: tests/

      - message: '#^Property (DoctrineGlobal_|Documents\\|Doctrine\\ODM\\MongoDB\\Tests\\)[^:]+(?<!Test)::\$[a-zA-Z0-9_]+ is never written, only read\.$#'
        identifier: property.onlyRead
        path: tests/

      - message: '#^Property (DoctrineGlobal_|Documents\\|Doctrine\\ODM\\MongoDB\\Tests\\)[^:]+(?<!Test)::\$[a-zA-Z0-9_]+ is never read, only written\.$#'
        identifier: property.onlyWritten
        path: tests/

      - message: '#^Property (DoctrineGlobal_|Documents\\|Doctrine\\ODM\\MongoDB\\Tests\\)[^:]+(?<!Test)::\$[a-zA-Z0-9_]+ \(.*\) is never assigned .* so it can be removed from the property type\.$#'
        identifier: property.unusedType
        path: tests/

      # PHP 8.4 native lazy objects: PHPStan infers the parameter type as never when it can prove
      # the class is not lazy, but at runtime these are lazy proxies
      - message: '#^Parameter \#1 \$object of method ReflectionClass<.*>::markLazyObjectAsInitialized\(\) expects never#'
        identifier: argument.type

      # Requires ext-mongodb 2.2+
      - message: '#MongoDB\\BSON\\VectorType#'
      - message: '#MongoDB\\BSON\\Binary\:\:(TYPE_VECTOR|getVectorType|toArray|fromVector)#'

      - message: '#^Class Doctrine\\ODM\\MongoDB\\Mapping\\([a-zA-Z0-9\\]+) extends @final class Doctrine\\ODM\\MongoDB\\Mapping\\Attribute\\([a-zA-Z0-9\\]+)\.$#'
        identifier: class.extendsFinalByPhpDoc
        path: src/Mapping/Annotations/

  # To be removed when reaching phpstan level 6
  checkMissingVarTagTypehint: true
  checkMissingTypehints: true

  # Disabled due to inconsistent errors upon encountering psalm types
  reportUnmatchedIgnoredErrors: false

# To be removed when reaching phpstan level 6
rules:
    - PHPStan\Rules\Constants\MissingClassConstantTypehintRule
    - PHPStan\Rules\Functions\MissingFunctionParameterTypehintRule
    - PHPStan\Rules\Functions\MissingFunctionReturnTypehintRule
    - PHPStan\Rules\Methods\MissingMethodParameterTypehintRule
    - PHPStan\Rules\Methods\MissingMethodReturnTypehintRule
    - PHPStan\Rules\Properties\MissingPropertyTypehintRule