Engine accepts paths to custom ruleset #6
Conversation
| foreach ($configRulesets as &$r) { | ||
| if (!in_array($r, $officialPhpRulesets)) { | ||
| $r = "/code/$r"; | ||
| continue; |
There was a problem hiding this comment.
Is this actually needed? There's nothing else in the loop after this, so I don't think it accomplishes anything.
There was a problem hiding this comment.
I think you're right, I don't think it's needed. I can remove
ABaldwinHunter
force-pushed
the
abh-custom-rulesets
branch
from
d62d785 to
24cba2f
Compare
When PHPMD gets run, it accepts rule names, e.g.
codesize,unusedcode,naming
as a comma separated string.
It also accepts paths to a custome rule defined by the user mixed
in. For example:
```
phpmd:
enabled: true
config:
rulesets: "unusedcode,codesize,cleancode,design,naming,phpmd.xml"
```
where `phpmd.xml` contains a custom rule set up by user.
Previously, our engine failed to honor that config setup because it didn't
prefix `/code/` to the path. The result was 0 issues found across board.
This change fixes that behavior.
ABaldwinHunter
force-pushed
the
abh-custom-rulesets
branch
from
24cba2f to
e595bb0
Compare
|
Thanks @wfleming. Updated. Ready for another look! |
|
|
||
| foreach ($configRulesets as &$r) { | ||
| if (!in_array($r, $officialPhpRulesets)) { | ||
| $r = "/code/$r"; |
There was a problem hiding this comment.
💄 looks like this needs to be indented another column?
|
Two more suggestions (one of which PHP code sniffer also caught, so that's working, which is nice.). Other than that, LGTM. |
|
Thanks @wfleming. I made a couple of minor style fixes in that file as well. |
|
|
||
| foreach ($configRulesets as &$r) { | ||
| if (!in_array($r, $officialPhpRulesets)) { | ||
| $r = "/code/$r"; |
There was a problem hiding this comment.
I think it might be worth it to detect the case where someone enters an absolute path (ie. don't prepend /code if the string starts with /)
If a user provides an absolute path to ruleset file, we won't prepend `/code/`. This behavior seems intuitive and also prevents breakage with current codeclimate-php configs which may have come to use `/code` as a workaround.
|
@gordondiggs @wfleming updated. Ready for a (hopefully) final look! |
|
👍 |
Engine accepts paths to custom ruleset
When PHPMD gets run, it accepts rule names, e.g.
codesize,unusedcode,naming
as a comma separated string.
It also accepts paths to a custome rule defined by the user mixed
in. For example:
where
phpmd.xmlcontains a custom rule set up by user.Previously, our engine failed to honor that config setup because it didn't
prefix
/code/to the path. The result was 0 issues found across board.This change fixes that behavior.
cc @codeclimate/review @leftees