.phpmd.dist.xml

<?xml version="1.0"?>
<ruleset name="OCC Default 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>
        Open Culture Consulting follows PHP Mess Detector standards with few exceptions.
    </description>

    <rule ref="rulesets/cleancode.xml">
        <!--
            We sometimes want to use else expressions for better readability.
        -->
        <exclude name="ElseExpression" />
        <exclude name="StaticAccess" />
        <exclude name="BooleanArgumentFlag" />
    </rule>
    <rule ref="rulesets/codesize.xml" />
    <rule ref="rulesets/controversial.xml" />
    <rule ref="rulesets/design.xml" />
    <rule ref="rulesets/naming.xml">
        <exclude name="ShortVariable" />
    </rule>
    <rule ref="rulesets/naming.xml/ShortVariable">
        <properties>
            <!--
                We want to allow shorter variable names as long as they are self-explanatory.
            -->
            <property name="minimum" value="2" />
        </properties>
    </rule>
    <rule ref="rulesets/unusedcode.xml">
        <!--
            We have to declare unused parameters to satisfy interface requirements.
        -->
        <exclude name="UnusedFormalParameter" />
    </rule>
</ruleset>