Add pretty-json command (#26)

* Add pretty-json command * fixup! Add pretty-json command
rectorphp · May 10, 2024 · 64d9bf8 · 64d9bf8
1 parent b2b162e
commit 64d9bf8
Show file tree

Hide file tree

Showing 5 changed files with 107 additions and 5 deletions.
diff --git a/src/Command/PrettyJsonCommand.php b/src/Command/PrettyJsonCommand.php
@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\SwissKnife\Command;
+
+use Nette\Utils\FileSystem;
+use Nette\Utils\Json;
+use Rector\SwissKnife\Finder\FilesFinder;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+final class PrettyJsonCommand extends Command
+{
+    public function __construct(
+        private readonly SymfonyStyle $symfonyStyle,
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this->setName('pretty-json');
+
+        $this->addArgument(
+            'sources',
+            InputArgument::REQUIRED | InputArgument::IS_ARRAY,
+            'File or directory to prettify'
+        );
+        $this->setDescription('Turns JSON files from 1-line format to pretty format');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $sources = (array) $input->getArgument('sources');
+        $jsonFileInfos = FilesFinder::findJsonFiles($sources);
+
+        if (count($jsonFileInfos) === 0) {
+            $this->symfonyStyle->error('No *.json files found');
+            return self::FAILURE;
+        }
+
+        $message = sprintf('Analysing %d *.json files', count($jsonFileInfos));
+        $this->symfonyStyle->note($message);
+
+        // convert file infos from uggly json to pretty json
+        foreach ($jsonFileInfos as $jsonFileInfo) {
+            $jsonContent = FileSystem::read($jsonFileInfo->getRealPath());
+            $prettyJsonContent = Json::encode(Json::decode($jsonContent), JSON_PRETTY_PRINT);
+
+            // nothing to convert
+            if ($prettyJsonContent === $jsonContent) {
+                $this->symfonyStyle->writeln(sprintf('The "%s" file is already pretty', $jsonFileInfo->getRealPath()));
+                continue;
+            }
+
+            // notify the file was changed
+            $this->symfonyStyle->writeln(
+                sprintf('The "%s" file was changed to pretty json', $jsonFileInfo->getRealPath())
+            );
+            FileSystem::write($jsonFileInfo->getRealPath(), $prettyJsonContent);
+        }
+
+        return self::SUCCESS;
+    }
+}
diff --git a/src/DependencyInjection/ContainerFactory.php b/src/DependencyInjection/ContainerFactory.php
@@ -13,6 +13,7 @@
 use Rector\SwissKnife\Command\FinalizeClassesCommand;
 use Rector\SwissKnife\Command\FindMultiClassesCommand;
 use Rector\SwissKnife\Command\NamespaceToPSR4Command;
+use Rector\SwissKnife\Command\PrettyJsonCommand;
 use Rector\SwissKnife\Command\ValidateFileLengthCommand;
 use Rector\SwissKnife\Testing\Command\DetectUnitTestsCommand;
 use Symfony\Component\Console\Application;
@@ -34,6 +35,7 @@ public function create(): Container
             $application = new Application('Easy CI toolkit');
 
             $commands = [
+                $container->make(PrettyJsonCommand::class),
                 $container->make(CheckCommentedCodeCommand::class),
                 $container->make(CheckConflictsCommand::class),
                 $container->make(ValidateFileLengthCommand::class),

diff --git a/src/Finder/FilesFinder.php b/src/Finder/FilesFinder.php
@@ -48,4 +48,34 @@ public static function findPhpFiles(array $sources): array
 
         return iterator_to_array($finder->getIterator());
     }
+
+    /**
+     * @param string[] $sources
+     * @return SplFileInfo[]
+     */
+    public static function findJsonFiles(array $sources): array
+    {
+        $jsonFileInfos = [];
+        $directories = [];
+
+        foreach ($sources as $source) {
+            if (is_file($source)) {
+                $jsonFileInfos[] = new SplFileInfo($source, '', $source);
+            } else {
+                $directories[] = $source;
+            }
+        }
+
+        $jsonFileFinder = Finder::create()
+            ->files()
+            ->in($directories)
+            ->name('*.json')
+            ->sortByName();
+
+        foreach ($jsonFileFinder->getIterator() as $fileInfo) {
+            $jsonFileInfos[] = $fileInfo;
+        }
+
+        return $jsonFileInfos;
+    }
 }
diff --git a/tests/NeedsFinalizeAnalyzer/NeedsFinalizeAnalyzerTest.php b/tests/NeedsFinalizeAnalyzer/NeedsFinalizeAnalyzerTest.php
@@ -18,9 +18,7 @@ protected function setUp(): void
         parent::setUp();
 
         $this->needsFinalizeAnalyzer = new NeedsFinalizeAnalyzer(
-            excludedClasses: [
-                'Rector\SwissKnife\Tests\NeedsFinalizeAnalyzer\Fixture\ExcludedClass',
-            ],
+            excludedClasses: ['Rector\SwissKnife\Tests\NeedsFinalizeAnalyzer\Fixture\ExcludedClass'],
             cachedPhpParser: $this->make(CachedPhpParser::class),
         );
     }

diff --git a/tests/ParentClassResolver/ParentClassResolverTest.php b/tests/ParentClassResolver/ParentClassResolverTest.php
@@ -21,8 +21,11 @@ protected function setUp(): void
 
     public function test(): void
     {
-        $parentClasses = $this->parentClassResolver->resolve(PhpFilesFinder::find([__DIR__ . '/Fixture']), static function (): void {
-        });
+        $parentClasses = $this->parentClassResolver->resolve(
+            PhpFilesFinder::find([__DIR__ . '/Fixture']),
+            static function (): void {
+            }
+        );
 
         $this->assertSame(
             [