psalm.xml.dist

<?xml version="1.0"?>
<psalm
    totallyTyped="false"
    resolveFromConfigFile="true"
    allowStringToStandInForClass="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"
    autoloader="vendor/autoload.php"
>
    <projectFiles>
        <directory name="api" />
        <directory name="cli" />
        <directory name="library" />
        <ignoreFiles>
            <directory name="vendor" />
        </ignoreFiles>
    </projectFiles>

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

        <!-- 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" />
        <MisplacedRequiredParam 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" />
        <TypeCoercion errorLevel="info" />

        <PossiblyFalseArgument errorLevel="info" />
        <PossiblyFalseIterator errorLevel="info" />
        <PossiblyFalseOperand errorLevel="info" />
        <PossiblyFalsePropertyAssignmentValue errorLevel="info" />
        <PossiblyFalseReference 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" />
        <PossiblyUndefinedGlobalVariable errorLevel="info" />
        <PossiblyUndefinedVariable errorLevel="info" />
        <PossiblyUndefinedArrayOffset errorLevel="info" />
        <PossiblyUndefinedMethod errorLevel="info" />
        <PossibleRawObjectIteration errorLevel="info" />

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

        <ForbiddenCode errorLevel="info" />
        <ImplicitToStringCast errorLevel="info" />
        <InvalidScalarArgument errorLevel="info" />
        <InvalidToString errorLevel="info" />
        <InvalidOperand errorLevel="info" />
        <NoInterfaceProperties errorLevel="info" />
        <TooManyArguments errorLevel="info" />
        <TypeDoesNotContainType errorLevel="info" />
        <TypeDoesNotContainNull errorLevel="info" />
        <MissingDocblockType errorLevel="info" />
        <ImplementedReturnTypeMismatch errorLevel="info" />
        <ImplementedParamTypeMismatch errorLevel="info" />

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

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

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

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

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

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

        <InvalidReturnStatement errorLevel="info" />
        <InvalidReturnType errorLevel="info" />
        <InvalidArgument errorLevel="info" />
        <InvalidPropertyAssignmentValue errorLevel="info" />
        <InvalidArrayOffset errorLevel="info" />
        <InvalidArrayAssignment errorLevel="info" />
        <InvalidArrayAccess errorLevel="info" />
        <InvalidClone errorLevel="info" />

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

        <ReservedWord errorLevel="info" />
        <MethodSignatureMismatch errorLevel="info" />
        <OverriddenMethodAccess errorLevel="info" />
        <InaccessibleProperty errorLevel="info" />

    </issueHandlers>
</psalm>