New option added: --diff-cached

roger-sei · Oct 8, 2019 · f5ea999 · f5ea999
1 parent b2ff428
commit f5ea999
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 # Changelog
 @author ᏒᏊᏀᏋᏒ ᏕξᏐ
 
+## [0.4.0] - 2019-10-08
+### Added
+- New option added: --diff-cached. An useful option to check for staged git files.
+
+
+#
 ## [0.3.1] - 2019-09-30
 ### Fixed
 - PHPCS path for phar fixed

diff --git a/src/Main.php b/src/Main.php
@@ -311,6 +311,8 @@ public function run(array $options = null): void
         if ($this->errorFound === true) {
             echo PHP_EOL;
             exit(1);
+        } else {
+            exit(0);
         }
     }
 
@@ -387,6 +389,10 @@ private function validateOptions(): void
             $this->options['type'] = 'diff';
         }
 
+        if (isset($this->options['diff-cached']) === true) {
+            $this->options['type'] = 'diff --cached';
+        }
+
         if (isset($this->options['warnings']) === true) {
             $this->options['warnings'] = '--warning-severity=5';
         } else {
@@ -436,10 +442,10 @@ private function validateOptions(): void
                     $error .= "Available commits:\n\n$result";
                     $this->exit($error);
                 }
-            } elseif ($this->options['type'] === 'diff') {
+            } elseif ($this->options['type'] === 'diff' || $this->options['type'] === 'diff --cached') {
                 $this->options['commit'] = ($this->options['commit'] ?? '');
             } else {
-                $this->exit('Invalid value for ``--type``.');
+                $this->exit('Invalid value for --type.');
             }
         } else {
             $this->options['commit'] = ($this->options['commit'] ?? '');

diff --git a/src/Util.php b/src/Util.php
@@ -40,6 +40,7 @@ public function parseArgs(): array
             'all',
             'verbose::',
             'diff',
+            'diff-cached',
             'file:',
             'php::',
             'php-version::',
@@ -69,17 +70,18 @@ public function printUsage(): void
         $options = [
             'standard'    => 'The name or path of the coding standard to use',
             'diff'        => 'Validate changes on the current repository, between commits or branches',
+            'diff-cached' => 'Check changes on staged files, alongside with --diff',
             'all'         => 'Performs a full check and not only the changed lines',
             'repo'        => 'Indicates the git working directory. Defaults to current cwd',
             'phpcs'       => 'Indicates the php binary. Defaults to ENV',
-            'php-version' => 'allows to specify a PHP version to check the code accordingly',
+            'php-version' => 'Checks the code accordingly to a specified PHP version',
             'type'        => 'The type of check. Defaults to "show" changes of a given commit. ',
             'help'        => 'Print this help',
             'verbose'     => 'Prints additional information',
             'warnings'    => 'Also displays warnings',
         ];
         foreach ($options as $name => $description) {
-            echo str_pad("\033[1;31m  --$name ", 22, ' ', STR_PAD_RIGHT) .
+            echo str_pad("\033[1;31m  --$name ", 24, ' ', STR_PAD_RIGHT) .
                 "\033[1;37m" . $description . "\033[0m" . PHP_EOL;
         }