magento-lts/.phpmd.dist.xml at main · OpenMage/magento-lts · 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<?xml version="1.0"?>
<ruleset name="OpenMage ruleset"
         xmlns="http://pmd.sf.net/ruleset/1.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 https://pmd.sf.net/ruleset_xml_schema.xsd"
         xsi:noNamespaceSchemaLocation="https://pmd.sf.net/ruleset_xml_schema.xsd">
    <description>
        OpenMage ruleset
    </description>

    <!-- UNUSEDCODE
    [ ] UnusedFormalParameter - TMP disabled
    [x] UnusedLocalVariable
    [x] UnusedPrivateField
    [x] UnusedPrivateMethod
    -->
    <rule ref="rulesets/unusedcode.xml">
        <exclude name="UnusedFormalParameter" />
        <exclude name="UnusedLocalVariable" />
    </rule>
    <rule ref="rulesets/unusedcode.xml/UnusedLocalVariable">
        <properties>
            <property name="exceptions" value="ignored" />
        </properties>
    </rule>

    <!-- CLEANCODE
    [-] BooleanArgumentFlag
    [?] ElseExpression
    [x] ErrorControlOperator
    [x] DuplicatedArrayKey
    [ ] IfStatementAssignment
    [?] MissingImport
    [-] StaticAccess
    [?] UndefinedVariable
    -->
    <rule ref="rulesets/cleancode.xml">
        <exclude name="BooleanArgumentFlag" />
        <exclude name="ElseExpression" /> <!-- can be fixed in some cases -->
        <exclude name="IfStatementAssignment" /> <!-- can be fixed -->
        <exclude name="MissingImport" /> <!-- can be fixed -->
        <exclude name="StaticAccess" />
        <exclude name="UndefinedVariable" /> <!-- can be fixed -->
    </rule>
    <rule ref="rulesets/cleancode.xml/MissingImport">
        <properties>
            <property name="ignore-global" value="true" />
        </properties>
    </rule>

    <!-- CONTROVERSIAL
    [-] CamelCaseClassName
    [-] CamelCaseMethodName
    [ ] CamelCaseParameterName
    [-] CamelCasePropertyName
    [ ] CamelCaseVariableName
    [x] Superglobals
    -->
    <rule ref="rulesets/controversial.xml/CamelCaseMethodName">
        <properties>
            <property name="allow-underscore" value="true" />
        </properties>
    </rule>
    <rule ref="rulesets/controversial.xml/CamelCaseParameterName" />
    <rule ref="rulesets/controversial.xml/CamelCasePropertyName">
        <properties>
            <property name="allow-underscore" value="true" />
        </properties>
    </rule>
    <rule ref="rulesets/controversial.xml/CamelCaseVariableName">
        <properties>
            <property name="allow-underscore" value="true" />
        </properties>
    </rule>
    <rule ref="rulesets/controversial.xml/Superglobals" />

    <!-- NAMING
    [-] BooleanGetMethodName
    [x] ConstantNamingConventions
    [x] ConstructorWithNameAsEnclosingClass
    [-] LongClassName
    [x] ShortClassName
    [-] LongVariable
    [x] ShortVariable - @todo fix later, avoid as possible
    [x] ShortMethodName
    -->
    <rule ref="rulesets/naming.xml">
        <exclude name="BooleanGetMethodName" />
        <exclude name="LongClassName" />
        <exclude name="LongVariable" />
        <exclude name="ShortVariable" />
    </rule>
    <rule ref="rulesets/naming.xml/ShortVariable">
        <properties>
            <property name="exceptions" value="a,b,id,i,j" />
        </properties>
    </rule>

    <!-- DESIGN
    [x] CountInLoopExpression
    [-] CouplingBetweenObjects
    [-] DepthOfInheritance
    [x] DevelopmentCodeFragment
    [x] EmptyCatchBlock
    [x] EvalExpression
    [x] ExitExpression
    [x] GotoStatement
    [-] NumberOfChildren
    -->
    <rule ref="rulesets/design.xml">
        <exclude name="CouplingBetweenObjects" />
        <exclude name="DepthOfInheritance" />
        <exclude name="NumberOfChildren" />
    </rule>

    <!-- CODESIZE
    [-] ExcessiveClassComplexity
    [-] ExcessiveClassLength
    [-] ExcessiveMethodLength
    [-] ExcessiveParameterList
    [-] ExcessivePublicCount
    [-] CyclomaticComplexity
    [-] NPathComplexity
    [-] TooManyFields
    [-] TooManyMethods
    [-] TooManyPublicMethods
    -->
    <rule ref="rulesets/codesize.xml">
        <exclude name="CyclomaticComplexity" />
        <exclude name="ExcessiveClassComplexity" />
        <exclude name="ExcessiveClassLength" />
        <exclude name="ExcessiveMethodLength" />
        <exclude name="ExcessivePublicCount" />
        <exclude name="NPathComplexity" />
        <exclude name="TooManyFields" />
        <exclude name="TooManyMethods" />
        <exclude name="TooManyPublicMethods" />
    </rule>
</ruleset>