wp-field-kit/phpcs-format.xml.dist at main · arraypress/wp-field-kit · 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<?xml version="1.0"?>
<ruleset name="Wp Field Kit (formatting)">
    <description>Formatting and style. Separate from the lint: a clean lint does not mean a clean format check.</description>

    <file>src</file>

    <!--
        bin/verify-docs.php ships inside every plugin built on the kit, so it
        is formatted to the same standard as src/.
    -->
    <file>bin</file>

    <arg name="extensions" value="php"/>
    <arg name="colors"/>
    <arg value="sp"/>

    <config name="installed_paths" value="vendor/wp-coding-standards/wpcs,vendor/phpcompatibility/php-compatibility,vendor/phpcompatibility/phpcompatibility-paragonie,vendor/phpcompatibility/phpcompatibility-wp,vendor/phpcsstandards/phpcsutils,vendor/phpcsstandards/phpcsextra"/>

    <rule ref="WordPress-Core">
        <exclude name="Universal.Arrays.DisallowShortArraySyntax"/>
        <exclude name="WordPress.PHP.YodaConditions"/>
        <exclude name="Generic.WhiteSpace.DisallowSpaceIndent"/>
        <exclude name="Generic.WhiteSpace.ScopeIndent"/>
        <exclude name="PEAR.Functions.FunctionCallSignature"/>
        <exclude name="Squiz.Commenting.FileComment"/>
        <exclude name="Universal.Operators.DisallowShortTernary"/>
        <exclude name="Generic.Formatting.MultipleStatementAlignment"/>
        <exclude name="WordPress.Arrays.MultipleStatementAlignment"/>
    </rule>

    <rule ref="WordPress.Security.EscapeOutput">
        <!--
            Every one of these echoes the return value of an EDD markup helper:
            EDD()->html->select(), ->product_dropdown(), ->date_field() and the
            rest. They return escaped HTML by design, and escaping the result
            again would print the tags instead of rendering the controls.
            Rendering EDD's own fields is what this library is for, so the
            exclusion is the whole file rather than a line list.
        -->
    </rule>


    <rule ref="WordPress.Files.FileName">
        <!--
            Off, not waived. This is a Composer library autoloaded by PSR-4,
            which requires the file to be named for the class it declares:
            Exporters.php. WordPress wants class-exporters.php. The two rules
            are mutually exclusive, and renaming the files to satisfy this one
            would stop the autoloader finding them at all.
        -->
        <exclude-pattern>*</exclude-pattern>
    </rule>

    <rule ref="WordPress.Security.EscapeOutput">
        <!--
            bin/ is a command line program: it writes to a terminal, not to a
            page, and esc_html() on a report line would print entities where
            the operator expects text.
        -->
        <exclude-pattern>bin/*</exclude-pattern>
    </rule>

</ruleset>