[PMakowski] squizlabs#2.5.1.x-dev: Adding option to define editor path and open files in that during interactive session

Author: Piotr Makowski

src/Config.php

@@ -115,6 +115,7 @@ class Config
         'tabWidth'        => null,
         'encoding'        => null,
         'extensions'      => null,
+        'editorPath'      => null,
         'sniffs'          => null,
         'exclude'         => null,
         'ignored'         => null,
@@ -485,6 +486,7 @@ public function restoreDefaults()
         $this->reportFile      = null;
         $this->generator       = null;
         $this->filter          = null;
+        $this->editorPath      = null;
         $this->bootstrap       = [];
         $this->basepath        = null;
         $this->reports         = ['full' => null];
@@ -503,6 +505,11 @@ public function restoreDefaults()
             $this->standards = explode(',', $standard);
         }
 
+        $editorPath = self::getConfigData('editorPath');
+        if ($editorPath !== null) {
+            $this->editorPath = $editorPath;
+        }
+
         $reportFormat = self::getConfigData('report_format');
         if ($reportFormat !== null) {
             $this->reports = [$reportFormat => null];
@@ -839,6 +846,9 @@ public function processLongArgument($arg, $pos)
 
                 $this->sniffs = $sniffs;
                 self::$overriddenDefaults['sniffs'] = true;
+            } else if (substr($arg, 0, 12) === 'editor-path=') {
+                $this->editorPath = substr($arg, 12);
+                self::$overriddenDefaults['editorPath'] = true;
             } else if (substr($arg, 0, 8) === 'exclude=') {
                 if (isset(self::$overriddenDefaults['exclude']) === true) {
                     break;
@@ -1361,7 +1371,7 @@ public function printPHPCSUsage()
         echo '  [--report-width=<reportWidth>] [--basepath=<basepath>] [--bootstrap=<bootstrap>]'.PHP_EOL;
         echo '  [--severity=<severity>] [--error-severity=<severity>] [--warning-severity=<severity>]'.PHP_EOL;
         echo '  [--runtime-set key value] [--config-set key value] [--config-delete key] [--config-show]'.PHP_EOL;
-        echo '  [--standard=<standard>] [--sniffs=<sniffs>] [--exclude=<sniffs>]'.PHP_EOL;
+        echo '  [--standard=<standard>] [--sniffs=<sniffs>] [--exclude=<sniffs>] [--editor-path=<path>]'.PHP_EOL;
         echo '  [--encoding=<encoding>] [--parallel=<processes>] [--generator=<generator>]'.PHP_EOL;
         echo '  [--extensions=<extensions>] [--ignore=<patterns>] [--ignore-annotations]'.PHP_EOL;
         echo '  [--stdin-path=<stdinPath>] [--file-list=<fileList>] <file> - ...'.PHP_EOL;

src/Runner.php

@@ -627,7 +627,7 @@ public function processFile($file)
 
                 $this->reporter->printReport('full');
 
-                echo '<ENTER> to recheck, [s] to skip or [q] to quit : ';
+                echo '<ENTER> to recheck, [s] to skip'.($this->config->editorPath ? ', [o] to open in editor' : null).' or [q] to quit : ';
                 $input = fgets(STDIN);
                 $input = trim($input);
 
@@ -636,6 +636,10 @@ public function processFile($file)
                     break(2);
                 case 'q':
                     throw new DeepExitException('', 0);
+                case 'o':
+                    if ($this->config->editorPath) {
+                        exec($this->config->editorPath.' '.$file->path);
+                    }
                 default:
                     // Repopulate the sniffs because some of them save their state
                     // and only clear it when the file changes, but we are rechecking