project-template-wordpress/phpcs.xml.dist at master · alleotech/project-template-wordpress · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
<?xml version="1.0"?>
<ruleset name="PHP_CodeSniffer">
    <!--
         Useful links:
         * https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage
         * https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xml.dist
         * https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml
    -->
    <description>PHP CodeSniffer Configuration</description>

    <!-- Coding standard to use -->
    <rule ref="WordPress-Docs" />
    <rule ref="WordPress-Extra" />
    <rule ref="Generic.PHP.ForbiddenFunctions">
        <properties>
            <property name="forbiddenFunctions" type="array" value="var_dump=>null,sizeof=>count,delete=>unset"/>
        </properties>
    </rule>

    <!-- Do not fail on warnings -->
    <config name="ignore_warnings_on_exit" value="1" />

    <!-- Added WordPress Coding Standards (wpcs) to path -->
    <config name="installed_paths" value="../../wp-coding-standards/wpcs" />

    <!-- Assume UTF-8 -->
    <config name="encoding" value="UTF-8" />

    <arg name="basepath" value="."/>

    <!-- Use colors -->
    <arg name="colors" />

    <!-- Show progress -->
    <arg value="p" />

    <!-- Files and directories to check -->
    <file>./src/</file>
    <file>./webroot/custom-themes/</file>
    <exclude-pattern>webroot/custom-themes/custom/includes/</exclude-pattern>

    <!-- Ignore minified files -->
    <exclude-pattern>*\.min\.(css|js)</exclude-pattern>
</ruleset>