phpmd.xml

<?xml version="1.0" encoding="UTF-8" ?>
<ruleset
    name="VersionEyeModule rules"
    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 http://pmd.sf.net/ruleset_xml_schema.xsd"
    xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd"
>
    <rule ref="rulesets/cleancode.xml">
        <exclude name="BooleanArgumentFlag" />
        <exclude name="ErrorControlOperator" />
        <exclude name="MissingImport" />
        <exclude name="StaticAccess" />
    </rule>
    <rule ref="rulesets/codesize.xml">
        <exclude name="CyclomaticComplexity" />
        <exclude name="ExcessiveClassComplexity" />
        <exclude name="NPathComplexity" />
        <exclude name="TooManyPublicMethods" />
    </rule>
    <rule ref="rulesets/design.xml">
        <exclude name="CouplingBetweenObjects" />
        <exclude name="ExitExpression" />
    </rule>
    <rule ref="rulesets/unusedcode.xml">
        <exclude name="UnusedFormalParameter" />
        <exclude name="UnusedLocalVariable" />
    </rule>
    <rule ref="rulesets/naming.xml">
        <exclude name="LongClassName" />
        <exclude name="LongVariable" />
        <exclude name="ShortVariable" />
        <exclude name="ShortMethodName" />
    </rule>

    <rule ref="rulesets/codesize.xml/CyclomaticComplexity"
          since="0.1"
          message = "The {0} {1}() has a Cyclomatic Complexity of {2}. The configured cyclomatic complexity threshold is {3}."
          class="PHPMD\Rule\CyclomaticComplexity"
          externalInfoUrl="https://phpmd.org/rules/codesize.html#cyclomaticcomplexity">
        <priority>3</priority>
        <properties>
            <property name="reportLevel" description="The Cyclomatic Complexity reporting threshold" value="13"/>
            <property name="showClassesComplexity"
                      description="Indicate if class average violation should be added to the report"
                      value="true"/>
            <property name="showMethodsComplexity"
                      description="Indicate if class average violation should be added to the report"
                      value="true"/>
        </properties>
    </rule>
    <rule name="rulesets/codesize.xml/NPathComplexity"
          since="0.1"
          message="The {0} {1}() has an NPath complexity of {2}. The configured NPath complexity threshold is {3}."
          class="PHPMD\Rule\Design\NpathComplexity"
          externalInfoUrl="https://phpmd.org/rules/codesize.html#npathcomplexity">
        <priority>3</priority>
        <properties>
            <property name="minimum" description="The npath reporting threshold" value="300"/>
        </properties>
    </rule>
    <rule ref="rulesets/codesize.xml/TooManyPublicMethods"
          since="0.1"
          class="PHPMD\Rule\Design\TooManyPublicMethods"
          message="The {0} {1} has {2} public methods. Consider refactoring {1} to keep number of public methods under {3}."
          externalInfoUrl="https://phpmd.org/rules/codesize.html#toomanypublicmethods">
        <priority>3</priority>
        <properties>
            <property name="maxmethods" description="The method count reporting threshold" value="10"/>
            <property name="ignorepattern" description="Ignore methods matching this regex" value="(^(add|set|get|is|has|with|test))i"/>
        </properties>
    </rule>
    <rule name="rulesets/naming.xml/LongClassName"
          since="2.9"
          message="Avoid excessively long class names like {0}. Keep class name length under {1}."
          class="PHPMD\Rule\Naming\LongClassName"
          externalInfoUrl="https://phpmd.org/rules/naming.html#longclassname">
        <priority>3</priority>
        <properties>
            <property name="maximum" description="The class name length reporting threshold" value="40"/>
            <property name="subtract-suffixes" description="Comma-separated list of suffixes that will not count in the length of the class name. Only the first matching suffix will be subtracted." value="Interface, Subscriber"/>
        </properties>
    </rule>
    <rule rf="rulesets/naming.xml/LongVariable"
        since="0.2"
        message="Avoid excessively long variable names like {0}. Keep variable name length under {1}."
        class="PHPMD\Rule\Naming\LongVariable"
        externalInfoUrl="https://phpmd.org/rules/naming.html#longvariable">
        <priority>3</priority>
        <properties>
            <property name="maximum" description="The variable length reporting threshold" value="30"/>
        </properties>
    </rule>
    <rule ref="rulesets/naming.xml/ShortVariable"
          since="0.2"
          message="Avoid variables with short names like {0}. Configured minimum length is {1}."
          class="PHPMD\Rule\Naming\ShortVariable"
          externalInfoUrl="http://phpmd.org/rules/naming.html#shortvariable">
        <priority>3</priority>
        <properties>
            <property name="minimum" description="Minimum length for a variable, property or parameter name" value="3"/>
            <property name="exceptions" value="id,x,y" />
        </properties>
    </rule>
    <rule name="rulesets/naming.xml/ShortMethodName"
          since="0.2"
          message="Avoid using short method names like {0}::{1}(). The configured minimum method name length is {2}."
          class="PHPMD\Rule\Naming\ShortMethodName"
          externalInfoUrl="https://phpmd.org/rules/naming.html#shortmethodname">
        <priority>3</priority>
        <properties>
            <property name="minimum" description="Minimum length for a method or function name" value="3"/>
            <property name="exceptions" description="Comma-separated list of exceptions" value="id"/>
        </properties>
    </rule>
</ruleset>