Running dump-rectors (on Drupal Rector project) creates broken links for classes in documentation

[shaal]

Bug Report

Based on these instructions: #3265

I ran: vendor/bin/rector dump-rectors drupal-rector/src/ > drupal-rector/docs/drupal_rector_rules.md

And created this PR palantirnet/drupal-rector#102

The result:
https://github.com/palantirnet/drupal-rector/blob/master/docs/drupal_rector_rules.md

But if you try clicking on any of the classes links you'll get 404 page.
Example for a broken link:
https://github.com/palantirnet/drupal-rector/blob/master/drupal-rector/src/Rector/Deprecation/BrowserTestBaseGetMockRector.php

[TomasVotruba]

What exactly needs to be changed to make it work?

[samsonasik]

@TomasVotruba could you give me information about the classes that related to it ?

[TomasVotruba]

Sure.

It's command in CLI: Rector\DocumentationGenerator\Command\DumpRectorsCommand

There is called markdown formatter.
In it, there is a method that dump the single Rector documentation:

rector/packages/documentation-generator/src/OutputFormatter/MarkdownDumpRectorsOutputFormatter.php

Line 94 in 8311a55

$this->rectorPrinter->printRector($rector, $isRectorProject);

This method is probably broken for 3rd party code:

rector/packages/documentation-generator/src/OutputFormatter/RectorPrinter.php

Line 74 in 8311a55

$fixtureDirectoryPath = $this->resolveFixtureDirectoryPathOnGitHub($rectorTestClass);

Expected Behavior?

It suppose to resolve file path in the dumped file, so when you click on the rule in the generated markdown, it will open the file on Github:

Let me know if you need more indicies.

This just needs hotfix, tests for path resolved are welcomed, but not neccessary

[samsonasik]

I created PR #4115 for it.