Implement phpstan doc parsing

[williamdes]

Ref: phpDocumentor/ReflectionDocBlock#343
Ref: https://twitter.com/wdesportes/status/1535565834340417536

Ref:

• Not reporting anymore as much parameters for functions phpDocumentor/ReflectionDocBlock#352
• Legacy nullable type detected, please update your code as you are using nullable types in a docblock phpDocumentor/TypeResolver#178
• Be strict about deprecations phpDocumentor/TypeResolver#185

Waiting on:

• Not reporting anymore as much parameters for functions phpDocumentor/ReflectionDocBlock#352

[tillkruss]

Nice, looking forward to this!

[jaapio]

Finally found the time to address the last reported issues on reflection-docblock. If you have time to update and rerun your test suite that would be very welcome!

[williamdes]

Finally found the time to address the last reported issues on reflection-docblock. If you have time to update and rerun your test suite that would be very welcome!

Thank you so much !

Here is the test errors

There were 2 failures:

1) Doctum\Tests\Parser\NodeVisitorTest::testUpdateMethodParametersFromInvalidTags
Failed asserting that two arrays are identical.
--- Expected
+++ Actual
@@ @@
 Array &0 (
     0 => 'The "param2" parameter of the method "fun1" is missing a @param tag'
     1 => 'The method "fun1" has "6" @param tags but only "2" where expected.'
-    2 => 'The method "fun1" has "1" invalid @param tags.'
-    3 => 'Invalid @param tag on "fun1": "array[\Illuminate\Notifications\Channels\Notification]  $notification"'
 )

/mnt/Dev/@code-lts/doctum/tests/Parser/NodeVisitorTest.php:471

2) Doctum\Tests\Parser\NodeVisitorTest::testUpdateMethodParametersFromInvalidTagsReport
Failed asserting that two arrays are identical.
--- Expected
+++ Actual
@@ @@
-Array &0 (
-    0 => 'The "notification" parameter of the method "fun1" is missing a @param tag'
-    1 => 'The method "fun1" has "1" invalid @param tags.'
-    2 => 'Invalid @param tag on "fun1": "array[\Illuminate\Notifications\Channels\Notification]  $notification"'
-)
+Array &0 ()

/mnt/Dev/@code-lts/doctum/tests/Parser/NodeVisitorTest.php:509

Do you think * @param array[\Illuminate\Notifications\Channels\Notification] $notification should be reported as invalid ?

it seems like it I change the test case to @param array\Illuminate\Notifications\Channels\Notification] $notification it still does not get reported. Is there a mistake in my implementation or is it missing in the phpdocumentor library ?

[jaapio]

I do not recognize those as valid notations. Array[] cannot have any content. Array<> can

[williamdes]

Okay, so they should be reported as invalid.
This one should definitely be reported @param array\Illuminate\Notifications\Channels\Notification> $notification

[williamdes]

How does your library handle Invalid tags?

[jaapio]

We will return an InvalidTag object, so people can see what is wrong and the parsing continues.

[williamdes]

We will return an InvalidTag object, so people can see what is wrong and the parsing continues.

Awesome, let me know when it is pushed

[jasonmccallister]

👋 just wanted to give a friendly nudge and say I love this library and also see if there is anything I can do to help get this merged/pushed along?

[williamdes]

👋 just wanted to give a friendly nudge and say I love this library and also see if there is anything I can do to help get this merged/pushed along?

Hi,
This is very nice, thank you for the support !
I am sorting out the PHP version issues with the libraries bumps
And will rebase this one so we can get it merged

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 63.20%. Comparing base (ba67a5d) to head (d411fb3).
⚠️ Report is 9 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main      #51      +/-   ##
============================================
+ Coverage     62.84%   63.20%   +0.35%     
- Complexity     1203     1208       +5     
============================================
  Files            53       53              
  Lines          3335     3400      +65     
============================================
+ Hits           2096     2149      +53     
- Misses         1239     1251      +12     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.