psalm.xml

<?xml version="1.0"?>
<psalm
    ensureArrayStringOffsetsExist="true"
    findUnusedVariablesAndParams="true"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="https://getpsalm.org/schema/config"
    xsi:schemaLocation="https://getpsalm.org/schema/config vendor-bin/psalm/vendor/vimeo/psalm/config.xsd"
>
    <projectFiles>
        <directory name="src"/>
        <ignoreFiles>
            <directory name="vendor"/>
            <directory name="src/Recovery"/>
            <file name="src/Docs/Resources/current/60-references-internals/10-core/50-checkout-process/_examples/10-cart-example.php"/>
            <file name="src/Docs/Resources/deprecated/2-internals/1-core/50-checkout-process/_examples/10-cart-example.php"/>
            <!-- Would otherwise inspect node_modules directories of JS applications -->
            <directory name="src/*/Resources/app" />

            <!-- Compatibility fixes for doctrine annotation parser https://github.com/doctrine/annotations/issues/421 -->
            <file name="src/Core/Framework/Compatibility/AnnotationReader.php"/>
            <file name="src/Core/Framework/Compatibility/DocParser.php"/>

            <!-- twig override -->
            <file name="src/Core/Framework/Adapter/Twig/TwigEnvironment.php"/>

            <!-- Remove with Symfony 6.0 Upgrade -->
            <file name="src/Core/Content/Mail/Service/MailerTransportFactory.php"/>
        </ignoreFiles>
    </projectFiles>

    <plugins>
        <pluginClass class="Psalm\SymfonyPsalmPlugin\Plugin"/>
        <pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>
    </plugins>

    <issueHandlers>
        <UndefinedDocblockClass>
            <errorLevel type="info">
                <!-- Optional dependencies -->
                <referencedClass name="Redis"/>
                <!-- Psalm issue with templates in static methods -->
                <referencedClass name="Shopware\Core\Framework\Adapter\Cache\TCachedContent"/>
            </errorLevel>
        </UndefinedDocblockClass>

        <UnusedClosureParam>
            <errorLevel type="info">
                <file name="src/Core/Content/Test/Product/SalesChannel/Listing/CachedProductListingRouteTest.php"/>
                <file name="src/Core/Content/Test/Category/SalesChannel/CachedCategoryRouteTest.php"/>
                <file name="src/Core/Content/Test/Category/SalesChannel/CachedNavigationRouteTest.php"/>
            </errorLevel>
        </UnusedClosureParam>

        <!-- Shopware related issues which are ignored -->
        <UnusedMethodCall>
            <errorLevel type="info">
                <referencedMethod name="Symfony\Component\Config\Definition\Builder\NodeDefinition::end"/>
            </errorLevel>
        </UnusedMethodCall>

        <UnusedFunctionCall>
            <errorLevel type="info">
                <file name="src/Core/Framework/Test/Migration/MigrationCollectionRuntimeTest.php"/>
            </errorLevel>
        </UnusedFunctionCall>

        <MethodSignatureMismatch>
            <errorLevel type="info">
                <!-- Issue in Psalm Symfony plugin https://github.com/psalm/psalm-plugin-symfony/issues/147 -->
                <file name="src/Core/Framework/Validation/DataBag/DataBag.php"/>
                <file name="src/Core/DevOps/StaticAnalyze/StaticAnalyzeKernel.php"/>
            </errorLevel>
        </MethodSignatureMismatch>

        <InvalidIterator>
            <errorLevel type="info">
                <!-- Seems to be an issue in the Psalm Symfony plugin -->
                <file name="src/Core/Checkout/Cart/SalesChannel/CartItemAddRoute.php"/>
                <file name="src/Core/Checkout/Cart/SalesChannel/CartItemUpdateRoute.php"/>
            </errorLevel>
        </InvalidIterator>

        <InvalidCast>
            <errorLevel type="info">
                <file name="src/Core/Profiling/Twig/DoctrineExtension.php"/>
                <file name="src/Core/Framework/Test/Seo/StorefrontSalesChannelTestHelper.php"/>
                <file name="src/Core/Framework/Test/TestCaseBase/AdminApiTestBehaviour.php"/>
            </errorLevel>
        </InvalidCast>

        <InvalidParamDefault>
            <errorLevel type="info">
                <file name="src/Core/Framework/DataAbstractionLayer/Search/EntitySearchResult.php"/>
            </errorLevel>
        </InvalidParamDefault>

        <UndefinedConstant>
            <errorLevel type="info">
                <file name="src/Core/Framework/Test/Plugin/Util/PluginFinderTest.php"/>
                <file name="src/Core/Framework/Test/TestCaseBase/KernelLifecycleManagerTest.php"/>
                <file name="src/Core/Framework/Test/Plugin/KernelPluginLoader/DbalKernelPluginLoaderTest.php"/>
                <file name="src/Core/Framework/Test/Plugin/KernelPluginLoader/StaticKernelPluginLoaderTest.php"/>
                <file name="src/Core/Framework/Test/Plugin/KernelPluginLoader/ComposerPluginLoaderTest.php"/>
                <file name="src/Core/Framework/Test/Plugin/KernelPluginIntegrationTest.php"/>
            </errorLevel>
        </UndefinedConstant>

        <UndefinedClass>
            <errorLevel type="info">
                <referencedClass name="SwagTest\SwagTest"/>
            </errorLevel>
        </UndefinedClass>

        <DuplicateClass>
            <errorLevel type="info">
                <file name="src/Core/Framework/Api/Sync/SyncBehavior.php"/>
                <file name="src/Core/Framework/Api/Sync/SyncResult.php"/>
                <file name="src/Core/Framework/DataAbstractionLayer/Field/Flag/AllowHtml.php" />
            </errorLevel>
        </DuplicateClass>

        <UndefinedMethod>
            <errorLevel type="suppress">
                <referencedMethod name="Shopware\Core\Framework\Api\Sync\SyncBehavior::failOnError" />
                <referencedMethod name="Composer\InstalledVersions::getallrawdata"/>
            </errorLevel>
        </UndefinedMethod>

        <InaccessibleMethod>
            <errorLevel type="info">
                <file name="src/Core/Framework/Test/Update/UpdateControllerTest.php"/>
            </errorLevel>
        </InaccessibleMethod>

        <NonInvariantDocblockPropertyType>
            <errorLevel type="info">
                <!-- The property $object typehint in the Responses is more specific than in the parent class-->
                <file name="src/Core/**/**/**/**/*Response.php"/>
                <file name="src/Core/**/**/**/*Response.php"/>
                <file name="src/Core/**/**/*Response.php"/>
                <!-- The property $storageName could be null here, but is only string in the parent class -->
                <file name="src/Core/Framework/DataAbstractionLayer/Field/ReferenceVersionField.php"/>
                <!-- Parent class from external library has no property type specified -->
                <file name="src/Core/Framework/Demodata/Faker/Commerce.php"/>
            </errorLevel>
        </NonInvariantDocblockPropertyType>

        <UnsafeInstantiation errorLevel="info">
            <errorLevel type="info">
                <file name="src/Core/Kernel.php"/>
            </errorLevel>
        </UnsafeInstantiation>

        <ParamNameMismatch>
            <errorLevel type="info">
                <!-- Collections -->
                <file name="src/Core/Checkout/Cart/Delivery/Struct/DeliveryPositionCollection.php"/>
                <file name="src/Core/Checkout/Cart/LineItem/LineItemCollection.php"/>
                <file name="src/Core/Checkout/Cart/Tax/Struct/CalculatedTaxCollection.php"/>
                <file name="src/Core/Checkout/Cart/Tax/Struct/TaxRuleCollection.php"/>
                <file name="src/Core/Content/Cms/Aggregate/CmsSlot/CmsSlotCollection.php"/>
                <file name="src/Core/Content/ProductExport/Error/ErrorCollection.php"/>
                <file name="src/Core/Content/ImportExport/Processing/Mapping/MappingCollection.php"/>
                <file name="src/Core/Framework/DataAbstractionLayer/Search/AggregationResult/AggregationResultCollection.php"/>
                <file name="src/Core/Framework/Rule/RuleCollection.php"/>
                <file name="src/Core/Checkout/Cart/Error/ErrorCollection.php"/>
                <file name="src/Core/Framework/App/Validation/Error/ErrorCollection.php"/>
                <file name="src/Core/Framework/DataAbstractionLayer/CompiledFieldCollection.php"/>
                <file name="src/Core/Framework/DataAbstractionLayer/EntityCollection.php"/>
                <file name="src/Core/System/Snippet/Files/SnippetFileCollection.php"/>

                <!-- I'm puzzled why these errors started appearing now  -->
                <file name="src/Core/Checkout/Document/FileGenerator/PdfGenerator.php"/>
                <file name="src/Core/Checkout/Payment/Cart/Token/JWTFactoryV2.php"/>
                <file name="src/Core/Checkout/Test/Cart/Common/FalseRule.php"/>
                <file name="src/Core/Checkout/Test/Cart/Common/TrueRule.php"/>
                <file name="src/Core/Content/Media/Message/GenerateThumbnailsHandler.php"/>
                <file name="src/Core/Content/ProductExport/ScheduledTask/ProductExportPartialGenerationHandler.php"/>
                <file name="src/Core/Content/Sitemap/ScheduledTask/SitemapGenerateTaskHandler.php"/>
                <file name="src/Core/Framework/DataAbstractionLayer/Dbal/EntityWriteGateway.php"/>
                <file name="src/Core/Framework/DataAbstractionLayer/Search/EntitySearchResult.php"/>
                <file name="src/Core/Framework/MessageQueue/ScheduledTask/ScheduledTaskHandler.php"/>
                <file name="src/Core/Framework/Struct/ArrayEntity.php"/>
                <file name="src/Core/Migration/Test/NullConnection.php"/>
                <file name="src/Elasticsearch/Profiler/ClientProfiler.php"/>

                <!-- Implementations of interfaces have a more describing parameter name -->
                <file name="src/Core/Checkout/Cart/LineItem/Group/Packager/*Packager.php"/>
                <file name="src/Core/Checkout/Customer/Validation/Constraint/CustomerPasswordMatchesValidator.php"/>
                <file name="src/Core/Checkout/Customer/Validation/Constraint/CustomerVatIdentificationValidator.php"/>
                <file name="src/Core/Content/ImportExport/DataAbstractionLayer/Serializer/Field/*Serializer.php"/>
                <file name="src/Storefront/Framework/Seo/SeoUrlRoute/*PageSeoUrlRoute.php"/>
                <file name="src/Core/Framework/Test/Routing/TestRouteLoader.php"/>
            </errorLevel>
        </ParamNameMismatch>

        <!-- Issue in Psalm https://github.com/vimeo/psalm/issues/2706 -->
        <InaccessibleProperty>
            <errorLevel type="info">
                <file name="src/Core/Framework/Api/Controller/CacheController.php"/>
            </errorLevel>
        </InaccessibleProperty>

        <!-- Remove when NEXT-15687 flag has been removed -->
        <RedundantPropertyInitializationCheck>
            <errorLevel type="suppress">
                <file name="src/Storefront/Controller/StorefrontController.php"/>
            </errorLevel>
        </RedundantPropertyInitializationCheck>

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

        <DeprecatedMethod errorLevel="info"/>
        <DeprecatedProperty errorLevel="info"/>
        <DeprecatedClass errorLevel="info"/>
        <DeprecatedConstant errorLevel="info"/>
        <DeprecatedFunction errorLevel="info"/>
        <DeprecatedInterface errorLevel="info"/>
        <DeprecatedTrait errorLevel="info"/>

        <InternalMethod errorLevel="info"/>
        <InternalProperty errorLevel="info"/>
        <InternalClass errorLevel="info"/>

        <MissingClosureReturnType errorLevel="info"/>
        <MissingReturnType errorLevel="info"/>
        <MissingPropertyType errorLevel="info"/>
        <InvalidDocblock errorLevel="info"/>

        <PropertyNotSetInConstructor errorLevel="info"/>
        <MissingConstructor errorLevel="info"/>
        <MissingClosureParamType errorLevel="info"/>
        <MissingParamType errorLevel="info"/>

        <RedundantCondition errorLevel="info"/>

        <DocblockTypeContradiction errorLevel="info"/>
        <RedundantConditionGivenDocblockType errorLevel="info"/>

        <UnresolvableInclude errorLevel="info"/>

        <RawObjectIteration errorLevel="info"/>

        <InvalidStringClass errorLevel="info"/>

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

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

        <PossiblyFalseReference errorLevel="info"/>
        <PossiblyInvalidArrayAccess errorLevel="info"/>
        <PossiblyInvalidArrayAssignment errorLevel="info"/>
        <PossiblyInvalidCast errorLevel="info"/>
        <PossiblyInvalidFunctionCall errorLevel="info"/>
        <PossiblyInvalidIterator errorLevel="info"/>
        <PossiblyInvalidMethodCall errorLevel="info"/>
        <PossiblyNullArrayAccess errorLevel="info"/>
        <PossiblyNullArrayAssignment errorLevel="info"/>
        <PossiblyNullArrayOffset errorLevel="info"/>
        <PossiblyNullIterator errorLevel="info"/>
        <PossiblyNullPropertyFetch errorLevel="info"/>
        <PossiblyNullReference errorLevel="info"/>
        <PossiblyUndefinedVariable errorLevel="info"/>
        <PossiblyUndefinedArrayOffset errorLevel="info"/>
        <PossiblyUndefinedMethod errorLevel="info"/>

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

        <ImplicitToStringCast errorLevel="info"/>
        <InvalidScalarArgument errorLevel="info"/>
        <InvalidOperand errorLevel="info"/>
        <TooManyArguments errorLevel="info"/>
        <TypeDoesNotContainType errorLevel="info"/>
        <ImplementedReturnTypeMismatch errorLevel="info"/>

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

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

        <MoreSpecificImplementedParamType errorLevel="info"/>

        <InvalidReturnStatement errorLevel="info"/>
        <InvalidReturnType errorLevel="info"/>
        <UndefinedInterfaceMethod errorLevel="info"/>

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

        <UndefinedPropertyAssignment errorLevel="info"/>
        <UndefinedThisPropertyFetch errorLevel="info"/>
        <UndefinedPropertyFetch errorLevel="info"/>

        <InvalidArgument errorLevel="info"/>
        <InvalidPropertyAssignmentValue errorLevel="info"/>
        <InvalidArrayOffset errorLevel="info"/>

        <!-- Does not agree on a type with phpstan after the symfony 5.3 update -->
        <RedundantCastGivenDocblockType errorLevel="info" />

        <!-- Does not agree on a type with phpstan after the symfony 5.3 update -->
        <RedundantCast>
            <errorLevel type="info">
                <file name="src/Core/Content/Product/SalesChannel/Listing/ProductListingFeaturesSubscriber.php"/>
            </errorLevel>
        </RedundantCast>

        <!-- @deprecated tag:v6.4.5.0 (replacing production template dev-dependencies is not allowed atm) -->
        <UndefinedClass>
            <errorLevel type="info">
                <file name="src/Core/Framework/Demodata/Generator/MediaGenerator.php" />
                <file name="src/Core/Framework/Demodata/DemodataService.php" />
            </errorLevel>
        </UndefinedClass>
    </issueHandlers>
</psalm>