phpmd-rules.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>
        Inspired by https://gist.github.com/slayerfat/2b3cc4faf94d2863b505
        using http://phpmd.org/documentation/creating-a-ruleset.html
    </description>

    <!-- CLEANCODE -->
    <rule ref="rulesets/cleancode.xml">
        <exclude name="StaticAccess"/>          <!-- laravel facades -->
        <exclude name="ElseExpression"/>
        <exclude name="BooleanArgumentFlag"/>
        <exclude name="UndefinedVariable"/>     <!-- bug in phpmd does not notice ref-variables -->
    </rule>

    <!-- CODESIZE -->
    <rule ref="rulesets/codesize.xml/CyclomaticComplexity">
    <properties>
        <property name="reportLevel" value="30" />
    </properties>
    </rule>
    <rule ref="rulesets/codesize.xml/NPathComplexity"/>
    <rule ref="rulesets/codesize.xml/ExcessiveMethodLength"/>
    <rule ref="rulesets/codesize.xml/ExcessiveClassLength"/>
    <rule ref="rulesets/codesize.xml/ExcessiveParameterList"/>
    <rule ref="rulesets/codesize.xml/ExcessivePublicCount"/>
    <rule ref="rulesets/codesize.xml/TooManyFields"/>
    <rule ref="rulesets/codesize.xml/TooManyMethods">
      <properties>
          <property name="maxmethods" value="30"/>
      </properties>
    </rule>
    <rule ref="rulesets/codesize.xml/ExcessiveClassComplexity">
    <properties>
        <property name="maximum" value="130" />
    </properties>
    </rule>

    <!-- CONTROVERSIAL -->
    <rule ref="rulesets/controversial.xml"/>

    <!-- DESIGN -->
    <rule ref="rulesets/design.xml">
      <!-- exclude name="CouplingBetweenObjects"/ -->
      <exclude name="CountInLoopExpression"/>
    </rule>
    <!-- beware the façades yo. -->
    <rule ref="rulesets/design.xml/CouplingBetweenObjects">
      <properties>
          <property name="minimum" value="20"/>
      </properties>
    </rule>

    <!-- NAMING -->
    <rule ref="rulesets/naming.xml">
        <exclude name="ShortVariable"/>     <!-- the list of exceptions is too long  -->
        <exclude name="LongVariable"/>
    </rule>

    <!-- UNUSED CODE -->
    <rule ref="rulesets/unusedcode.xml"/>
</ruleset>