psalm.xml

<?xml version="1.0"?>
<psalm
    errorLevel="3"
    resolveFromConfigFile="true"
    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>
            <directory name="vendor"/>
            <directory name="src/pagination"/>
            <directory name="src/Commands"/>
            <file name="src/ScoutEngine.php"/>
            <file name="src/Request.php"/>
            <file name="src/Exceptions/DocumentNotFoundException.php"/>
        </ignoreFiles>
    </projectFiles>

    <issueHandlers>
        <DeprecatedMethod errorLevel="suppress"/>
        <DeprecatedProperty errorLevel="suppress"/>

        <PropertyNotSetInConstructor>
            <errorLevel type="suppress">
                <file name="src/Model.php"/>
            </errorLevel>
        </PropertyNotSetInConstructor>

        <!--
         Thanks to the ridiculous PSR-6 spec which refuses to just use proper exceptions for bogus reasons, we'll have
         to fix this in Psalm.
         -->
        <InvalidThrow>
            <errorLevel type="suppress">
                <referencedClass name="Psr\SimpleCache\InvalidArgumentException"/>
            </errorLevel>
        </InvalidThrow>

        <!--
         Due to the way Laravel handles console commands, psalm cannot be sure argument values are actually strings. We
         know better, though.
         -->
        <PossiblyInvalidCast>
            <errorLevel type="suppress">
                <directory name="src/Commands"/>
            </errorLevel>
        </PossiblyInvalidCast>

        <!--
         This is caused by Laravel collections and scout having an unfortunate combination of type hints.
         -->
        <LessSpecificReturnStatement>
            <errorLevel type="suppress">
                <file name="src/ScoutEngine.php"/>
            </errorLevel>
        </LessSpecificReturnStatement>

        <!--
         This is caused by Laravel collections and scout having an unfortunate combination of type hints.
         -->
        <MoreSpecificReturnType>
            <errorLevel type="suppress">
                <file name="src/ScoutEngine.php"/>
            </errorLevel>
        </MoreSpecificReturnType>
    </issueHandlers>
</psalm>