psalm.xml

<?xml version="1.0"?>
<psalm
    errorLevel="2"
    reportMixedIssues="false"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="https://getpsalm.org/schema/config"
    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
>
    <projectFiles>
        <directory name="src" />
        <ignoreFiles>
            <file name="src/Sylius/Bundle/CoreBundle/Application/Kernel.php" />
            <file name="src/Sylius/Bundle/ApiBundle/ApiPlatform/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php" />

            <directory name="src/Sylius/Behat" />

            <directory name="src/Sylius/Bundle/*/spec" />
            <directory name="src/Sylius/Bundle/*/test" />
            <directory name="src/Sylius/Bundle/*/Tests" />

            <directory name="src/Sylius/Component/*/spec" />

            <directory name="vendor" />
        </ignoreFiles>
    </projectFiles>

    <issueHandlers>
        <UndefinedDocblockClass>
            <errorLevel type="suppress">
                <referencedClass name="UnitEnum" />
            </errorLevel>
        </UndefinedDocblockClass>

        <!-- level 3 issues - slightly lazy code writing, but probably low false-negatives -->

        <DeprecatedClass>
            <errorLevel type="info">
                <referencedClass name="Payum\Core\Action\GatewayAwareAction" />
                <referencedClass name="Payum\Core\Security\GenericTokenFactoryInterface" />
                <referencedClass name="Sylius\Bundle\UserBundle\Security\UserPasswordEncoder"/>
                <referencedClass name="Sylius\Component\Core\Calculator\ProductVariantPriceCalculatorInterface" />
                <referencedClass name="Sylius\Component\User\Security\UserPasswordEncoderInterface" />
                <referencedClass name="Symfony\Component\Routing\RouteCollectionBuilder" /> <!-- deprecated in Symfony 5.1 -->
                <referencedClass name="Symfony\Component\Security\Http\Logout\DefaultLogoutSuccessHandler" /> <!-- deprecated in Symfony 5.1 -->
                <referencedClass name="Symfony\Component\Security\Core\Encoder\PasswordEncoderInterface" /> <!-- deprecated in Symfony 5.3 -->
                <referencedClass name="Symfony\Component\Security\Core\Encoder\EncoderAwareInterface" /> <!-- deprecated in Symfony 5.3 -->
                <referencedClass name="Symfony\Component\Security\Core\Encoder\EncoderFactoryInterface" /> <!-- deprecated in Symfony 5.3 -->
                <referencedClass name="Symfony\Component\Security\Core\Exception\UsernameNotFoundException" /> <!-- deprecated in Symfony 5.3 -->
                <referencedClass name="Symfony\Component\Serializer\Normalizer\ContextAwareNormalizerInterface" /> <!-- deprecated in Symfony 6.1, probably a bug in psalm, as this is referenced as DeprecatedClass, not an interface -->
                <referencedClass name="Symfony\Component\HttpFoundation\RequestMatcher" /> <!-- deprecated in Symfony 6.2 -->
            </errorLevel>
        </DeprecatedClass>
        <DeprecatedInterface>
            <errorLevel type="info">
                <referencedClass name="Sylius\Component\Core\Calculator\ProductVariantPriceCalculatorInterface" />
                <referencedClass name="Sylius\Component\User\Security\UserPasswordEncoderInterface" />
                <referencedClass name="Symfony\Component\Security\Core\Encoder\EncoderAwareInterface" /> <!-- deprecated in Symfony 5.3 -->
                <referencedClass name="Symfony\Component\Security\Http\Logout\LogoutSuccessHandlerInterface" /> <!-- deprecated in Symfony 5.1 -->
                <referencedClass name="Symfony\Component\Security\Core\Encoder\EncoderAwareInterface" /> <!-- deprecated in Symfony 5.3 -->
                <referencedClass name="Symfony\Component\Serializer\Normalizer\ContextAwareDenormalizerInterface" /> <!-- deprecated in Symfony 6.1 -->
                <referencedClass name="Symfony\Component\Serializer\Normalizer\ContextAwareNormalizerInterface" /> <!-- deprecated in Symfony 6.1 -->
                <referencedClass name="Symfony\Component\Messenger\Handler\MessageHandlerInterface" /> <!-- deprecated in Symfony 6.2 -->
            </errorLevel>
        </DeprecatedInterface>
        <DeprecatedMethod>
            <errorLevel type="info">
                <referencedMethod name="Faker\Generator::__get"/>
                <referencedMethod name="Payum\Core\Model\GatewayConfigInterface::setFactoryName" />
                <referencedMethod name="Sylius\Component\Mailer\Sender\SenderInterface::send"/>
                <referencedMethod name="Symfony\Component\HttpFoundation\JsonResponse::create" /> <!-- deprecated in Symfony 5.1 -->
                <referencedMethod name="Symfony\Component\HttpKernel\Event\KernelEvent::isMasterRequest" /> <!-- deprecated in Symfony 5.3 -->
                <referencedMethod name="Symfony\Component\Security\Core\Authentication\Token\AbstractToken::isAuthenticated" /> <!-- deprecated in Symfony 5.4 -->
                <referencedMethod name="Symfony\Component\Security\Core\Authentication\Token\TokenInterface::getUsername" /> <!-- deprecated in Symfony 5.3 -->
                <referencedMethod name="Symfony\Component\Security\Core\User\UserInterface::getUsername" /> <!-- deprecated in Symfony 5.3 -->
                <referencedMethod name="Symfony\Component\Security\Core\User\UserProviderInterface::loadUserByUsername" /> <!-- deprecated in Symfony 5.3 -->
                <referencedMethod name="Symfony\Component\Security\Core\Authentication\Token\AbstractToken::isAuthenticated" /> <!-- deprecated in Symfony 5.4 -->
            </errorLevel>
        </DeprecatedMethod>

        <InternalMethod>
            <errorLevel type="info">
                <referencedMethod name="PHPUnit\Framework\TestCase::__construct" />
                <referencedMethod name="Symfony\Bundle\SecurityBundle\Security\_FirewallMap::getFirewallConfig" />
                <referencedMethod name="ApiPlatform\Core\Util\RequestParser::getQueryString" />
                <referencedMethod name="ApiPlatform\Util\RequestParser::getQueryString" />
                <referencedMethod name="ApiPlatform\Core\Util\RequestParser::parseRequestParams" />
                <referencedMethod name="ApiPlatform\Util\RequestParser::parseRequestParams" />
            </errorLevel>
        </InternalMethod>

        <InternalClass>
            <errorLevel type="info">
                <referencedClass name="ApiPlatform\Core\Util\RequestParser" />
            </errorLevel>
        </InternalClass>

        <InvalidDocblock>
            <errorLevel type="info">
                <file name="vendor/doctrine/orm/lib/Doctrine/ORM/EntityRepository.php" />
            </errorLevel>
        </InvalidDocblock>

        <UndefinedMethod>
            <errorLevel type="suppress">
                <referencedMethod name="Symfony\Component\HttpFoundation\RequestStack::getSession" />
                <referencedMethod name="Symfony\Component\HttpKernel\Event\RequestEvent::isMasterRequest" />
                <referencedMethod name="Symfony\Component\HttpKernel\Event\ExceptionEvent::isMasterRequest" />
                <referencedMethod name="Symfony\Component\HttpKernel\Event\ResponseEvent::isMasterRequest" />
            </errorLevel>
        </UndefinedMethod>

        <UndefinedInterfaceMethod>
            <errorLevel type="suppress">
                <referencedMethod name="Symfony\Component\Security\Core\User\UserInterface::getPassword" />
                <referencedMethod name="Symfony\Component\Security\Core\User\UserInterface::getUsername" />
                <referencedMethod name="Sylius\Component\User\Model\UserInterface::getUsername" />
                <referencedMethod name="Sylius\Component\Core\Model\ShopUserInterface::getUsername" />
            </errorLevel>
        </UndefinedInterfaceMethod>

        <MissingReturnType errorLevel="info" />

        <PropertyNotSetInConstructor errorLevel="info" />
        <MissingConstructor>
            <errorLevel type="info">
                <file name="src/Sylius/Bundle/CoreBundle/Application/SyliusPluginTrait.php" />
            </errorLevel>
        </MissingConstructor>
        <MissingParamType errorLevel="info" />

        <DuplicateClass>
            <errorLevel type="info">
                <file name="src/Sylius/Component/User/Model/CredentialsHolderInterface.php" />
            </errorLevel>
        </DuplicateClass>

        <RedundantConditionGivenDocblockType errorLevel="info" />

        <!-- level 4 issues - points to possible deficiencies in logic, higher false-positives -->

        <MoreSpecificReturnType errorLevel="info" />
        <LessSpecificReturnStatement errorLevel="info" />
        <ArgumentTypeCoercion errorLevel="info" />
        <PropertyTypeCoercion errorLevel="info" />

        <PossiblyInvalidArgument errorLevel="info" />
        <PossiblyInvalidArrayAccess errorLevel="info" />
        <PossiblyInvalidArrayAssignment errorLevel="info" />
        <PossiblyInvalidArrayOffset errorLevel="info" />
        <PossiblyInvalidCast errorLevel="info" />
        <PossiblyInvalidFunctionCall errorLevel="info" />
        <PossiblyInvalidIterator errorLevel="info" />
        <PossiblyInvalidMethodCall errorLevel="info" />
        <PossiblyInvalidOperand errorLevel="info" />
        <PossiblyInvalidPropertyAssignment errorLevel="info" />
        <PossiblyInvalidPropertyAssignmentValue errorLevel="info" />
        <PossiblyInvalidPropertyFetch errorLevel="info" />
        <PossiblyNullArgument errorLevel="info" />
        <PossiblyNullArrayAccess errorLevel="info" />
        <PossiblyNullArrayAssignment errorLevel="info" />
        <PossiblyNullArrayOffset errorLevel="info" />
        <PossiblyNullFunctionCall errorLevel="info" />
        <PossiblyNullIterator errorLevel="info" />
        <PossiblyNullOperand errorLevel="info" />
        <PossiblyNullPropertyAssignment errorLevel="info" />
        <PossiblyNullPropertyAssignmentValue errorLevel="info" />
        <PossiblyNullPropertyFetch errorLevel="info" />
        <PossiblyNullReference errorLevel="info" />
        <PossiblyUndefinedMethod>
            <errorLevel type="info">
                <referencedMethod name="Symfony\Component\Config\Definition\Builder\NodeDefinition::arrayNode" />
                <referencedMethod name="Symfony\Component\Config\Definition\Builder\NodeDefinition::booleanNode" />
                <referencedMethod name="Symfony\Component\Config\Definition\Builder\NodeDefinition::children" />
                <referencedMethod name="Symfony\Component\Config\Definition\Builder\NodeDefinition::integerNode" />
                <referencedMethod name="Symfony\Component\Config\Definition\Builder\NodeDefinition::scalarNode" />
                <referencedMethod name="Symfony\Component\Config\Definition\Builder\NodeDefinition::variableNode" />
                <referencedMethod name="Symfony\Component\Config\Definition\Builder\NodeParentInterface::end" />
                <referencedMethod name="Symfony\Component\Config\Definition\Builder\VariableNodeDefinition::arrayNode" />
                <referencedMethod name="Symfony\Component\Config\Definition\Builder\VariableNodeDefinition::booleanNode" />
                <referencedMethod name="Symfony\Component\Config\Definition\Builder\VariableNodeDefinition::children" />
                <referencedMethod name="Symfony\Component\Config\Definition\Builder\VariableNodeDefinition::integerNode" />
                <referencedMethod name="Symfony\Component\Config\Definition\Builder\VariableNodeDefinition::scalarNode" />
                <referencedMethod name="Symfony\Component\Config\Definition\Builder\VariableNodeDefinition::variableNode" />
            </errorLevel>
        </PossiblyUndefinedMethod>

        <!-- level 5 issues - should be avoided at mosts costs... -->

        <TooManyArguments>
            <errorLevel type="info">
                <referencedFunction name="Symfony\Contracts\EventDispatcher\EventDispatcherInterface::dispatch" />
                <referencedFunction name="Symfony\Component\HttpKernel\Config\FileLocator::__construct" />
                <referencedFunction name="Symfony\Contracts\EventDispatcher\EventDispatcherInterface::dispatch" />
                <referencedFunction name="Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken::__construct" /> <!-- removed parameter in Symfony 5.4 -->
            </errorLevel>
            <errorLevel type="suppress">
                <referencedFunction name="Doctrine\ORM\Query\Expr::andX" />
                <referencedFunction name="Doctrine\ORM\Query\Expr::orX" />
                <referencedFunction name="Symfony\Component\PasswordHasher\PasswordHasherInterface::hash" />
            </errorLevel>
        </TooManyArguments>
        <UndefinedClass>
            <errorLevel type="info">
                <referencedClass name="Symfony\Component\Security\Core\Encoder\EncoderFactoryInterface" />
            </errorLevel>
        </UndefinedClass>

        <!-- level 6 issues - really bad things -->

        <InvalidNullableReturnType errorLevel="info" />
        <NullableReturnStatement errorLevel="info" />
        <InvalidFalsableReturnType errorLevel="info" />
        <FalsableReturnStatement errorLevel="info" />

        <MoreSpecificImplementedParamType errorLevel="info" />
        <LessSpecificImplementedReturnType errorLevel="info" />

        <!-- level 7 issues - even worse -->

        <InvalidArgument>
            <errorLevel type="info">
                <referencedFunction name="Symfony\Component\EventDispatcher\EventDispatcherInterface::dispatch" />
                <referencedFunction name="SyliusLabs\AssociationHydrator\AssociationHydrator::__construct" />
                <referencedFunction name="Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken::__construct" />
            </errorLevel>
        </InvalidArgument>

        <!-- level 8 issues - some fatal errors in PHP -->

        <MethodSignatureMismatch errorLevel="info" />
    </issueHandlers>

    <stubs>
        <file name="etc/psalm/LaminasPriorityQueueStub.php" />
    </stubs>

    <plugins>
        <pluginClass class="Psalm\MockeryPlugin\Plugin" />
    </plugins>
</psalm>