.phpcs.xml.dist

<?xml version="1.0"?>
<ruleset name="WordPress Coding Standards based custom ruleset for your plugin"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
	<description>Generally-applicable sniffs for WordPress plugins.</description>

	<!-- What to scan -->
	<file>.</file>
    <exclude-pattern>assets/</exclude-pattern>
	<exclude-pattern>vendor/</exclude-pattern>
	<exclude-pattern>node_modules/</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. -->

    <!-- Cache the results between runs. -->
	<arg name="cache" value="./.cache-phpcs-free.cache"/>

	<!-- Rules: Check PHP version compatibility -->
	<!-- https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions -->
	<config name="testVersion" value="7.4-" />

	<!-- Rules: WordPress Coding Standards -->
	<!-- https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards -->
	<!-- https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties -->
	<config name="minimum_supported_wp_version" value="5.9"/>

	<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 value="cb_" /> <!-- globals -->
                <element value="commonsbooking_" />
                <element value="CommonsBooking" /> <!-- namespaces -->
            </property>            
		</properties>
	</rule>

    <!-- Checks if text_domain used -->
	<rule ref="WordPress.WP.I18n">
		<properties>
			<property name="text_domain" type="array" value="commonsbooking"/>
		</properties>
	</rule>
    
	<rule ref="WordPress.WhiteSpace.ControlStructureSpacing">
		<properties>
			<property name="blank_line_check" value="true"/>
		</properties>
	</rule>

	<!-- https://github.com/PHPCompatibility/PHPCompatibilityWP -->
	<rule ref="PHPCompatibility">
        <exclude-pattern>tests/</exclude-pattern>
    </rule>

    <rule ref="PHPCompatibilityWP" />

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

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

    <rule ref="WordPress">
        <exclude name="WordPress.Files.FileName" />
        <exclude name="Wordpress.PHP.YodaConditions" />
        <exclude name="WordPress.NamingConventions.ValidVariableName" />
        <exclude name="WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid" />

        <!-- Excludes Short Array Syntax sniffs entirely -->
        <exclude name="Universal.Arrays.DisallowShortArraySyntax.Found" />
        <exclude name="Generic.Arrays.DisallowShortArraySyntax"/>

        <!-- Too much false positives in our codebase, but please reactivate if necessary -->
        <exclude name="WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned" />
        <exclude name="WordPress.Arrays.MultipleStatementAlignment.LongIndexSpaceBeforeDoubleArrow" />

        <exclude name="Squiz.Commenting.InlineComment.InvalidEndChar" />
        <exclude name="Squiz.Commenting.FileComment" />
        <exclude name="Squiz.Commenting.FunctionComment.ParamCommentFullStop" />
    </rule>


    <!--
    #############################################################################
    Global exclusions for tests.
    Copied from https://github.com/polylang/polylang/blob/master/phpcs.xml.dist
    #############################################################################
    -->

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

    <rule ref="Generic.Files.OneObjectStructurePerFile.MultipleFound">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="Generic.PHP.NoSilencedErrors.Forbidden">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="Squiz.Commenting.ClassComment.Missing">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

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

    <rule ref="Squiz.Commenting.FunctionComment.Missing">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="Squiz.Commenting.FunctionComment.MissingParamComment">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="Squiz.Commenting.VariableComment.Missing">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="Squiz.PHP.CommentedOutCode.Found">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid">
        <exclude-pattern>*/tests/phpunit/includes/testcase-trait.php</exclude-pattern>
    </rule>

    <rule ref="WordPress.NamingConventions.ValidHookName.UseUnderscores">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="WordPress.PHP.NoSilencedErrors.Discouraged">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="WordPress.Security">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <!-- Adds commonsbooking specific wrappers around wp_kses ... -->
    <!-- Note that phpcs as php is case insensitive -->
    <rule ref="WordPress.Security.EscapeOutput">
        <properties>
            <property name="customEscapingFunctions" type="array">
                <element value="commonsbooking_sanitizehtml"/>
                <element value="commonsbooking_sanitizearrayorstring" />
            </property>
        </properties>
    </rule>

</ruleset>