phpmd.xml

<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="Laravel and similar phpmd 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 http://pmd.sf.net/ruleset_xml_schema.xsd"
         xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
    <description>Written using this resource : https://phpmd.org/rules/index.html</description>
    <!-- Clean code rules -->
    <rule ref="rulesets/cleancode.xml">
        <exclude name="StaticAccess"/>
        <exclude name="ElseExpression"/>
        <exclude name="BooleanArgumentFlag"/>
    </rule>
    <!-- Code size rules -->
    <rule ref="rulesets/codesize.xml">
        <exclude name="CyclomaticComplexity" pattern="tests/*"/>
        <exclude name="TooManyPublicMethods" pattern="tests/*"/>
        <exclude name="TooManyMethods" pattern="tests/*"/>
        <exclude name="ExcessiveMethodLength" pattern="tests/*"/>
    </rule>
    <!-- Controversial rules -->
    <rule ref="rulesets/controversial.xml">
        <exclude name="CamelCaseMethodName" pattern="tests/*"/>
        <exclude name="CamelCasePropertyName" pattern="src/Livewire/*"/>
    </rule>
    <!-- Design rules -->
    <rule ref="rulesets/design.xml">
        <exclude name="CouplingBetweenObjects"/>
        <exclude name="NumberOfChildren"/>
    </rule>
    <!-- Naming rules -->
    <rule ref="rulesets/naming.xml">
        <exclude name="LongClassName"/>
        <exclude name="ShortVariable"/>
        <exclude name="LongVariable"/>
        <exclude name="ShortMethodName"/>
        <exclude name="BooleanGetMethodName"/>
    </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,js,uu,ii,oo,e"/>
        </properties>
    </rule>
    <rule ref="rulesets/naming.xml/ShortMethodName">
        <properties>
            <property name="exceptions" value="up,to,at"/>
        </properties>
    </rule>
    <!-- Unused code rules -->
    <rule ref="rulesets/unusedcode.xml">
        <exclude name="UnusedFormalParameter" pattern="tests/*"/>
    </rule>
</ruleset>