dokuwiki-plugin-bpmnio/phpcs.xml at main · Color-Of-Code/dokuwiki-plugin-bpmnio · 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
<?xml version="1.0"?>
<ruleset name="DokuWiki Plugin bpmnio">
    <description>PHP CodeSniffer configuration for dokuwiki-plugin-bpmnio</description>

    <file>./syntax</file>
    <file>./action</file>
    <file>./_test</file>

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

    <rule ref="PSR12">
        <!-- DokuWiki plugins use snake_case class names by convention -->
        <exclude name="PSR1.Classes.ClassDeclaration.MissingNamespace"/>
        <exclude name="Squiz.Classes.ValidClassName.NotCamelCaps"/>
        <!-- PHPUnit test methods use test_snake_case naming convention -->
        <exclude name="PSR1.Methods.CamelCapsMethodName.NotCamelCaps"/>
    </rule>

    <!-- Test files may have side effects (group annotations) -->
    <rule ref="PSR1.Files.SideEffects.FoundWithSymbols">
        <exclude-pattern>*/_test/*</exclude-pattern>
    </rule>

    <!-- phpcs parser struggles with PHP 7.3+ flexible heredoc in test files -->
    <rule ref="Generic.WhiteSpace.ScopeIndent">
        <exclude-pattern>*/_test/*</exclude-pattern>
    </rule>
    <rule ref="Squiz.Classes.ValidClassName.MissingBrace">
        <exclude-pattern>*/_test/*</exclude-pattern>
    </rule>
    <rule ref="PSR2.Classes.ClassDeclaration.MissingBrace">
        <exclude-pattern>*/_test/*</exclude-pattern>
    </rule>
    <rule ref="Generic.Files.LineLength.TooLong">
        <exclude-pattern>*/_test/*</exclude-pattern>
    </rule>
</ruleset>