Skip to content

[FEATURE] Add PHPMD sniffing with a custom rule set #78

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

Merged
samtuke merged 1 commit into from
Jun 23, 2017
Merged

[FEATURE] Add PHPMD sniffing with a custom rule set #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,8 @@ script:
echo "Running the unit tests";
vendor/bin/phpunit core/tests/;
vendor/bin/phpunit Tests/Unit/;

- >
echo;
echo "Running PHPMD";
vendor/bin/phpmd Classes/ text Configuration/PHPMD/rules.xml;
39 changes: 39 additions & 0 deletions Configuration/PHPMD/rules.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<?xml version="1.0"?>
<ruleset name="phpList" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<description>
PHPMD rules for phpList
</description>

<!-- rules from the "clean code" rule set -->
<rule ref="rulesets/cleancode.xml/BooleanArgumentFlag"/>
<rule ref="rulesets/cleancode.xml/ElseExpression"/>
<rule ref="rulesets/cleancode.xml/StaticAccess">
<properties>
<property name="exceptions" value="\Doctrine\ORM\EntityManager,\Doctrine\ORM\Tools\Setup"/>
</properties>
</rule>

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

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

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

<!-- rules from the "naming" rule set -->
<rule ref="rulesets/naming.xml/ShortVariable">
<properties>
<property name="exceptions" value="id"/>
</properties>
</rule>
<rule ref="rulesets/naming.xml/LongVariable">
<properties>
<property name="maximum" value="25"/>
</properties>
</rule>
<rule ref="rulesets/naming.xml/ShortMethodName"/>
<rule ref="rulesets/naming.xml/ConstructorWithNameAsEnclosingClass"/>
<rule ref="rulesets/naming.xml/ConstantNamingConventions"/>
<rule ref="rulesets/naming.xml/BooleanGetMethodName"/>

<rule ref="rulesets/unusedcode.xml"/>
</ruleset>
3 changes: 2 additions & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@
},
"require-dev": {
"phpunit/phpunit": "^6.2.2",
"squizlabs/php_codesniffer": "^3.0.1"
"squizlabs/php_codesniffer": "^3.0.1",
"phpmd/phpmd": "^2.6.0"
},
"suggest": {
"phplist/web-frontend": "^4.0.0-dev",
Expand Down