add --json option

TomasVotruba · Nov 9, 2023 · de263cd · de263cd
1 parent 62b0174
commit de263cd
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 7 deletions.
diff --git a/rector.php b/rector.php
@@ -21,7 +21,7 @@
     ]);
 
     $rectorConfig->paths([
-        __DIR__ . '/app',
+        __DIR__ . '/src',
         __DIR__ . '/tests',
     ]);
 

diff --git a/src/Commands/CheckCommand.php b/src/Commands/CheckCommand.php
@@ -79,7 +79,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $this->symfonyStyle->newLine();
         }
 
-        $usedNames = $this->resolveUsedClassNames($phpFilePaths, function (): void {
+        $usedNames = $this->resolveUsedClassNames($phpFilePaths, function () use ($isJson): void {
+            if ($isJson) {
+                return;
+            }
+
             $this->symfonyStyle->progressAdvance();
         });
 

diff --git a/src/Reporting/UnusedClassReporter.php b/src/Reporting/UnusedClassReporter.php
@@ -4,6 +4,7 @@
 
 namespace TomasVotruba\ClassLeak\Reporting;
 
+use Nette\Utils\Json;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use TomasVotruba\ClassLeak\ValueObject\FileWithClass;
@@ -21,30 +22,40 @@ public function __construct(
      */
     public function reportResult(UnusedClassesResult $unusedClassesResult, int $classCount, bool $isJson): int
     {
+        if ($isJson) {
+            $jsonResult = [
+                'unused_class_count' => $unusedClassesResult->getCount(),
+                'unused_parent_less_classes' => $unusedClassesResult->getParentLessFileWithClasses(),
+                'unused_classes_with_parents' => $unusedClassesResult->getWithParentsFileWithClasses(),
+            ];
+
+            $this->symfonyStyle->writeln(Json::encode($jsonResult, Json::PRETTY));
+
+            return Command::SUCCESS;
+        }
+
         $this->symfonyStyle->newLine(2);
 
         if ($unusedClassesResult->getCount() === 0) {
             $this->symfonyStyle->success(sprintf('All the %d services are used. Great job!', $classCount));
-
             return Command::SUCCESS;
         }
 
         // separate with and without parent, as first one can be removed more easily
-
         if ($unusedClassesResult->getWithParentsFileWithClasses() !== []) {
             $this->symfonyStyle->title('Classes with a parent/interface - possibly used by type');
+
             $this->reportFileWithClasses($unusedClassesResult->getWithParentsFileWithClasses());
         }
 
         if ($unusedClassesResult->getParentLessFileWithClasses() !== []) {
             $this->symfonyStyle->newLine();
-
             $this->symfonyStyle->title('Classes without any parent/interface - easier to remove');
+
             $this->reportFileWithClasses($unusedClassesResult->getParentLessFileWithClasses());
         }
 
         $this->symfonyStyle->newLine();
-
         $this->symfonyStyle->error(sprintf(
             'Found %d unused classes. Check and remove them or skip them using "--skip-type" option',
             $unusedClassesResult->getCount()

diff --git a/src/ValueObject/FileWithClass.php b/src/ValueObject/FileWithClass.php
@@ -4,9 +4,10 @@
 
 namespace TomasVotruba\ClassLeak\ValueObject;
 
+use JsonSerializable;
 use TomasVotruba\ClassLeak\FileSystem\StaticRelativeFilePathHelper;
 
-final class FileWithClass
+final class FileWithClass implements JsonSerializable
 {
     public function __construct(
         private readonly string $filePath,
@@ -29,4 +30,15 @@ public function hasParentClassOrInterface(): bool
     {
         return $this->hasParentClassOrInterface;
     }
+
+    /**
+     * @return array{file_path: string, class: string}
+     */
+    public function jsonSerialize(): array
+    {
+        return [
+            'file_path' => $this->filePath,
+            'class' => $this->className,
+        ];
+    }
 }