__phpcs.xml

<?xml version="1.0"?>
<ruleset name="WordPress Coding Standards">
    <description>WooCommerce dev PHP_CodeSniffer ruleset.</description>

    <file>.</file>

    <!-- Exclude paths -->
    <exclude-pattern>tests/</exclude-pattern>
    <exclude-pattern>languages/</exclude-pattern>
    <exclude-pattern>e2e/</exclude-pattern>
    <exclude-pattern>bin/</exclude-pattern>
    <exclude-pattern>templates/</exclude-pattern>
    <exclude-pattern>*/node_modules/*</exclude-pattern>
    <exclude-pattern>*/vendor/*</exclude-pattern>

    <!-- Show progress, show the error codes for each message (source). -->
    <arg value="ps" />

    <!-- Strip the filepaths in reports down to the relevant bit. -->
    <arg name="basepath" value="./" />

    <!-- Check up to 8 files simultaneously. -->
    <arg name="parallel" value="8" />

    <!-- Configs -->
    <config name="minimum_supported_wp_version" value="5.2" />

    <!-- Rules -->
    <rule ref="WooCommerce-Core" />

    <rule ref="WooCommerce.Functions.InternalInjectionMethod">
        <include-pattern>src/</include-pattern>
        <include-pattern>tests/php/src/</include-pattern>
        <properties>
            <property name="injectionMethod" value="init"/>
        </properties>
    </rule>

    <rule ref="WordPress.WP.I18n">
        <properties>
            <property name="text_domain" type="array" value="woocommerce-brands" />
        </properties>
    </rule>

    <rule ref="PHPCompatibility">
        <exclude-pattern>tests/</exclude-pattern>
        <exclude-pattern>e2e/</exclude-pattern>
    </rule>

    <rule ref="WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents">
        <exclude-pattern>tests/</exclude-pattern>
    </rule>

    <rule ref="WordPress.Files.FileName.InvalidClassFileName">
        <exclude-pattern>tests/</exclude-pattern>
    </rule>

    <rule ref="Squiz.Classes.ClassFileName">
        <include-pattern>includes/</include-pattern>
        <include-pattern>tests/</include-pattern>
    </rule>

    <rule ref="Squiz.Classes.ValidClassName">
        <include-pattern>includes/</include-pattern>
        <include-pattern>tests/</include-pattern>
    </rule>

    <rule ref="Generic.Commenting">
        <exclude-pattern>tests/</exclude-pattern>
    </rule>

    <rule ref="PEAR.Functions.FunctionCallSignature.EmptyLine">
        <exclude-pattern>tests/</exclude-pattern>
        <exclude-pattern>e2e/</exclude-pattern>
    </rule>

    <rule ref="WordPress.Files.FileName.NotHyphenatedLowercase">
        <exclude-pattern>i18n/</exclude-pattern>
        <exclude-pattern>includes/</exclude-pattern>
        <exclude-pattern>tests/</exclude-pattern>
    </rule>

    <rule ref="Squiz.Commenting.FileComment.MissingPackageTag">
        <exclude-pattern>includes/</exclude-pattern>
        <exclude-pattern>tests/</exclude-pattern>
    </rule>
    <rule ref="Squiz.Commenting.FileComment.Missing">
        <exclude-pattern>includes/</exclude-pattern>
        <exclude-pattern>tests/</exclude-pattern>
    </rule>

    <rule ref="Squiz.Commenting.FunctionCommentThrowTag.Missing">
        <exclude-pattern>tests/</exclude-pattern>
        <exclude-pattern>e2e/</exclude-pattern>
    </rule>

    <rule ref="Squiz.Commenting.FileComment.Missing">
        <exclude-pattern>tests/</exclude-pattern>
        <exclude-pattern>e2e/</exclude-pattern>
    </rule>

    <!-- Temporary -->
    <rule ref="Generic.Arrays.DisallowShortArraySyntax.Found">
        <exclude-pattern>include/</exclude-pattern>
    </rule>

    <!-- Temporary -->
    <rule ref="WooCommerce.Functions.InternalInjectionMethod.MissingFinal">
        <exclude-pattern>includes/</exclude-pattern>
    </rule>

    <!-- Temporary -->
    <rule ref="WooCommerce.Functions.InternalInjectionMethod.MissingInternalTag">
        <exclude-pattern>includes/</exclude-pattern>
    </rule>

    <!-- Temporary -->
    <rule ref="WordPress.Security.NonceVerification.Recommended">
        <exclude-pattern>includes/</exclude-pattern>
    </rule>

    <!-- Temporary -->
    <rule ref="Squiz.Classes.ClassFileName.NoMatch">
        <exclude-pattern>includes/</exclude-pattern>
    </rule>

    <!-- Temporary -->
    <rule ref="Squiz.Classes.ValidClassName.NotCamelCaps">
        <exclude-pattern>includes/</exclude-pattern>
    </rule>
</ruleset>