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

Author: Piotr Makowski

CodeSniffer.php

@@ -379,6 +379,22 @@ public function setInteractive($interactive)
     }//end setInteractive()
 
 
+    /**
+     * Sets the interactive flag.
+     *
+     * @param string $path During interactive session will use this to open invalid files.
+     *
+     * @return void
+     */
+    public function setEditorPath($path)
+    {
+        if (defined('PHP_CODESNIFFER_EDITOR_PATH') === false) {
+            define('PHP_CODESNIFFER_EDITOR_PATH', $path);
+        }
+
+    }//end setEditorPath()
+
+
     /**
      * Sets an array of file extensions that we will allow checking of.
      *
@@ -1780,7 +1796,11 @@ public function processFile($file, $contents=null)
             $reportData  = $this->reporting->prepareFileReport($phpcsFile);
             $reportClass->generateFileReport($reportData, $phpcsFile, $cliValues['showSources'], $cliValues['reportWidth']);
 
-            echo '<ENTER> to recheck, [s] to skip or [q] to quit : ';
+            if (empty(PHP_CODESNIFFER_EDITOR_PATH)) {
+                echo '<ENTER> to recheck, [s] to skip or [q] to quit : ';
+            } else {
+                echo '<ENTER> to recheck, [s] to skip, [o] to open in editor or [q] to quit : ';
+            }
             $input = fgets(STDIN);
             $input = trim($input);
 
@@ -1790,6 +1810,11 @@ public function processFile($file, $contents=null)
             case 'q':
                 exit(0);
                 break;
+            case 'o':
+                if (false == empty(PHP_CODESNIFFER_EDITOR_PATH)) {
+                    exec(PHP_CODESNIFFER_EDITOR_PATH.' '.$file);
+                }
+                break;
             default:
                 // Repopulate the sniffs because some of them save their state
                 // and only clear it when the file changes, but we are rechecking

CodeSniffer/CLI.php

@@ -286,6 +286,7 @@ public function getDefaults()
         $defaults['errorSeverity']   = null;
         $defaults['warningSeverity'] = null;
         $defaults['stdin']           = null;
+        $defaults['editorPath']      = null;
 
         $reportFormat = PHP_CodeSniffer::getConfigData('report_format');
         if ($reportFormat !== null) {
@@ -722,6 +723,17 @@ public function processLongArgument($arg, $pos)
                 $this->values['errorSeverity'] = (int) substr($arg, 15);
             } else if (substr($arg, 0, 17) === 'warning-severity=') {
                 $this->values['warningSeverity'] = (int) substr($arg, 17);
+            } else if (substr($arg, 0, 12) === 'editor-path=') {
+                $value = substr($arg, 12);
+                if (preg_match('/^[\'\"]/', $value, $matches)) {
+                    while (0 === preg_match("/[{$matches[0]}]$/", $value)) {
+                        $value .= ' '.$this->_cliArgs[++$pos];
+                        $this->_cliArgs[$pos] = '';
+                    }
+                    $value = substr($value, 1, -1);
+                }
+                
+                $this->values['editorPath'] = $value;
             } else if (substr($arg, 0, 7) === 'ignore=') {
                 // Split the ignore string on commas, unless the comma is escaped
                 // using 1 or 3 slashes (\, or \\\,).
@@ -865,6 +877,7 @@ public function process($values=array())
         $phpcs->setTabWidth($values['tabWidth']);
         $phpcs->setEncoding($values['encoding']);
         $phpcs->setInteractive($values['interactive']);
+        $phpcs->setEditorPath($values['editorPath']);
 
         // Set file extensions if they were specified. Otherwise,
         // let PHP_CodeSniffer decide on the defaults.
@@ -1205,7 +1218,7 @@ public function printUsage()
      */
     public function printPHPCSUsage()
     {
-        echo 'Usage: phpcs [-nwlsaepvi] [-d key[=value]] [--colors] [--no-colors]'.PHP_EOL;
+        echo 'Usage: phpcs [-nwlsaepvi] [-d key[=value]] [--colors] [--no-colors] [--editor-path=<path>]'.PHP_EOL;
         echo '    [--report=<report>] [--report-file=<reportFile>] [--report-<report>=<reportFile>] ...'.PHP_EOL;
         echo '    [--report-width=<reportWidth>] [--generator=<generator>] [--tab-width=<tabWidth>]'.PHP_EOL;
         echo '    [--severity=<severity>] [--error-severity=<severity>] [--warning-severity=<severity>]'.PHP_EOL;