Skip to content

chore(quality): point PHPMD at the central ruleset #498

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
rubenvdlinde merged 1 commit into from
Aug 12, 2026
Merged

chore(quality): point PHPMD at the central ruleset #498

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
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"phpcs": "./vendor/bin/phpcs --standard=phpcs.xml",
"phpcs:fix": "./vendor/bin/phpcbf --standard=phpcs.xml",
"phpcs:output": "./vendor/bin/phpcs --standard=phpcs.xml --report=json lib/ 2>/dev/null | tail -1 > phpcs-output.json",
"phpmd": "E=0; ./vendor/bin/phpmd lib text phpmd.xml --baseline-file phpmd.baseline.xml || E=$?; ./vendor/bin/phpmd lib text phpmd-unusedparams.xml --baseline-file phpmd.baseline.xml || E=$?; exit $E",
"phpmd": "E=0; ./vendor/bin/phpmd lib text phpmd.xml --baseline-file phpmd.baseline.xml || E=$?; ./vendor/bin/phpmd lib text vendor/conduction/hydra-gates/quality-config/phpmd-unusedparams.xml --baseline-file phpmd.baseline.xml || E=$?; exit $E",
"phpmetrics": "./vendor/bin/phpmetrics --report-html=phpmetrics lib/",
"phpmetrics:violations": "./vendor/bin/phpmetrics --violations-xml=phpmetrics/violations.xml lib/",
"psalm": "if [ -f vendor/bin/psalm ]; then ./vendor/bin/psalm --threads=1 --no-cache; else echo 'Psalm not installed, skipping...'; fi",
Expand Down
40 changes: 0 additions & 40 deletions phpmd-unusedparams.xml
View file
Open in desktop

This file was deleted.

122 changes: 4 additions & 118 deletions phpmd.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,123 +1,9 @@
<?xml version="1.0"?>
<ruleset name="SoftwareCatalog Nextcloud Rules"
<ruleset name="softwarecatalog"
xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0
http://pmd.sourceforge.net/ruleset_xml_schema.xsd">
xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_xml_schema.xsd">
<description>softwarecatalog — Conduction PHPMD ruleset (single source: conduction/hydra-gates).</description>

<description>
This is a custom ruleset for SoftwareCatalog Nextcloud.
</description>

<!-- Clean Code Rules -->
<rule ref="rulesets/cleancode.xml/BooleanArgumentFlag"/>
<rule ref="rulesets/cleancode.xml/ElseExpression"/>
<rule ref="rulesets/cleancode.xml/StaticAccess"/>
<rule ref="rulesets/cleancode.xml/IfStatementAssignment"/>
<rule ref="rulesets/cleancode.xml/DuplicatedArrayKey"/>
<rule ref="rulesets/cleancode.xml/MissingImport"/>
<rule ref="rulesets/cleancode.xml/UndefinedVariable"/>
<rule ref="rulesets/cleancode.xml/ErrorControlOperator"/>

<!-- Code Size Rules -->
<rule ref="rulesets/codesize.xml/CyclomaticComplexity"/>
<rule ref="rulesets/codesize.xml/NPathComplexity"/>
<rule ref="rulesets/codesize.xml/ExcessiveMethodLength"/>
<rule ref="rulesets/codesize.xml/ExcessiveClassLength"/>
<rule ref="rulesets/codesize.xml/ExcessiveParameterList"/>
<rule ref="rulesets/codesize.xml/ExcessivePublicCount"/>
<rule ref="rulesets/codesize.xml/TooManyFields"/>
<rule ref="rulesets/codesize.xml/TooManyMethods"/>
<rule ref="rulesets/codesize.xml/TooManyPublicMethods"/>
<rule ref="rulesets/codesize.xml/ExcessiveClassComplexity"/>

<!-- Controversial Rules -->
<rule ref="rulesets/controversial.xml/Superglobals"/>
<rule ref="rulesets/controversial.xml/CamelCaseClassName"/>
<rule ref="rulesets/controversial.xml/CamelCasePropertyName"/>
<rule ref="rulesets/controversial.xml/CamelCaseMethodName"/>
<!-- CamelCaseParameterName removed - we allow leading underscores on parameters (convention for unused/config params) -->
<!-- <rule ref="rulesets/controversial.xml/CamelCaseParameterName"/> -->
<!-- CamelCaseVariableName removed - we allow leading underscores on variables (convention for unused loop vars) -->
<!-- <rule ref="rulesets/controversial.xml/CamelCaseVariableName"/> -->

<!-- Design Rules -->
<rule ref="rulesets/design.xml/ExitExpression"/>
<rule ref="rulesets/design.xml/EvalExpression"/>
<rule ref="rulesets/design.xml/GotoStatement"/>
<rule ref="rulesets/design.xml/NumberOfChildren"/>
<rule ref="rulesets/design.xml/DepthOfInheritance"/>
<rule ref="rulesets/design.xml/CouplingBetweenObjects"/>
<!-- DevelopmentCodeFragment MUST carry ignore-namespaces=true, or it is dead
code in this ruleset. See ConductionNL/openregister#2286.

PDepend resolves an unqualified call inside a namespaced file to the
CURRENT-NAMESPACE-qualified image, so `var_dump($x)` in
`namespace OCA\MyApp\Service;` reaches the rule as
`OCA\MyApp\Service\var_dump`, which never matches the
`unwanted-functions` list. All of our production PHP is namespaced, so
with the default (false) the rule catches nothing anywhere.

Measured on phpmd 2.15.0 / PHP 8.3.32: byte-identical probe class,
namespaced -> exit 0, non-namespaced -> exit 2. With
ignore-namespaces=true the rule strips the enclosing namespace before
matching, the namespaced probe is reported (exit 2), and a clean
namespaced file stays exit 0.

Note: hydra gate 2 (forbidden-patterns) independently greps lib/ for
var_dump / die / error_log / print_r / dd / dump and is the broader
control - it also catches calls outside methods, which this rule (a
MethodAware/FunctionAware rule) cannot see. This rule is the
`composer check:strict` half of the same guard; keep both. -->
<rule ref="rulesets/design.xml/DevelopmentCodeFragment">
<properties>
<property name="ignore-namespaces" value="true"/>
</properties>
</rule>
<rule ref="rulesets/design.xml/EmptyCatchBlock"/>
<rule ref="rulesets/design.xml/CountInLoopExpression"/>

<!-- Naming Rules -->
<rule ref="rulesets/naming.xml/LongClassName"/>
<rule ref="rulesets/naming.xml/ShortClassName"/>
<!-- ShortVariable configured with allowlist of idiomatic short names -->
<rule ref="rulesets/naming.xml/ShortVariable">
<properties>
<property name="minimum" value="3" />
<property name="exceptions" value="id,db,qb,op,ui,io,gc,tz,pk,fk,to,ch,a,b,l,v,c,t,r,f,n,k,e" />
</properties>
</rule>
<rule ref="rulesets/naming.xml/LongVariable"/>
<rule ref="rulesets/naming.xml/ShortMethodName"/>
<rule ref="rulesets/naming.xml/ConstructorWithNameAsEnclosingClass"/>
<rule ref="rulesets/naming.xml/ConstantNamingConventions"/>
<rule ref="rulesets/naming.xml/BooleanGetMethodName"/>

<!-- Unused Code Rules -->
<rule ref="rulesets/unusedcode.xml/UnusedPrivateField"/>
<rule ref="rulesets/unusedcode.xml/UnusedLocalVariable"/>
<rule ref="rulesets/unusedcode.xml/UnusedPrivateMethod"/>
<!-- UnusedFormalParameter is NOT declared here. It lives alone in
phpmd-unusedparams.xml, which is run as a second leg by the "phpmd"
composer script.

Why: this rule used to carry a NESTED
<exclude-pattern>*Migration*</exclude-pattern>
meant to spare lib/Migration, whose changeSchema/preSchemaChange/
postSchemaChange signatures are mandated by OCP\Migration\IMigrationStep
and cannot drop their unused parameters. That pattern was INERT: PHPMD
2.15 reads exclude-patterns in RuleSetFactory::getIgnorePattern(), which
walks $xml->children() - i.e. only elements DIRECTLY under <ruleset>. A
nested one parses without error and does nothing, so lib/Migration was
always scanned by this rule (ConductionNL/.github#155).

Moving the pattern up to the top level of THIS file would make it
effective, but it is applied by PDepend's ExcludePathFilter at
file-collection time, so it drops lib/Migration from EVERY rule in the
ruleset - real complexity, StaticAccess and method-length findings in
migrations would silently vanish.

Isolating the rule in its own ruleset gives the exclusion a top-level
home that scopes it to this one rule, while the main leg above keeps
analysing lib/Migration with everything else. -->
<rule ref="vendor/conduction/hydra-gates/quality-config/phpmd.xml"/>
</ruleset>
Loading