Allow to configure PHPMD with php or yaml file #1058

kylekatarnls · 2024-01-07T12:18:47Z

Type: feature
Breaking change: yes

kylekatarnls · 2024-01-07T15:38:43Z

Note: the src/conf/phpmd.schema.json file is what allow auto-completion in IDEs:

To be automatically applied to phpmd.yml files by IDE, we'll need to submit it in
https://github.com/SchemaStore/schemastore/tree/master/src/schemas/json

Then to be associated to relevant file names in the catalog:
https://github.com/SchemaStore/schemastore/blob/master/src/api/json/catalog.json

kylekatarnls · 2024-01-07T16:49:21Z

src/test/resources/files/rulesets/phpmd.yml is an example of how it would look to configure rule with a YAML file.

It would work the same by providing JSON file or PHP file returning the same array structure.

kylekatarnls · 2024-01-07T16:51:14Z

src/test/php/PHPMD/TextUI/CommandLineOptionsTest.php

+        $options = new CommandLineOptions([__FILE__, 'app', 'sarif']);

-        $args = [__FILE__, 'text', 'design'];
-        new CommandLineOptions($args);
+        self::assertSame('cleancode,codesize,controversial,design,naming,unusedcode', $options->getRuleSets());
+        self::assertSame('sarif', $options->getReportFormat());
+        self::assertSame('app', $options->getInputPath());
+
+        $options = new CommandLineOptions([__FILE__, 'app']);
+
+        self::assertSame('cleancode,codesize,controversial,design,naming,unusedcode', $options->getRuleSets());
+        self::assertSame('text', $options->getReportFormat());
+        self::assertSame('app', $options->getInputPath());
+
+        $options = new CommandLineOptions([__FILE__]);
+
+        self::assertSame('cleancode,codesize,controversial,design,naming,unusedcode', $options->getRuleSets());
+        self::assertSame('text', $options->getReportFormat());
+        self::assertSame('src', $options->getInputPath());


Arguments would all become optional:
See the default values on https://github.com/phpmd/phpmd/pull/1058/files#diff-d7bddc86dbcab23cca1d846c4d63a3957de2b6d196f6e4527e18161ff908118b

kylekatarnls · 2024-01-07T16:53:24Z

src/main/php/PHPMD/TextUI/CommandLineOptions.php

+            0 => [file_exists('src') ? 'src' : '.', 'text', $this->getDefaultConfig()],
+            1 => ['text', $this->getDefaultConfig()],
+            2 => [$this->getDefaultConfig()],
+            default => [],


input path would fallback to "src" if it's exist, "." else

report format would fallback to "text"

ruleset would fallback to first config file found by getDefaultConfig, or "all" if no file provided.

kylekatarnls · 2024-01-07T16:54:15Z

src/main/php/PHPMD/TextUI/CommandLineOptions.php


        $validator = new ArgumentsValidator($hasImplicitArguments, $originalArguments, $arguments);

-        $this->ruleSets = (string)array_pop($arguments);
+        $ruleSets = (string)array_pop($arguments);
+        $this->ruleSets = $ruleSets === 'all' ? InternalRuleSet::getNamesConcatenated() : $ruleSets;


"all" would be a shorthand for all internal rulesets from PHPMD:

cleancode,codesize,controversial,design,naming,unusedcode

Upgrade to PHPUnit 10

AJenbo · 2024-05-11T16:20:17Z

Not using XML is a big improvement in my book. I prefer the PHP option personally.

@kylekatarnls I think now is a good point to rebase this so it's ready for merging.

…ti-format-support # Conflicts: # composer.json # src/main/php/PHPMD/RuleSetFactory.php # src/main/php/PHPMD/TextUI/CommandLineOptions.php # src/test/php/PHPMD/RuleSetFactoryTest.php # src/test/php/PHPMD/RuleSetTest.php # src/test/php/PHPMD/TextUI/CommandLineOptionsTest.php

codecov · 2024-05-16T17:46:43Z

Codecov Report

Attention: Patch coverage is 94.78673% with 11 lines in your changes are missing coverage. Please review.

Project coverage is 92.22%. Comparing base (b22ed70) to head (2585b4e).
Report is 7 commits behind head on 3.x.

Files	Patch %	Lines
src/main/php/PHPMD/RuleSetFactory.php	94.02%	8 Missing ⚠️
src/main/php/PHPMD/Node/FunctionNode.php	33.33%	2 Missing ⚠️
src/main/php/PHPMD/TextUI/CommandLineOptions.php	95.65%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##                3.x    #1058      +/-   ##
============================================
+ Coverage     92.15%   92.22%   +0.07%     
- Complexity     1278     1297      +19     
============================================
  Files           107      109       +2     
  Lines          3378     3448      +70     
============================================
+ Hits           3113     3180      +67     
- Misses          265      268       +3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

AJenbo · 2024-05-16T23:09:35Z

src/main/php/PHPMD/AbstractNode.php

     */
-    public function getMetric($name)
+    public function getMetric(string $name): null|float|int


this doesn't cover numeric-string, i think that might be used some times, though I'm not 100% sure.

We should not use string to represent numbers, they all come from getNodeMetrics from PDepend, I will make a PR to ensure/enforce them.

I checked them all, no string https://github.com/pdepend/pdepend/pull/826/files

I was wrong, npath is a numeric string, it sounds it was to support integer numbers bigger than 64 bits.

We could add a php64 requirement in composer.

…ti-format-support

AJenbo · 2024-05-17T01:21:30Z

src/main/php/PHPMD/RuleSetFactory.php

@@ -32,31 +36,18 @@ class RuleSetFactory
    /**


This calls is getting a bit heavy on pulling out mixed variables and casting them to various types. This is likely going to trigger a lot of unsafe operations on higher PHPStan levels.

AJenbo · 2024-05-17T01:23:06Z

Lots of things going on in one PR, most of it is nice, but a bit hard to review and comment on individual things with it all there.

kylekatarnls · 2024-05-17T09:03:53Z

In theory bcmul can go even above 64 bits, but I wonder if it has a real interest in practice for npath (and also why it would be the only one using big number). BTW it also possible to go above by using float (which is automatic in PHP), it just loose a bit of precision but I'm not sure it's an actual problem, if you have billion npath, you probably care about order of magnitude, not an exact value.

AJenbo · 2024-05-17T10:09:04Z

i wold normally just use it if decimal fractional rounding is important, I have a hard time imagining the need for values that high.

kylekatarnls · 2024-05-18T16:59:03Z

Lots of things going on in one PR, most of it is nice, but a bit hard to review and comment on individual things with it all there.

I'm also unsatisfied about how it growth after re-basing. I will split.

kylekatarnls added this to the 3.0.0 milestone Jan 7, 2024

kylekatarnls force-pushed the feature/multi-format-support branch from 67d9440 to 2bedff3 Compare January 7, 2024 14:47

kylekatarnls added Feature Needs Tests Needs Documentation RFC labels Jan 7, 2024

kylekatarnls commented Jan 7, 2024

View reviewed changes

kylekatarnls force-pushed the feature/multi-format-support branch 2 times, most recently from dabeb46 to 51c1a92 Compare January 7, 2024 17:06

kylekatarnls force-pushed the feature/3.x-experiment branch from 799e1db to 5173ebb Compare January 17, 2024 13:27

kylekatarnls force-pushed the feature/multi-format-support branch from 51c1a92 to 0439441 Compare January 17, 2024 13:53

kylekatarnls added 7 commits January 17, 2024 16:34

Drop PHP 7

701e770

Upgrade to PHPUnit 10

Allow to configure PHPMD with php or yaml file

ea38013

Add JSON-schema

10734ab

Add test for Yaml file

2dcf192

Allow JSON config files

a341dae

Add phpmd.yaml and phpmd.json in file searched by default

8b14a4a

Re-allow PHPUnit 9

7775855

kylekatarnls force-pushed the feature/multi-format-support branch from 0439441 to 7775855 Compare January 17, 2024 15:35

Base automatically changed from feature/3.x-experiment to 3.x April 29, 2024 15:24

kylekatarnls added 2 commits May 16, 2024 15:57

Fix typing compatibility in tests

a8e9475

kylekatarnls changed the title ~~[Tentative] Allow to configure PHPMD with php or yaml file~~ Allow to configure PHPMD with php or yaml file May 16, 2024

kylekatarnls added 2 commits May 16, 2024 16:23

Use First-class Callable Syntax

cee2eb9

PHP-CS-Fixer

8170b24

Improve typing

9568e9b

kylekatarnls force-pushed the feature/multi-format-support branch 2 times, most recently from fa728ee to c7d924c Compare May 16, 2024 17:01

Fix findFileForRule

2be8831

kylekatarnls force-pushed the feature/multi-format-support branch from c7d924c to 2be8831 Compare May 16, 2024 17:45

kylekatarnls added 2 commits May 16, 2024 19:57

Resolve PHPUnit warnings

7b4b1e9

Replace getName() with getImage()

d14c697

AJenbo reviewed May 16, 2024

View reviewed changes

kylekatarnls force-pushed the feature/multi-format-support branch from 314aee6 to 2b5bd39 Compare May 16, 2024 23:11

kylekatarnls added 2 commits May 17, 2024 01:34

Improve typing

f3166f2

Merge branch '3.x' of https://github.com/phpmd/phpmd into feature/mul…

fd42028

…ti-format-support

kylekatarnls force-pushed the feature/multi-format-support branch 2 times, most recently from 1fa1037 to df1b444 Compare May 17, 2024 00:01

Add tests

2585b4e

kylekatarnls force-pushed the feature/multi-format-support branch from df1b444 to 2585b4e Compare May 17, 2024 00:04

kylekatarnls marked this pull request as ready for review May 17, 2024 00:17

kylekatarnls requested review from AJenbo, ravage84 and tvbeek May 17, 2024 00:17

AJenbo approved these changes May 17, 2024

View reviewed changes

ravage84 added the Configuration label May 24, 2024

ravage84 mentioned this pull request May 24, 2024

[3.x] [RFC] Support for New Configuration Formats #1167

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow to configure PHPMD with php or yaml file #1058

Allow to configure PHPMD with php or yaml file #1058

kylekatarnls commented Jan 7, 2024

kylekatarnls commented Jan 7, 2024 •

edited

kylekatarnls commented Jan 7, 2024

kylekatarnls Jan 7, 2024

kylekatarnls Jan 7, 2024

kylekatarnls Jan 7, 2024

AJenbo commented May 11, 2024

codecov bot commented May 16, 2024 •

edited

AJenbo May 16, 2024

kylekatarnls May 16, 2024

kylekatarnls May 16, 2024

kylekatarnls May 17, 2024

AJenbo May 17, 2024

AJenbo May 17, 2024 •

edited

AJenbo commented May 17, 2024

kylekatarnls commented May 17, 2024 •

edited

AJenbo commented May 17, 2024

kylekatarnls commented May 18, 2024

Allow to configure PHPMD with php or yaml file #1058

Are you sure you want to change the base?

Allow to configure PHPMD with php or yaml file #1058

Conversation

kylekatarnls commented Jan 7, 2024

kylekatarnls commented Jan 7, 2024 • edited

kylekatarnls commented Jan 7, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AJenbo commented May 11, 2024

codecov bot commented May 16, 2024 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AJenbo May 17, 2024 • edited

Choose a reason for hiding this comment

AJenbo commented May 17, 2024

kylekatarnls commented May 17, 2024 • edited

AJenbo commented May 17, 2024

kylekatarnls commented May 18, 2024

kylekatarnls commented Jan 7, 2024 •

edited

codecov bot commented May 16, 2024 •

edited

AJenbo May 17, 2024 •

edited

kylekatarnls commented May 17, 2024 •

edited