Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

PHP Mess Detector ruleset #265

Merged
merged 6 commits into from Feb 14, 2022
Merged

PHP Mess Detector ruleset #265

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
70e8540
Initial ruleset
Nov 10, 2020
81b4bb8
Add 'id' to exceptions
Jan 18, 2021
9a142f0
Ignore Factory and TestUtil static method access
Feb 1, 2021
9b6e6fa
Rename PHP Mess Detector ruleset to default
tofu-rocketry Feb 14, 2022
5c6e0ef
Remove or enable disabled Mess Detector rules
tofu-rocketry Feb 14, 2022
0ca5973
Improve rule set description and name
tofu-rocketry Feb 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions phpmd.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<?xml version="1.0" encoding="UTF-8"?>
<ruleset name="GOCDB rule set for PHP Mess Detector"
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>
GOCDB rule set for PHP Mess Detector. (https://phpmd.org/documentation/creating-a-ruleset.html)
</description>

<rule ref="rulesets/unusedcode.xml"/> <!-- add the whole ruleset-->

<rule ref="rulesets/controversial.xml">
<exclude name="CamelCaseMethodName" /> <!-- add the whole ruleset except this rule -->
</rule>
<rule ref="rulesets/controversial.xml/CamelCaseMethodName"> <!-- Add the rule back with modifications -->
<properties>
<property name="allow-underscore" value="true" />
</properties>
</rule>

<rule ref="rulesets/codesize.xml">
<exclude name="TooManyFields" />
</rule>
<rule ref="rulesets/codesize.xml/TooManyFields">
<properties>
<property name="maxfields" value="20" />
</properties>
</rule>

<rule ref="rulesets/cleancode.xml">
<exclude name="ElseExpression" />
<exclude name="StaticAccess" />
<exclude name="MissingImport" />
</rule>
<rule ref="rulesets/cleancode.xml/StaticAccess">
<!-- Allow Services Factory and some test helpers -->
<properties>
<property name="exceptions" value="Factory,TestUtil,ServiceTestUtil" />
</properties>
</rule>
<rule ref="rulesets/cleancode.xml/MissingImport">
<!-- Add the rule back with modifications -->
<properties>
<property name="ignore-global" value="true" />
</properties>
</rule>

<rule ref="rulesets/naming.xml">
<exclude name="ShortVariable" />
</rule>
<rule ref="rulesets/naming.xml/ShortVariable">
<!-- Allow common GOCDB exceptions for Entity Manager, cert DN etc. -->
<properties>
<property name="exceptions" value="em,dn,id" />
</properties>
</rule>

<rule ref="rulesets/design.xml">
<exclude name="ExitExpression"/> <!-- Current GOCDB practice -->
</rule>

</ruleset>