phpcs.xml

<?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="MultiSafepay`s Wordpress WooCommerce" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
    <description>A custom coding standard for MultiSafepay`s Wordpress WooCommerce plugin.</description>

    <!-- Exclude folders and files from being checked. -->
    <exclude-pattern>./bin/*</exclude-pattern>
    <exclude-pattern>./tests/*</exclude-pattern>
    <exclude-pattern>./coverage-report/*</exclude-pattern>
    <exclude-pattern>./languages/*</exclude-pattern>

    <!-- Exclude the Composer Vendor directory. -->
    <exclude-pattern>./vendor/*</exclude-pattern>

    <!-- Exclude the Node Modules directory. -->
    <exclude-pattern>./node_modules/*</exclude-pattern>

    <!-- Exclude the build directory. -->
    <exclude-pattern>./assets/public/js/multisafepay-blocks/build/*</exclude-pattern>

    <!-- Exclude minified Javascript files. -->
    <exclude-pattern>*.min.js</exclude-pattern>

    <!-- Include the WordPress-Extra standard. -->
    <rule ref="WordPress-Extra">
        <!-- This is disabled and incompatible with strict_types after opening PHP tags -->
        <exclude name="Squiz.Commenting.FileComment.Missing"/>
        <!-- Not every @param needs to be commented  -->
        <exclude name="Squiz.Commenting.FunctionComment.MissingParamComment"/>
        <!-- Not every method functions needs to be commented  -->
        <exclude name="Generic.Commenting.DocComment.MissingShort"/>
        <!-- At this moment we are not using Wordpress conventions for the classes names  -->
        <exclude name="WordPress.Files.FileName.InvalidClassFileName"/>
        <!-- At this moment we are not using Wordpress conventions for the files names  -->
        <exclude name="WordPress.Files.FileName.NotHyphenatedLowercase"/>
        <!-- We dont require and need a dot at the end of each comment -->
        <exclude name="Squiz.Commenting.InlineComment.InvalidEndChar"/>
        <!-- We dont require a comment for each @throws comment -->
        <exclude name="Squiz.Commenting.FunctionComment.EmptyThrows"/>
        <!-- We dont require each comment ends in a characters that means the end of the line; like a dot. -->
        <exclude name="Squiz.Commenting.FunctionComment.ParamCommentFullStop"/>
        <!-- In some places we use date() function. We want to use TimeZone set in the store and not gmdate() suggestion from PHPCS -->
        <exclude name="WordPress.DateTime.RestrictedFunctions.date_date"/>
        <!-- Exclude warning if founds a method which does not use a parameter -->
        <exclude name="Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClassBeforeLastUsed"/>
        <!-- Exclude warning if founds a method which does not use a parameter in a extended class -->
        <exclude name="Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass"/>
    </rule>

    <rule ref="WordPress">
        <exclude name="Generic.WhiteSpace.DisallowSpaceIndent"/>
        <exclude name="PEAR.Functions.FunctionCallSignature.Indent"/>
    </rule>
    <rule ref="Generic.WhiteSpace.ScopeIndent">
        <properties>
            <property name="indent" value="4"/>
            <property name="tabIndent" value="false"/>
        </properties>
    </rule>
    <rule ref="Generic.WhiteSpace.DisallowTabIndent"/>

    <!-- Exclude all gateways and giftcards classes from this rule -->
    <rule ref="Squiz.Commenting.ClassComment.Missing">
        <exclude-pattern>*/src/PaymentMethods/*</exclude-pattern>
    </rule>

    <!-- Exclude nonce verification, which, according to documentation, is not required when submit an order -->
    <rule ref="WordPress.Security.NonceVerification.Missing">
        <exclude-pattern>*/src/PaymentMethods/PaymentMethodsController.php</exclude-pattern>
        <exclude-pattern>*/src/PaymentMethods/Base/BasePaymentMethod.php</exclude-pattern>
        <exclude-pattern>*/src/Services/OrderService.php</exclude-pattern>
        <exclude-pattern>*/src/Services/CustomerService.php</exclude-pattern>
    </rule>

    <!-- Exclude nonce verification recomendation -->
    <rule ref="WordPress.Security.NonceVerification.Recommended">
        <exclude-pattern>*/src/Settings/SettingsController.php</exclude-pattern>
    </rule>

    <!-- Exclude BasePaymentMethod.php length limit -->
    <rule ref="ObjectCalisthenics.Files.ClassTraitAndInterfaceLength.ObjectCalisthenics\Sniffs\Files\ClassTraitAndInterfaceLengthSniff">
        <exclude-pattern>*/src/PaymentMethods/BasePaymentMethod.php</exclude-pattern>
    </rule>

    <!-- Exclude multisafepay-google-pay.js -->
    <rule ref="PEAR.Functions.FunctionCallSignature.Indent">
        <exclude-pattern>*/assets/public/js/multisafepay-google-pay.js</exclude-pattern>
    </rule>

    <!-- -->
    <rule ref="WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents">
        <exclude-pattern>*/templates/partials/multisafepay-settings-logs-display.php</exclude-pattern>
    </rule>

    <!-- Let's also check that everything is properly documented. -->
    <rule ref="WordPress-Docs"/>

    <!-- Add in some extra rules from other standards. -->
    <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter"/>
    <rule ref="Generic.Commenting.Todo"/>

    <!-- Check for PHP cross-version compatibility. -->
    <config name="testVersion" value="7.3-"/>
    <rule ref="PHPCompatibilityWP"/>

    <!-- Minimum Wordpress version supported -->
    <config name="minimum_supported_wp_version" value="5.0"/>

    <!-- Check text domain for I18n -->
    <rule ref="WordPress.WP.I18n">
        <properties>
            <property name="text_domain" type="array">
                <element value="multisafepay"/>
            </property>
        </properties>
    </rule>

    <!-- No "else" -->
    <rule ref="ObjectCalisthenics.ControlStructures.NoElse"/>

    <!-- Only 3 indentation level per function/method -->
    <rule ref="ObjectCalisthenics.Metrics.MaxNestingLevel">
        <properties>
            <property name="maxNestingLevel" value="3"/>
        </properties>
        <exclude-pattern>*/src/PaymentMethods/Base/BasePaymentMethodBlocks.php</exclude-pattern>
        <exclude-pattern>*/src/Services/PaymentMethodService.php</exclude-pattern>
    </rule>

    <!-- Minimal length for variables names -->
    <rule ref="ObjectCalisthenics.NamingConventions.ElementNameMinimalLength">
        <properties>
            <property name="minLength" value="3"/>
            <property name="allowedShortNames" type="array" value=""/>
        </properties>
    </rule>

    <!-- The following ensure small classes -->
    <rule ref="ObjectCalisthenics.Files.ClassTraitAndInterfaceLength">
        <properties>
            <property name="maxLength" value="500"/>
        </properties>
        <exclude-pattern>*/src/PaymentMethods/Base/BasePaymentMethod.php</exclude-pattern>
        <exclude-pattern>*/src/Settings/SystemReport.php</exclude-pattern>
    </rule>
    <rule ref="ObjectCalisthenics.Files.FunctionLength">
        <properties>
            <property name="maxLength" value="500"/>
        </properties>
    </rule>
    <rule ref="ObjectCalisthenics.Metrics.PropertyPerClassLimit">
        <properties>
            <property name="maxCount" value="25"/>
        </properties>
    </rule>
    <rule ref="ObjectCalisthenics.Metrics.MethodPerClassLimit">
        <properties>
            <property name="maxCount" value="30"/>
        </properties>
        <exclude-pattern>*/src/PaymentMethods/Base/BasePaymentMethod.php</exclude-pattern>
    </rule>

    <!-- Report @todo comments  -->
    <rule ref="Generic.Commenting.Todo.CommentFound"/>

</ruleset>