Make rule class link to rule source

Fixes rectorphp/rector#5476
deprecated-packages · Feb 15, 2021 · 058952e · 058952e
1 parent 1353bd6
commit 058952e
Show file tree

Hide file tree

Showing 12 changed files with 36 additions and 28 deletions.
diff --git a/packages/rule-doc-generator/src/Finder/ClassByTypeFinder.php b/packages/rule-doc-generator/src/Finder/ClassByTypeFinder.php
@@ -11,7 +11,7 @@ final class ClassByTypeFinder
 {
     /**
      * @param string[] $directories
-     * @return string[]
+     * @return array<string, string>
      */
     public function findByType(array $directories, string $type): array
     {
@@ -24,8 +24,14 @@ public function findByType(array $directories, string $type): array
 
         $robotLoader->rebuild();
 
+        $workingDirectory = getcwd();
+
+        if (substr($workingDirectory, -1, 1) !== DIRECTORY_SEPARATOR) {
+            $workingDirectory .= DIRECTORY_SEPARATOR;
+        }
+
         $desiredClasses = [];
-        foreach (array_keys($robotLoader->getIndexedClasses()) as $class) {
+        foreach ($robotLoader->getIndexedClasses() as $class => $file) {
             if (! is_a($class, $type, true)) {
                 continue;
             }
@@ -36,10 +42,12 @@ public function findByType(array $directories, string $type): array
                 continue;
             }
 
-            $desiredClasses[] = $class;
+            $relativeFile = str_replace($workingDirectory, '', $file);
+
+            $desiredClasses[$relativeFile] = $class;
         }
 
-        sort($desiredClasses);
+        asort($desiredClasses);
 
         return $desiredClasses;
     }

diff --git a/packages/rule-doc-generator/src/Printer/RuleDefinitionsPrinter.php b/packages/rule-doc-generator/src/Printer/RuleDefinitionsPrinter.php
@@ -39,7 +39,7 @@ public function __construct(
     }
 
     /**
-     * @param RuleDefinition[] $ruleDefinitions
+     * @param array<string, RuleDefinition> $ruleDefinitions
      * @return string[]
      */
     public function print(array $ruleDefinitions, bool $shouldCategorize): array
@@ -67,16 +67,16 @@ public function print(array $ruleDefinitions, bool $shouldCategorize): array
     }
 
     /**
-     * @param RuleDefinition[] $ruleDefinitions
-     * @return array<string, RuleDefinition[]>
+     * @param array<string, RuleDefinition> $ruleDefinitions
+     * @return array<string, array<string, RuleDefinition>>
      */
     private function groupDefinitionsByCategory(array $ruleDefinitions): array
     {
         $ruleDefinitionsByCategory = [];
 
-        foreach ($ruleDefinitions as $ruleDefinition) {
+        foreach ($ruleDefinitions as $file => $ruleDefinition) {
             $category = $this->categoryResolver->resolve($ruleDefinition);
-            $ruleDefinitionsByCategory[$category][] = $ruleDefinition;
+            $ruleDefinitionsByCategory[$category][$file] = $ruleDefinition;
         }
 
         ksort($ruleDefinitionsByCategory);
@@ -85,13 +85,13 @@ private function groupDefinitionsByCategory(array $ruleDefinitions): array
     }
 
     /**
-     * @param RuleDefinition[] $ruleDefinitions
+     * @param array<string, RuleDefinition> $ruleDefinitions
      * @param string[] $lines
      * @return string[]
      */
     private function printRuleDefinitions(array $ruleDefinitions, array $lines, bool $shouldCategorize = false): array
     {
-        foreach ($ruleDefinitions as $ruleDefinition) {
+        foreach ($ruleDefinitions as $file => $ruleDefinition) {
             if ($shouldCategorize) {
                 $lines[] = '### ' . $ruleDefinition->getRuleShortClass();
             } else {
@@ -104,7 +104,7 @@ private function printRuleDefinitions(array $ruleDefinitions, array $lines, bool
                 $lines[] = Lines::CONFIGURE_IT;
             }
 
-            $lines[] = '- class: `' . $ruleDefinition->getRuleClass() . '`';
+            $lines[] = '- class: [`' . $ruleDefinition->getRuleClass() . '`](' . $file . ')';
 
             $codeSampleLines = $this->codeSamplePrinter->print($ruleDefinition);
             $lines = array_merge($lines, $codeSampleLines);
@@ -113,7 +113,7 @@ private function printRuleDefinitions(array $ruleDefinitions, array $lines, bool
     }
 
     /**
-     * @param array<string, RuleDefinition[]> $ruleDefinitionsByCategory
+     * @param array<string, array<string, RuleDefinition>> $ruleDefinitionsByCategory
      * @return string[]
      */
     private function createCategoryMenu(array $ruleDefinitionsByCategory): array

diff --git a/packages/rule-doc-generator/src/RuleDefinitionsResolver.php b/packages/rule-doc-generator/src/RuleDefinitionsResolver.php
@@ -13,13 +13,13 @@ final class RuleDefinitionsResolver
 {
     /**
      * @param string[] $classNames
-     * @return RuleDefinition[]
+     * @return array<string, RuleDefinition>
      */
     public function resolveFromClassNames(array $classNames): array
     {
         $ruleDefinitions = [];
 
-        foreach ($classNames as $className) {
+        foreach ($classNames as $fileName => $className) {
             $reflectionClass = new ReflectionClass($className);
             $documentedRule = $reflectionClass->newInstanceWithoutConstructor();
             if (! $documentedRule instanceof DocumentedRuleInterface) {
@@ -28,19 +28,19 @@ public function resolveFromClassNames(array $classNames): array
 
             $ruleDefinition = $documentedRule->getRuleDefinition();
             $ruleDefinition->setRuleClass($className);
-            $ruleDefinitions[] = $ruleDefinition;
+            $ruleDefinitions[$fileName] = $ruleDefinition;
         }
 
         return $this->sortByClassName($ruleDefinitions);
     }
 
     /**
-     * @param RuleDefinition[] $ruleDefinitions
-     * @return RuleDefinition[]
+     * @param array<string, RuleDefinition> $ruleDefinitions
+     * @return array<string, RuleDefinition>
      */
     private function sortByClassName(array $ruleDefinitions): array
     {
-        usort(
+        uasort(
             $ruleDefinitions,
             function (RuleDefinition $firstRuleDefinition, RuleDefinition $secondRuleDefinition): int {
                 return $firstRuleDefinition->getRuleShortClass() <=> $secondRuleDefinition->getRuleShortClass();

diff --git a/...ctoryToMarkdownPrinter/Expected/php-cs-fixer/configurable_phpcsfixer_content.md b/...ctoryToMarkdownPrinter/Expected/php-cs-fixer/configurable_phpcsfixer_content.md
@@ -6,7 +6,7 @@ Some description
 
 :wrench: **configure it!**
 
-- class: `Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\PHPCSFixer\Configurable\SomeConfiguredFixer`
+- class: [`Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\PHPCSFixer\Configurable\SomeConfiguredFixer`](packages/rule-doc-generator/tests/DirectoryToMarkdownPrinter/Fixture/PHPCSFixer/Configurable/SomeConfiguredFixer.php)
 
 ```php
 <?php

diff --git a/...or/tests/DirectoryToMarkdownPrinter/Expected/php-cs-fixer/phpcsfixer_content.md b/...or/tests/DirectoryToMarkdownPrinter/Expected/php-cs-fixer/phpcsfixer_content.md
@@ -4,7 +4,7 @@
 
 Some description
 
-- class: `Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\PHPCSFixer\Standard\SomeFixer`
+- class: [`Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\PHPCSFixer\Standard\SomeFixer`](packages/rule-doc-generator/tests/DirectoryToMarkdownPrinter/Fixture/PHPCSFixer/Standard/SomeFixer.php)
 
 ```diff
 -bad code

diff --git a/...sts/DirectoryToMarkdownPrinter/Expected/phpstan/configurable_phpstan_content.md b/...sts/DirectoryToMarkdownPrinter/Expected/phpstan/configurable_phpstan_content.md
@@ -6,7 +6,7 @@ Some description
 
 :wrench: **configure it!**
 
-- class: `Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\PHPStan\Configurable\SomePHPStanRule`
+- class: [`Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\PHPStan\Configurable\SomePHPStanRule`](packages/rule-doc-generator/tests/DirectoryToMarkdownPrinter/Fixture/PHPStan/Configurable/SomePHPStanRule.php)
 
 ```yaml
 services:

diff --git a/...-generator/tests/DirectoryToMarkdownPrinter/Expected/phpstan/phpstan_content.md b/...-generator/tests/DirectoryToMarkdownPrinter/Expected/phpstan/phpstan_content.md
@@ -4,7 +4,7 @@
 
 Some description
 
-- class: `Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\PHPStan\Standard\SomePHPStanRule`
+- class: [`Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\PHPStan\Standard\SomePHPStanRule`](packages/rule-doc-generator/tests/DirectoryToMarkdownPrinter/Fixture/PHPStan/Standard/SomePHPStanRule.php)
 
 ```php
 bad code

diff --git a/...irectoryToMarkdownPrinter/Expected/rector/composer_json_aware_rector_content.md b/...irectoryToMarkdownPrinter/Expected/rector/composer_json_aware_rector_content.md
@@ -4,7 +4,7 @@
 
 Some change
 
-- class: `Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\Rector\ComposerJsonAware\ComposerJsonAwareRector`
+- class: [`Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\Rector\ComposerJsonAware\ComposerJsonAwareRector`](packages/rule-doc-generator/tests/DirectoryToMarkdownPrinter/Fixture/Rector/ComposerJsonAware/ComposerJsonAwareRector.php)
 
 - with `composer.json`:
 

diff --git a/...tests/DirectoryToMarkdownPrinter/Expected/rector/configurable_rector_content.md b/...tests/DirectoryToMarkdownPrinter/Expected/rector/configurable_rector_content.md
@@ -6,7 +6,7 @@ Some change
 
 :wrench: **configure it!**
 
-- class: `Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\Rector\Configurable\ConfigurableRector`
+- class: [`Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\Rector\Configurable\ConfigurableRector`](packages/rule-doc-generator/tests/DirectoryToMarkdownPrinter/Fixture/Rector/Configurable/ConfigurableRector.php)
 
 ```php
 <?php

diff --git a/...r/tests/DirectoryToMarkdownPrinter/Expected/rector/extra_file_rector_content.md b/...r/tests/DirectoryToMarkdownPrinter/Expected/rector/extra_file_rector_content.md
@@ -4,7 +4,7 @@
 
 Some change
 
-- class: `Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\Rector\ExtraFile\ExtraFileRector`
+- class: [`Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\Rector\ExtraFile\ExtraFileRector`](packages/rule-doc-generator/tests/DirectoryToMarkdownPrinter/Fixture/Rector/ExtraFile/ExtraFileRector.php)
 
 ```diff
 -before

diff --git a/...enerator/tests/DirectoryToMarkdownPrinter/Expected/rector/rector_categorized.md b/...enerator/tests/DirectoryToMarkdownPrinter/Expected/rector/rector_categorized.md
@@ -14,7 +14,7 @@
 
 Some change
 
-- class: `Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\Rector\Standard\SomeRector`
+- class: [`Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\Rector\Standard\SomeRector`](packages/rule-doc-generator/tests/DirectoryToMarkdownPrinter/Fixture/Rector/Standard/SomeRector.php)
 
 ```diff
 -before

diff --git a/...oc-generator/tests/DirectoryToMarkdownPrinter/Expected/rector/rector_content.md b/...oc-generator/tests/DirectoryToMarkdownPrinter/Expected/rector/rector_content.md
@@ -4,7 +4,7 @@
 
 Some change
 
-- class: `Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\Rector\Standard\SomeRector`
+- class: [`Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\Rector\Standard\SomeRector`](packages/rule-doc-generator/tests/DirectoryToMarkdownPrinter/Fixture/Rector/Standard/SomeRector.php)
 
 ```diff
 -before
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,7 +6,7 @@ Some description @@
     :wrench: **configure it!**
-    - class: `Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\PHPCSFixer\Configurable\SomeConfiguredFixer`
+    - class: [`Symplify\RuleDocGenerator\Tests\DirectoryToMarkdownPrinter\Fixture\PHPCSFixer\Configurable\SomeConfiguredFixer`](packages/rule-doc-generator/tests/DirectoryToMarkdownPrinter/Fixture/PHPCSFixer/Configurable/SomeConfiguredFixer.php)
     ```php
     <?php
@@ Expand Down @@