Implement --no-diffs CLI Option (#195)

easy-coding-standard · Apr 19, 2024 · 1933073 · 1933073
1 parent ca60973
commit 1933073
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 3 deletions.
diff --git a/src/Configuration/ConfigurationFactory.php b/src/Configuration/ConfigurationFactory.php
@@ -24,6 +24,7 @@ public function createFromInput(InputInterface $input): Configuration
         $shouldClearCache = (bool) $input->getOption(Option::CLEAR_CACHE);
         $showProgressBar = $this->canShowProgressBar($input);
         $showErrorTable = ! (bool) $input->getOption(Option::NO_ERROR_TABLE);
+        $showDiffs = ! (bool) $input->getOption(Option::NO_DIFFS);
         $parallelPort = (string) $input->getOption(Option::PARALLEL_PORT);
         $parallelIdentifier = (string) $input->getOption(Option::PARALLEL_IDENTIFIER);
 
@@ -50,7 +51,8 @@ public function createFromInput(InputInterface $input): Configuration
             $config,
             $parallelPort,
             $parallelIdentifier,
-            $memoryLimit
+            $memoryLimit,
+            $showDiffs
         );
     }
 

diff --git a/src/Console/Command/AbstractCheckCommand.php b/src/Console/Command/AbstractCheckCommand.php
@@ -40,6 +40,12 @@ protected function configure(): void
             InputOption::VALUE_NONE,
             'Hide error table. Useful e.g. for fast check of error count.'
         );
+        $this->addOption(
+            Option::NO_DIFFS,
+            null,
+            InputOption::VALUE_NONE,
+            'Hide diffs of changed files. Useful e.g. for nicer CI output.'
+        );
 
         $this->addOption(
             Option::OUTPUT_FORMAT,

diff --git a/src/Console/Output/ConsoleOutputFormatter.php b/src/Console/Output/ConsoleOutputFormatter.php
@@ -30,7 +30,9 @@ public function __construct(
      */
     public function report(ErrorAndDiffResult $errorAndDiffResult, Configuration $configuration): int
     {
-        $this->reportFileDiffs($errorAndDiffResult->getFileDiffs());
+        if ($configuration->shouldShowDiffs()) {
+            $this->reportFileDiffs($errorAndDiffResult->getFileDiffs());
+        }
 
         $this->easyCodingStandardStyle->newLine(1);
 

diff --git a/src/ValueObject/Configuration.php b/src/ValueObject/Configuration.php
@@ -22,7 +22,8 @@ public function __construct(
         private ?string $config = null,
         private string | null $parallelPort = null,
         private string | null $parallelIdentifier = null,
-        private string | null $memoryLimit = null
+        private string | null $memoryLimit = null,
+        private bool $showDiffs = true
     ) {
     }
 
@@ -46,6 +47,11 @@ public function shouldShowErrorTable(): bool
         return $this->showErrorTable;
     }
 
+    public function shouldShowDiffs(): bool
+    {
+        return $this->showDiffs;
+    }
+
     /**
      * @return string[]
      */

diff --git a/src/ValueObject/Option.php b/src/ValueObject/Option.php
@@ -31,6 +31,11 @@ final class Option
      */
     public const OUTPUT_FORMAT = 'output-format';
 
+    /**
+     * @var string
+     */
+    public const NO_DIFFS = 'no-diffs';
+
     /**
      * @api
      * @deprecated Use @see \Symplify\EasyCodingStandard\Config\ECSConfig::skip()