[FEATURE] Improve Json output format (#366)

simonschaufi · web-flow · commit 8f998aa78a4a · 2025-12-01T21:25:11.000+01:00
- Include full class name in json output - Add configuration option to show the changelog Resolves: #349
diff --git a/e2e/only-option/expected-output.txt b/e2e/only-option/expected-output.txt
@@ -12,7 +12,7 @@
     ----------- end diff -----------
 
 Applied rules:
- * RenameConfigXhtmlDoctypeToDoctypeFractor (https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/12.4/Deprecation-100461-TypoScriptOptionConfigxhtmlDoctype.html)
+ * RenameConfigXhtmlDoctypeToDoctypeFractor
 
 
  [OK] 1 file has been changed by Fractor
diff --git a/e2e/typo3-extension/expected-output.txt b/e2e/typo3-extension/expected-output.txt
@@ -11,7 +11,7 @@
     ----------- end diff -----------
 
 Applied rules:
- * MigrateIncludeTypoScriptSyntaxFractor (https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/13.4/Deprecation-105171-INCLUDE_TYPOSCRIPTTypoScriptSyntax.html)
+ * MigrateIncludeTypoScriptSyntaxFractor
 
 
  [OK] 1 file has been changed by Fractor
diff --git a/e2e/typo3-typoscript/expected-output.txt b/e2e/typo3-typoscript/expected-output.txt
@@ -19,7 +19,7 @@
     ----------- end diff -----------
 
 Applied rules:
- * RemoveUseCacheHashFromTypolinkTypoScriptFractor (https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/10.0/Deprecation-88406-SetCacheHashnoCacheHashOptionsInViewHelpersAndUriBuilder.html)
+ * RemoveUseCacheHashFromTypolinkTypoScriptFractor
 
 
  [OK] 1 file has been changed by Fractor
diff --git a/e2e/typo3-xml/expected-output.txt b/e2e/typo3-xml/expected-output.txt
@@ -18,7 +18,7 @@
     ----------- end diff -----------
 
 Applied rules:
- * MigrateNullFlagFlexFormFractor (https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/12.0/Deprecation-97384-TCAOptionNullable.html)
+ * MigrateNullFlagFlexFormFractor
 
 
  [OK] 1 file has been changed by Fractor
diff --git a/e2e/typo3-yaml/expected-output.txt b/e2e/typo3-yaml/expected-output.txt
@@ -70,7 +70,7 @@
     ----------- end diff -----------
 
 Applied rules:
- * EmailFinisherYamlFractor (https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/10.0/Feature-80420-AllowMultipleRecipientsInEmailFinisher.html)
+ * EmailFinisherYamlFractor
 
 
  [OK] 1 file has been changed by Fractor
diff --git a/packages/fractor-xml/tests/AbstractXmlFractorTest.php b/packages/fractor-xml/tests/AbstractXmlFractorTest.php
@@ -23,7 +23,7 @@ public function canHandle(\DOMNode $node): bool
                 return $node->nodeName === 'Child';
             }
 
-            public function refactor(\DOMNode $node): \DOMNode
+            public function refactor(\DOMNode $node): \DOMElement
             {
                 if ($node->ownerDocument === null) {
                     throw new \RuntimeException('Node does not have an ownerDocument, cannot create element');
@@ -51,7 +51,7 @@ public function getRuleDefinition(): RuleDefinition
         self::assertStringStartsWith(
             'a9f\\FractorXml\\AbstractXmlFractor@anonymous',
             $file->getAppliedRules()[0]
-                ->getFractorRule()
+                ->getFractorClass()
         );
     }
 }
diff --git a/packages/fractor/src/Application/ValueObject/AppliedRule.php b/packages/fractor/src/Application/ValueObject/AppliedRule.php
@@ -9,10 +9,10 @@
 final readonly class AppliedRule
 {
     /**
-     * @param class-string<FractorRule> $fractorRule
+     * @param class-string<FractorRule> $fractorClass
      */
     private function __construct(
-        private string $fractorRule,
+        private string $fractorClass,
     ) {
     }
 
@@ -32,8 +32,8 @@ public static function fromClassString(string $fractorRule): self
     /**
      * @return class-string<FractorRule>
      */
-    public function getFractorRule(): string
+    public function getFractorClass(): string
     {
-        return $this->fractorRule;
+        return $this->fractorClass;
     }
 }
diff --git a/packages/fractor/src/ChangesReporting/Output/ConsoleOutputFormatter.php b/packages/fractor/src/ChangesReporting/Output/ConsoleOutputFormatter.php
@@ -29,7 +29,7 @@ public function getName(): string
 
     public function report(ProcessResult $processResult, Configuration $configuration): void
     {
-        $this->reportFileDiffs($processResult->getFileDiffs(), false);
+        $this->reportFileDiffs($processResult->getFileDiffs(), false, $configuration->shouldShowChangelog());
 
         // to keep space between progress bar and success message
         if ($configuration->shouldShowProgressBar() && $processResult->getFileDiffs() === []) {
@@ -43,7 +43,7 @@ public function report(ProcessResult $processResult, Configuration $configuratio
     /**
      * @param FileDiff[] $fileDiffs
      */
-    private function reportFileDiffs(array $fileDiffs, bool $absoluteFilePath): void
+    private function reportFileDiffs(array $fileDiffs, bool $absoluteFilePath, bool $showChangelog): void
     {
         if (\count($fileDiffs) <= 0) {
             return;
@@ -68,7 +68,9 @@ private function reportFileDiffs(array $fileDiffs, bool $absoluteFilePath): void
 
             if ($fileDiff->getAppliedRules() !== []) {
                 $this->symfonyStyle->writeln('<options=underscore>Applied rules:</>');
-                $this->symfonyStyle->listing($fileDiff->getAppliedRules());
+                $this->symfonyStyle->listing(
+                    $showChangelog ? $fileDiff->getChangelogsLines() : $fileDiff->getFractorShortClasses()
+                );
                 $this->symfonyStyle->newLine();
             }
         }
diff --git a/packages/fractor/src/ChangesReporting/Output/JsonOutputFormatter.php b/packages/fractor/src/ChangesReporting/Output/JsonOutputFormatter.php
@@ -37,7 +37,7 @@ public function report(ProcessResult $processResult, Configuration $configuratio
             $errorsJson['file_diffs'][] = [
                 'file' => $filePath,
                 'diff' => $fileDiff->getDiff(),
-                'applied_rules' => $fileDiff->getAppliedRules(),
+                'applied_rules' => $configuration->shouldShowChangelog() ? $fileDiff->getChangelogsLines() : $fileDiff->getFractorClasses(),
             ];
 
             // for CI
diff --git a/packages/fractor/src/Configuration/ConfigurationFactory.php b/packages/fractor/src/Configuration/ConfigurationFactory.php
@@ -28,6 +28,7 @@ public function createFromInput(InputInterface $input): Configuration
 
         $outputFormat = (string) $input->getOption(Option::OUTPUT_FORMAT);
         $showProgressBar = $this->shouldShowProgressBar($input, $outputFormat);
+        $showChangelog = $this->shouldShowChangelog($input);
 
         /** @var list<non-empty-string> $paths */
         $paths = $this->resolvePaths($input);
@@ -48,7 +49,8 @@ public function createFromInput(InputInterface $input): Configuration
             $fileExtensions,
             $paths,
             (array) $this->parameterBag->get(Option::SKIP),
-            $onlyRule
+            $onlyRule,
+            $showChangelog
         );
     }
 
@@ -79,6 +81,11 @@ private function shouldShowProgressBar(InputInterface $input, string $outputForm
         return $outputFormat === ConsoleOutputFormatter::NAME;
     }
 
+    private function shouldShowChangelog(InputInterface $input): bool
+    {
+        return (bool) $input->getOption(Option::SHOW_CHANGELOG);
+    }
+
     /**
      * @return string[]|mixed[]
      */
diff --git a/packages/fractor/src/Configuration/Option.php b/packages/fractor/src/Configuration/Option.php
@@ -70,6 +70,11 @@ final class Option
      */
     public const NO_PROGRESS_BAR = 'no-progress-bar';
 
+    /**
+     * @var string
+     */
+    public const SHOW_CHANGELOG = 'show-changelog';
+
     public const CACHE_CLASS = FileCacheStorage::class;
 
     public const CONTAINER_CACHE_DIRECTORY = 'container-cache-directory';
diff --git a/packages/fractor/src/Configuration/ValueObject/Configuration.php b/packages/fractor/src/Configuration/ValueObject/Configuration.php
@@ -26,6 +26,7 @@ public function __construct(
         private array $paths = [],
         private array $skip = [],
         private ?string $onlyRule = null,
+        private bool $showChangelog = false,
     ) {
         Assert::allStringNotEmpty($this->paths, 'No directories given');
     }
@@ -78,4 +79,9 @@ public function getOutputFormat(): string
     {
         return $this->outputFormat;
     }
+
+    public function shouldShowChangelog(): bool
+    {
+        return $this->showChangelog;
+    }
 }
diff --git a/packages/fractor/src/Console/Command/ProcessCommand.php b/packages/fractor/src/Console/Command/ProcessCommand.php
@@ -65,6 +65,12 @@ protected function configure(): void
             InputOption::VALUE_NONE,
             'Hide progress bar. Useful e.g. for nicer CI output.'
         );
+        $this->addOption(
+            Option::SHOW_CHANGELOG,
+            null,
+            InputOption::VALUE_NONE,
+            'Show changelog URI. Useful e.g. for more verbose output.'
+        );
         $this->addOption(
             Option::QUIET,
             Option::QUIET_SHORT,
diff --git a/packages/fractor/src/Differ/ValueObject/FileDiff.php b/packages/fractor/src/Differ/ValueObject/FileDiff.php
@@ -4,7 +4,10 @@
 
 namespace a9f\Fractor\Differ\ValueObject;
 
+use a9f\Fractor\Application\Contract\FractorRule;
+use a9f\Fractor\Application\ValueObject\AppliedRule;
 use Nette\Utils\Strings;
+use Webmozart\Assert\Assert;
 
 final readonly class FileDiff
 {
@@ -19,15 +22,18 @@
      */
     private const FIRST_LINE_REGEX = '#@@(.*?)(?<' . self::FIRST_LINE_KEY . '>\\d+)(.*?)@@#';
 
+    /**
+     * @param AppliedRule[] $appliedRules
+     * @param string[] $changelogsLines
+     */
     public function __construct(
         private string $relativeFilePath,
         private string $diff,
         private string $diffConsoleFormatted,
-        /**
-         * @var string[]
-         */
-        private array $appliedRules = []
+        private array $appliedRules = [],
+        private array $changelogsLines = [],
     ) {
+        Assert::allIsInstanceOf($appliedRules, AppliedRule::class);
     }
 
     public function getRelativeFilePath(): string
@@ -51,13 +57,45 @@ public function getDiffConsoleFormatted(): string
     }
 
     /**
-     * @return string[]
+     * @return AppliedRule[]
      */
     public function getAppliedRules(): array
     {
         return $this->appliedRules;
     }
 
+    /**
+     * @return string[]
+     */
+    public function getChangelogsLines(): array
+    {
+        return $this->changelogsLines;
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getFractorShortClasses(): array
+    {
+        $fractorShortClasses = [];
+        foreach ($this->getFractorClasses() as $fractorClass) {
+            $fractorShortClasses[] = (string) Strings::after($fractorClass, '\\', -1);
+        }
+        return $fractorShortClasses;
+    }
+
+    /**
+     * @return array<class-string<FractorRule>>
+     */
+    public function getFractorClasses(): array
+    {
+        $fractorClasses = [];
+        foreach ($this->appliedRules as $appliedRule) {
+            $fractorClasses[] = $appliedRule->getFractorClass();
+        }
+        return $fractorClasses;
+    }
+
     public function getFirstLineNumber(): ?int
     {
         $match = Strings::match($this->diff, self::FIRST_LINE_REGEX);
diff --git a/packages/fractor/src/Differ/ValueObjectFactory/FileDiffFactory.php b/packages/fractor/src/Differ/ValueObjectFactory/FileDiffFactory.php
@@ -31,6 +31,7 @@ public function createFileDiff(File $file): FileDiff
             $relativeFilePath,
             $this->defaultDiffer->diff($file->getDiff()),
             $this->consoleDiffer->diff($file->getDiff()),
+            $file->getAppliedRules(),
             $fractorsChangelogsLines
         );
     }
diff --git a/packages/fractor/src/Reporting/FractorsChangelogResolver.php b/packages/fractor/src/Reporting/FractorsChangelogResolver.php
@@ -21,7 +21,7 @@ public function resolveIncludingMissing(array $appliedRules): array
     {
         $fractorClassesToChangelogUrls = [];
         foreach ($appliedRules as $appliedRule) {
-            $fractorClass = $appliedRule->getFractorRule();
+            $fractorClass = $appliedRule->getFractorClass();
             $changelogUrl = $this->changelogExtractor->extractChangelogFromRule($fractorClass);
             $fractorClassesToChangelogUrls[$fractorClass] = $changelogUrl;
         }
diff --git a/packages/fractor/src/Testing/PHPUnit/ValueObject/FractorTestResult.php b/packages/fractor/src/Testing/PHPUnit/ValueObject/FractorTestResult.php
@@ -4,6 +4,7 @@
 
 namespace a9f\Fractor\Testing\PHPUnit\ValueObject;
 
+use a9f\Fractor\Application\Contract\FractorRule;
 use a9f\Fractor\ValueObject\ProcessResult;
 
 final readonly class FractorTestResult
@@ -20,13 +21,13 @@ public function getChangedContents(): string
     }
 
     /**
-     * @return array<string>
+     * @return array<class-string<FractorRule>>
      */
     public function getAppliedFractorRules(): array
     {
         $appliedRules = [];
         foreach ($this->processResult->getFileDiffs() as $fileDiff) {
-            $appliedRules = \array_merge($appliedRules, $fileDiff->getAppliedRules());
+            $appliedRules = \array_merge($appliedRules, $fileDiff->getFractorClasses());
         }
         \sort($appliedRules);
         return \array_unique($appliedRules);

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public function canHandle(\DOMNode $node): bool`
`23`	`23`	`return $node->nodeName === 'Child';`
`24`	`24`	`}`
`25`	`25`
`26`		`- public function refactor(\DOMNode $node): \DOMNode`
	`26`	`+ public function refactor(\DOMNode $node): \DOMElement`
`27`	`27`	`{`
`28`	`28`	`if ($node->ownerDocument === null) {`
`29`	`29`	`throw new \RuntimeException('Node does not have an ownerDocument, cannot create element');`
`@@ -51,7 +51,7 @@ public function getRuleDefinition(): RuleDefinition`
`51`	`51`	`self::assertStringStartsWith(`
`52`	`52`	`'a9f\\FractorXml\\AbstractXmlFractor@anonymous',`
`53`	`53`	`$file->getAppliedRules()[0]`
`54`		`- ->getFractorRule()`
	`54`	`+ ->getFractorClass()`
`55`	`55`	`);`
`56`	`56`	`}`
`57`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,10 +9,10 @@`
`9`	`9`	`final readonly class AppliedRule`
`10`	`10`	`{`
`11`	`11`	`/**`
`12`		`- * @param class-string<FractorRule> $fractorRule`
	`12`	`+ * @param class-string<FractorRule> $fractorClass`
`13`	`13`	`*/`
`14`	`14`	`private function __construct(`
`15`		`- private string $fractorRule,`
	`15`	`+ private string $fractorClass,`
`16`	`16`	`) {`
`17`	`17`	`}`
`18`	`18`
`@@ -32,8 +32,8 @@ public static function fromClassString(string $fractorRule): self`
`32`	`32`	`/**`
`33`	`33`	`* @return class-string<FractorRule>`
`34`	`34`	`*/`
`35`		`- public function getFractorRule(): string`
	`35`	`+ public function getFractorClass(): string`
`36`	`36`	`{`
`37`		`- return $this->fractorRule;`
	`37`	`+ return $this->fractorClass;`
`38`	`38`	`}`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public function getName(): string`
`29`	`29`
`30`	`30`	`public function report(ProcessResult $processResult, Configuration $configuration): void`
`31`	`31`	`{`
`32`		`- $this->reportFileDiffs($processResult->getFileDiffs(), false);`
	`32`	`+ $this->reportFileDiffs($processResult->getFileDiffs(), false, $configuration->shouldShowChangelog());`
`33`	`33`
`34`	`34`	`// to keep space between progress bar and success message`
`35`	`35`	`if ($configuration->shouldShowProgressBar() && $processResult->getFileDiffs() === []) {`
`@@ -43,7 +43,7 @@ public function report(ProcessResult $processResult, Configuration $configuratio`
`43`	`43`	`/**`
`44`	`44`	`* @param FileDiff[] $fileDiffs`
`45`	`45`	`*/`
`46`		`- private function reportFileDiffs(array $fileDiffs, bool $absoluteFilePath): void`
	`46`	`+ private function reportFileDiffs(array $fileDiffs, bool $absoluteFilePath, bool $showChangelog): void`
`47`	`47`	`{`
`48`	`48`	`if (\count($fileDiffs) <= 0) {`
`49`	`49`	`return;`
`@@ -68,7 +68,9 @@ private function reportFileDiffs(array $fileDiffs, bool $absoluteFilePath): void`
`68`	`68`
`69`	`69`	`if ($fileDiff->getAppliedRules() !== []) {`
`70`	`70`	`$this->symfonyStyle->writeln('<options=underscore>Applied rules:</>');`
`71`		`- $this->symfonyStyle->listing($fileDiff->getAppliedRules());`
	`71`	`+ $this->symfonyStyle->listing(`
	`72`	`+ $showChangelog ? $fileDiff->getChangelogsLines() : $fileDiff->getFractorShortClasses()`
	`73`	`+ );`
`72`	`74`	`$this->symfonyStyle->newLine();`
`73`	`75`	`}`
`74`	`76`	`}`