d3r / standards

D3R Coding standards

D3R Coding Standards

Include in composer

composer require --dev d3r/standards

PHPCS

"phpcs_additional_args": {
	"--standard": "vendor/d3r/standards/D3R-PHP.xml"
}

or use the stricter standard

	"--standard": "vendor/d3r/standards/D3R-DEV-PHP.xml"
}

PHPCI

php_code_sniffer:
	allowed_warnings: 0
	allowed_errors: 0
	standard: "vendor/d3r/standards/D3R-PHP.xml"

Dev environment

For your editor then we have a more strict standard so we can stage changes without breaking all builds Check these out into your /clients/custom folder.

git clone https://github.com/D3R/standards /clients/custom/standards

then point your editor's phpci to one of the files either /clients/custom/standards/D3R-DEV-PHP.xml or /clients/custom/standards/D3R-PHP.xml

standards's Issues

Add PHPMD XML

I think we should add in an extra XML for the PHP Mess Detector.

Something like the below

<?xml version="1.0"?>
<ruleset name="D3R Mess Detector Config"
         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>
        Custom setup for D3R
    </description>

    <rule ref="rulesets/cleancode.xml/BooleanArgumentFlag" />

    <rule ref="rulesets/codesize.xml" />

    <rule ref="rulesets/codesize.xml">
        <exclude name="CamelCaseClassName" />
        <exclude name="CamelCasePropertyName" />
    </rule>

    <rule ref="rulesets/design.xml" />

    <rule ref="rulesets/naming.xml">
        <exclude name="ShortVariable" />
    </rule>

    <rule ref="rulesets/unusedcode.xml" />
</ruleset>