.phpcs.xml.dist

<?xml version="1.0"?>
<ruleset name="WordPress Coding Standards based custom ruleset for your plugin">
    <description>Generally-applicable sniffs for WordPress plugins.</description>

    <!-- What to scan -->
    <file>.</file>
    <exclude-pattern>/vendor/</exclude-pattern>
    <exclude-pattern>/node_modules/</exclude-pattern>
    <exclude-pattern>/wordpress/</exclude-pattern>
    <exclude-pattern>/tests/</exclude-pattern>
    <!-- How to scan -->
    <!-- Usage instructions: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage -->
    <!-- Annotated ruleset: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
    <arg value="sp"/> <!-- Show sniff and progress -->
    <arg name="basepath" value="./"/><!-- Strip the file paths down to the relevant bit -->
    <arg name="colors"/>
    <arg name="extensions" value="php"/>
    <arg name="parallel" value="8"/><!-- Enables parallel processing when available for faster results. -->

    <!-- Rules: Check PHP version compatibility -->
    <!-- https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions -->
    <config name="testVersion" value="7.0-"/>
    <!-- https://github.com/PHPCompatibility/PHPCompatibilityWP -->
    <rule ref="PHPCompatibilityWP"/>
    <config name="minimum_supported_wp_version" value="5.5"/>
    <rule ref="WordPress-Core">
        <exclude name="WordPress.Files.FileName" />
        <exclude name="WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase" />
        <exclude name="WordPress.NamingConventions.ValidHookName" />
        <exclude name="WordPress.PHP.YodaConditions.NotYoda" />
    </rule>
    <rule ref="WordPress-Docs"/>
    <rule ref="WordPress.NamingConventions.PrefixAllGlobals">
        <properties>
            <!-- Value: replace the function, class, and variable prefixes used. Separate multiple prefixes with a comma. -->
            <property name="prefixes" type="array">
                <element key="class" value="C3_CloudFront_Cache_Controller" />
                <element key="const" value="C3" />
            </property>
        </properties>
        <exclude name="WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound" />
        <exclude name="WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound" />
        <exclude name="WordPress.NamingConventions.PrefixAllGlobals.ShortPrefixPassed" />
        <exclude-pattern>*/templates/*</exclude-pattern>
        <exclude-pattern>*/c3-cloudfront-clear-cache.php</exclude-pattern>
    </rule>
    <rule ref="WordPress.NamingConventions.PrefixAllGlobals.DynamicHooknameFound">
        <exclude-pattern>classes/WP/Hooks.php</exclude-pattern>
    </rule>
    <rule ref="WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedConstantFound">
        <exclude-pattern>*/loader.php</exclude-pattern>
    </rule>
    <rule ref="WordPress.WP.I18n">
        <properties>
            <!-- Value: replace the text domain used. -->
            <property name="text_domain" type="array" value="c3-cloudfront-clear-cache"/>
        </properties>
        <exclude name="WordPress.WP.I18n.NonSingularStringLiteralDomain" />
    </rule>
    <rule ref="WordPress.WhiteSpace.ControlStructureSpacing">
        <properties>
            <property name="blank_line_check" value="true"/>
        </properties>
    </rule>
</ruleset>