Browse Source

Code Climate PHPMD settings (#13139)

* codeclimate phpmd rulesets

* PHPMD ruleset

* phpmd_ruleset moved

* Delete phpmd_ruleset.xml

* ruleset moved
tags/2.0.11
Bizley 8 years ago committed by Carsten Brandt
parent
commit
5092c9666d
  1. 31
      .codeclimate.yml
  2. 35
      tests/data/codeclimate/phpmd_ruleset.xml

31
.codeclimate.yml

@ -1,4 +1,3 @@
---
engines:
duplication:
enabled: true
@ -12,34 +11,8 @@ engines:
enabled: true
phpmd:
enabled: true
# configure checks, see https://phpmd.org/rules/index.html for details
checks:
# else is not always bad. Disabling this as there is no reason to differentiate
# between early return and normal else cases.
CleanCode/ElseExpression:
enabled: false
# Static access on Yii::$app is normal in Yii
CleanCode/StaticAccess:
enabled: false
# Yii is a framework so if fulfills the job of encapsulating superglobals
Controversial/Superglobals:
enabled: false
# allow private properties to start with $_
Controversial/CamelCasePropertyName:
enabled: true
allow-underscore: true
# Short variable names are no problem in most cases, e.g. $n = count(...);
Naming/ShortVariable:
enabled: false
# Long variable names can help with better understanding so we increase the limit a bit
Naming/LongVariable:
enabled: true
maximum: 25
# method names like up(), gc(), ... are okay.
Naming/ShortMethodName:
enabled: true
minimum: 2
config:
rulesets: "codesize,design,unusedcode,tests/data/codeclimate/phpmd_ruleset.xml"
ratings:
paths:
- "**.js"

35
tests/data/codeclimate/phpmd_ruleset.xml

@ -0,0 +1,35 @@
<?xml version="1.0"?>
<ruleset name="PHPMD rule set for Yii 2" 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 PHPMD settings for naming, cleancode and controversial rulesets</description>
<rule ref="rulesets/naming.xml/ConstructorWithNameAsEnclosingClass" />
<rule ref="rulesets/naming.xml/ConstantNamingConventions" />
<rule ref="rulesets/naming.xml/LongVariable">
<properties>
<property name="maximum" value="25" />
</properties>
</rule>
<rule ref="rulesets/naming.xml/ShortMethodName">
<properties>
<property name="minimum" value="2" />
</properties>
</rule>
<rule ref="rulesets/cleancode.xml">
<exclude name="ElseExpression" />
<exclude name="StaticAccess" />
</rule>
<rule ref="rulesets/controversial.xml/CamelCaseClassName" />
<rule ref="rulesets/controversial.xml/CamelCaseMethodName" />
<rule ref="rulesets/controversial.xml/CamelCaseParameterName" />
<rule ref="rulesets/controversial.xml/CamelCaseVariableName" />
<rule ref="rulesets/controversial.xml/CamelCasePropertyName">
<properties>
<property name="allow-underscore" value="true" />
</properties>
</rule>
</ruleset>
Loading…
Cancel
Save