Add a dry run option

Author: meyerbaptiste

composer.json

@@ -16,6 +16,7 @@
     "symfony/finder": "^2.7.0",
     "phpdocumentor/reflection": "^2.0@dev",
     "phpdocumentor/reflection-common": "^1.0@dev",
-    "phpdocumentor/reflection-docblock": "^3.0@dev"
+    "phpdocumentor/reflection-docblock": "^3.0@dev",
+    "sebastian/diff": "^1.3"
   }
 }

composer.lock

@@ -14,6 +14,7 @@
 namespace Dunglas\PhpDocToTypeHint;
 
 use phpDocumentor\Reflection\Php\ProjectFactory;
+use SebastianBergmann\Diff\Differ;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Input\InputArgument;
@@ -29,6 +30,21 @@
  */
 class ConvertCommand extends Command
 {
+    /**
+     * @var Differ
+     */
+    private $differ;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __construct($name = null)
+    {
+        $this->differ = new Differ();
+
+        parent::__construct($name);
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -37,8 +53,9 @@ protected function configure()
         $this
             ->setName('convert')
             ->setDescription('Convert files')
-            ->addOption('exclude', 'e', InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Directories to exclude.', ['vendor'])
-            ->addArgument('input', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Input directories.', ['.'])
+            ->addOption('exclude', 'e', InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Directories to exclude', ['vendor'])
+            ->addOption('dry-run', null, InputOption::VALUE_NONE, 'Displays diff instead of modifying files')
+            ->addArgument('input', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Input directories', ['.'])
         ;
     }
 
@@ -63,17 +80,38 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $converter = new Converter();
 
         $output->writeln('<comment>Running the PHPDoc to Type Hint converter. Brought to you by Kévin Dunglas and Les-Tilleuls.coop.</comment>');
+        $output->writeln('');
 
         $progress = new ProgressBar($output, count($files));
 
+        $changed = [];
         foreach ($project->getFiles() as $file) {
-            file_put_contents($file->getPath(), $converter->convert($project, $file));
+            $old = $file->getSource();
+            $new = $converter->convert($project, $file);
+
+            if ($new !== $old) {
+                if ($input->getOption('dry-run')) {
+                    $changed[] = ['path' => $file->getPath(), 'diff' => $this->differ->diff($old, $new)];
+                } else {
+                    file_put_contents($file->getPath(), $new);
+                }
+            }
+
             $progress->advance();
         }
 
         $progress->finish();
+
+        $output->writeln('');
         $output->writeln('');
 
+        foreach ($changed as $i => $file) {
+            $output->writeln(sprintf('<fg=blue>%d) %s</>', $i + 1, $file['path']));
+            $output->writeln('');
+            $output->writeln($file['diff']);
+            $output->writeln('');
+        }
+
         $output->writeln('<info>Conversion done.</info>');
     }
 }

src/ConvertCommand.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-declare(strict_types=1);
+declare (strict_types = 1);
 
 namespace Dunglas\PhpDocToTypeHint;
 
@@ -309,6 +309,7 @@ private function getDocBlock(Project $project, int $objectType, string $namespac
     private function getNamespace(Fqsen $fqsen): string
     {
         $value = $fqsen->__toString();
+
         return substr($value, 0, strrpos($value, '\\'));
     }