phpcs.xml

<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="publicwhip-ruleset">
    <description>PublicWhip  Ruleset.</description>
    <arg name="basepath" value="."/>
    <arg name="extensions" value="php"/>
    <arg name="parallel" value="80"/>
    <arg name="cache" value=".php_cs.cache"/>
    <arg name="colors"/>
    <!-- Show progress and sniff codes in all reports -->
    <arg value="ps"/>

    <!-- Directories to be checked -->
    <file>src</file>
    <file>tests</file>
    <file>v1migrationUtils</file>
    <exclude-pattern>./web/*</exclude-pattern>
    <exclude-pattern>./vendor/*</exclude-pattern>
    <exclude-pattern>./.idea/</exclude-pattern>
    <exclude-pattern>./originalPublicWhipCode/</exclude-pattern>

    <!-- Load the additional coding standards -->
    <config name="installed_paths" value="vendor/slevomat/coding-standard,vendor/sirbrillig/phpcs-variable-analysis/VariableAnalysis,vendor/doctrine/coding-standard/lib"/>


    <!-- Code MUST follow all rules outlined in PSR-12. -->
    <rule ref="PSR12"/>


    <rule ref="VariableAnalysis"/>

    <rule ref="Doctrine">
        <!-- Overriden by SlevomatCodingStandard default -->
        <exclude name="SlevomatCodingStandard.TypeHints.DeclareStrictTypes.IncorrectStrictTypesFormat"/>
        <exclude name="SlevomatCodingStandard.Commenting.DocCommentSpacing.IncorrectAnnotationsGroup"/>
        <exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing.IncorrectWhitespaceBeforeColon"/>

        <!-- Dislike the alignments -->
        <exclude name="Generic.Formatting.MultipleStatementAlignment.NotSame"/>

        <!-- Spaces after casts look wrong -->
        <exclude name="Generic.Formatting.SpaceAfterCast.NoSpace"/>

        <!-- Too many false positives -->
        <exclude name="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly.ReferenceViaFallbackGlobalName"/>

        <!-- Too many spaces -->
        <exclude name="Squiz.Arrays.ArrayDeclaration.NoSpaceAfterComma"/>
        <exclude name="Squiz.Commenting.FunctionComment.SpacingAfterParamName"/>
        <exclude name="Generic.Formatting.SpaceAfterNot.Incorrect"/>
        <exclude name="Squiz.Commenting.FunctionComment.SpacingAfterParamName"/>
        <exclude name="Squiz.Commenting.DocCommentAlignment.NoSpaceAfterStar"/>
        <exclude name="Squiz.Commenting.FunctionComment.SpacingAfterParamType"/>

        <!-- Can be useful for quick reference as everything is together -->
        <exclude name="SlevomatCodingStandard.TypeHints.TypeHintDeclaration.UselessReturnAnnotation"/>
    </rule>

    <!-- And all those in the SlevomatCodingStandard -->
    <rule ref="SlevomatCodingStandard">
        <!-- No need for trailing commas -->
        <exclude name="SlevomatCodingStandard.Arrays.TrailingArrayComma.MissingTrailingComma"/>

        <!-- Conflicts with PSR2.Classes.ClassDeclaration.CloseBraceAfterBody part of PSR12 -->
        <exclude name="SlevomatCodingStandard.Classes.EmptyLinesAroundClassBraces.NoEmptyLineBeforeClosingBrace"/>

        <!-- Prefer to keep the Abstract/Trait prefix and Interface/Exception suffixes -->
        <exclude name="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming"/>
        <exclude name="SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming"/>
        <exclude name="SlevomatCodingStandard.Classes.SuperfluousExceptionNaming"/>
        <exclude name="SlevomatCodingStandard.Classes.SuperfluousTraitNaming"/>

        <!-- Disabled as it removes phpcs:disable lines.-->
        <exclude name="SlevomatCodingStandard.Commenting.DocCommentSpacing.IncorrectLinesCountAfterLastContent"/>

        <!-- Yoda style conditions we prefer -->
        <exclude name="SlevomatCodingStandard.ControlStructures.DisallowYodaComparison.DisallowedYodaComparison"/>

        <!-- We prefer new to be used with parentheses -->
        <exclude name="SlevomatCodingStandard.ControlStructures.NewWithoutParentheses.UselessParentheses"/>

        <!-- Seems to be problematic with tests -->
        <exclude name="SlevomatCodingStandard.Files.TypeNameMatchesFileName.NoMatchBetweenTypeNameAndFileName"/>

        <!-- No need for trailing commas -->
        <exclude name="SlevomatCodingStandard.Functions.TrailingCommaInCall.MissingTrailingComma"/>

        <!-- Unless it is for performance reasons, no need to have these fully qualified -->
        <exclude name="SlevomatCodingStandard.Namespaces.FullyQualifiedGlobalFunctions.NonFullyQualified"/>
        <exclude name="SlevomatCodingStandard.Namespaces.FullyQualifiedGlobalConstants.NonFullyQualified"/>
        <exclude name="SlevomatCodingStandard.Namespaces.FullyQualifiedExceptions.NonFullyQualifiedException"/>
        <exclude name="SlevomatCodingStandard.Namespaces.FullyQualifiedClassNameInAnnotation"/>

        <!-- We want to be able to reference other namespaces -->
        <exclude name="SlevomatCodingStandard.Namespaces.UseOnlyWhitelistedNamespaces"/>

        <!-- Prefer single line ternary operators -->
        <exclude name="SlevomatCodingStandard.ControlStructures.RequireMultiLineTernaryOperator.MultiLineTernaryOperatorNotUsed"/>

        <!-- Allow short ternary operator -->
        <exclude name="SlevomatCodingStandard.ControlStructures.DisallowShortTernaryOperator.DisallowedShortTernaryOperator"/>

        <!-- Allow ++ etc -->
        <exclude name="SlevomatCodingStandard.Operators.DisallowIncrementAndDecrementOperators"/>

        <!-- We want a blank line between the open tag and declare -->
        <exclude name="SlevomatCodingStandard.TypeHints.DeclareStrictTypes.IncorrectWhitespaceBetweenOpenTagAndDeclare"/>

    </rule>

    <!-- Look for unused imports from other namespaces -->
    <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
        <properties>
            <property name="searchAnnotations" value="true"/>
        </properties>
    </rule>

    <!-- ensure we are looking for Linux line endings -->
    <rule ref="Generic.Files.LineEndings">
        <properties>
            <property name="eolChar" value="\n"/>
        </properties>
    </rule>


</ruleset>