ootb-openstreetmap/phpcs.xml at master · gsarig/ootb-openstreetmap · 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
45
46
47
48
<?xml version="1.0"?>
<ruleset name="OOTB OpenStreetMap">
    <description>PHPCS rules for the OOTB OpenStreetMap plugin.</description>

    <file>includes/</file>
    <file>ootb-openstreetmap.php</file>
    <file>uninstall.php</file>

    <exclude-pattern>vendor/*</exclude-pattern>
    <exclude-pattern>node_modules/*</exclude-pattern>
    <exclude-pattern>build/*</exclude-pattern>
    <exclude-pattern>tests/*</exclude-pattern>

    <rule ref="WordPress">
        <!-- Allow short array syntax [] instead of array() -->
        <exclude name="Universal.Arrays.DisallowShortArraySyntax"/>

        <!-- PSR-4 autoloading uses class-name-based filenames, not WP's class- prefix convention -->
        <exclude name="WordPress.Files.FileName.NotHyphenatedLowercase"/>
        <exclude name="WordPress.Files.FileName.InvalidClassFileName"/>

        <!-- Doc comment requirements are overly strict for modern OOP code -->
        <exclude name="Squiz.Commenting.FileComment.Missing"/>
        <exclude name="Squiz.Commenting.FileComment.MissingPackageTag"/>
        <exclude name="Squiz.Commenting.ClassComment.Missing"/>
        <exclude name="Squiz.Commenting.FunctionComment.Missing"/>
        <exclude name="Squiz.Commenting.FunctionComment.MissingParamTag"/>
        <exclude name="Squiz.Commenting.FunctionComment.MissingParamComment"/>
        <exclude name="Squiz.Commenting.FunctionComment.MissingReturn"/>
        <exclude name="Squiz.Commenting.VariableComment.Missing"/>
        <exclude name="Squiz.Commenting.InlineComment.InvalidEndChar"/>

        <!-- Alignment rule is pedantic; causes more churn than value -->
        <exclude name="Generic.Formatting.MultipleStatementAlignment"/>
    </rule>

    <config name="minimum_supported_wp_version" value="6.6"/>

    <rule ref="WordPress.WP.I18n">
        <properties>
            <property name="text_domain" type="array">
                <element value="ootb-openstreetmap"/>
            </property>
        </properties>
    </rule>

    <config name="testVersion" value="8.1-"/>
</ruleset>