Reports are now able to get a count of fixable errors so they can disaply that count. Sniffs call a different function to add errors and warnings to indiciate that they are fixable.

Author: gsherwood

CodeSniffer/File.php

@@ -224,6 +224,13 @@ class PHP_CodeSniffer_File
      */
     private $_warningCount = 0;
 
+    /**
+     * The total number of errors/warnings that can be fixed.
+     *
+     * @var int
+     */
+    private $_fixableCount = 0;
+
     /**
      * An array of sniffs listening to this file's processing.
      *
@@ -407,6 +414,7 @@ public function start($contents=null)
         $this->_warnings     = array();
         $this->_errorCount   = 0;
         $this->_warningCount = 0;
+        $this->_fixableCount = 0;
 
         $this->_parse($contents);
         $this->fixer->startFile($this);
@@ -435,6 +443,7 @@ public function start($contents=null)
                     $this->_warnings     = array();
                     $this->_errorCount   = 0;
                     $this->_warningCount = 0;
+                    $this->_fixableCount = 0;
                     return;
                 } else if (strpos($token['content'], '@codingStandardsChangeSetting') !== false) {
                     $start         = strpos($token['content'], '@codingStandardsChangeSetting');
@@ -722,17 +731,24 @@ public static function detectLineEndings($file, $contents=null)
     /**
      * Adds an error to the error stack.
      *
-     * @param string $error    The error message.
-     * @param int    $stackPtr The stack position where the error occurred.
-     * @param string $code     A violation code unique to the sniff message.
-     * @param array  $data     Replacements for the error message.
-     * @param int    $severity The severity level for this error. A value of 0
-     *                         will be converted into the default severity level.
+     * @param string  $error    The error message.
+     * @param int     $stackPtr The stack position where the error occurred.
+     * @param string  $code     A violation code unique to the sniff message.
+     * @param array   $data     Replacements for the error message.
+     * @param int     $severity The severity level for this error. A value of 0
+     *                          will be converted into the default severity level.
+     * @param boolean $fixable  Can the error be fixed by the sniff?
      *
      * @return void
      */
-    public function addError($error, $stackPtr, $code='', $data=array(), $severity=0)
-    {
+    public function addError(
+        $error,
+        $stackPtr,
+        $code='',
+        $data=array(),
+        $severity=0,
+        $fixable=false
+    ) {
         // Don't bother doing any processing if errors are just going to
         // be hidden in the reports anyway.
         if ($this->phpcs->cli->errorSeverity === 0) {
@@ -804,6 +820,10 @@ public function addError($error, $stackPtr, $code='', $data=array(), $severity=0
         }
 
         $this->_errorCount++;
+        if ($fixable === true) {
+            $this->_fixableCount++;
+        }
+
         if ($this->_recordErrors === false) {
             if (isset($this->_errors[$lineNum]) === false) {
                 $this->_errors[$lineNum] = 0;
@@ -835,6 +855,7 @@ public function addError($error, $stackPtr, $code='', $data=array(), $severity=0
                                                'message'  => $message,
                                                'source'   => $sniff,
                                                'severity' => $severity,
+                                               'fixable'  => $fixable,
                                               );
 
     }//end addError()
@@ -843,17 +864,24 @@ public function addError($error, $stackPtr, $code='', $data=array(), $severity=0
     /**
      * Adds an warning to the warning stack.
      *
-     * @param string $warning  The error message.
-     * @param int    $stackPtr The stack position where the error occurred.
-     * @param string $code     A violation code unique to the sniff message.
-     * @param array  $data     Replacements for the warning message.
-     * @param int    $severity The severity level for this warning. A value of 0
-     *                         will be converted into the default severity level.
+     * @param string  $warning  The error message.
+     * @param int     $stackPtr The stack position where the error occurred.
+     * @param string  $code     A violation code unique to the sniff message.
+     * @param array   $data     Replacements for the warning message.
+     * @param int     $severity The severity level for this warning. A value of 0
+     *                          will be converted into the default severity level.
+     * @param boolean $fixable  Can the warning be fixed by the sniff?
      *
      * @return void
      */
-    public function addWarning($warning, $stackPtr, $code='', $data=array(), $severity=0)
-    {
+    public function addWarning(
+        $warning,
+        $stackPtr,
+        $code='',
+        $data=array(),
+        $severity=0,
+        $fixable=false
+    ) {
         // Don't bother doing any processing if warnings are just going to
         // be hidden in the reports anyway.
         if ($this->phpcs->cli->warningSeverity === 0) {
@@ -925,6 +953,10 @@ public function addWarning($warning, $stackPtr, $code='', $data=array(), $severi
         }
 
         $this->_warningCount++;
+        if ($fixable === true) {
+            $this->_fixableCount++;
+        }
+
         if ($this->_recordErrors === false) {
             if (isset($this->_warnings[$lineNum]) === false) {
                 $this->_warnings[$lineNum] = 0;
@@ -956,11 +988,61 @@ public function addWarning($warning, $stackPtr, $code='', $data=array(), $severi
                                                  'message'  => $message,
                                                  'source'   => $sniff,
                                                  'severity' => $severity,
+                                                 'fixable'  => $fixable,
                                                 );
 
     }//end addWarning()
 
 
+    /**
+     * Adds a fixable error to the error stack.
+     *
+     * @param string  $error    The error message.
+     * @param int     $stackPtr The stack position where the error occurred.
+     * @param string  $code     A violation code unique to the sniff message.
+     * @param array   $data     Replacements for the error message.
+     * @param int     $severity The severity level for this error. A value of 0
+     *                          will be converted into the default severity level.
+     *
+     * @return void
+     */
+    public function addFixableError(
+        $error,
+        $stackPtr,
+        $code='',
+        $data=array(),
+        $severity=0
+    ) {
+        $this->addError($error, $stackPtr, $code, $data, $severity, true);
+
+    }//end addFixableError()
+
+
+    /**
+     * Adds a fixable warning to the warning stack.
+     *
+     * @param string  $warning  The error message.
+     * @param int     $stackPtr The stack position where the error occurred.
+     * @param string  $code     A violation code unique to the sniff message.
+     * @param array   $data     Replacements for the warning message.
+     * @param int     $severity The severity level for this warning. A value of 0
+     *                          will be converted into the default severity level.
+     * @param boolean $fixable  Can the warning be fixed by the sniff?
+     *
+     * @return void
+     */
+    public function addFixableWarning(
+        $warning,
+        $stackPtr,
+        $code='',
+        $data=array(),
+        $severity=0
+    ) {
+        $this->addWarning($warning, $stackPtr, $code, $data, $severity, true);
+
+    }//end addFixableWarning()
+
+
     /**
      * Returns the number of errors raised.
      *
@@ -985,6 +1067,18 @@ public function getWarningCount()
     }//end getWarningCount()
 
 
+    /**
+     * Returns the number of fixable errors/warnings raised.
+     *
+     * @return int
+     */
+    public function getFixableCount()
+    {
+        return $this->_fixableCount;
+
+    }//end getFixableCount()
+
+
     /**
      * Returns the list of ignored lines.
      *

CodeSniffer/Fixer.php

@@ -81,7 +81,11 @@ public function replaceToken($stackPtr, $content)
             return;
         }
 
-        #echo "replace token $stackPtr with \"$content\"\n";
+        #$bt    = debug_backtrace();
+        #$sniff = $bt[1]['class'];
+        #$line  = $bt[0]['line'];
+        #echo "$sniff (line $line): replace token $stackPtr with \"$content\"\n";
+
         $this->_tokens[$stackPtr] = $content;
         $this->_numFixes++;
         $this->_fixedTokens[] = $stackPtr;

CodeSniffer/Report.php

@@ -61,6 +61,7 @@ public function generateFileReport(
      * @param int     $totalFiles    Total number of files processed during the run.
      * @param int     $totalErrors   Total number of errors found during the run.
      * @param int     $totalWarnings Total number of warnings found during the run.
+     * @param int     $totalFixable  Total number of problems that can be fixed.
      * @param boolean $showSources   Show sources?
      * @param int     $width         Maximum allowed line width.
      * @param boolean $toScreen      Is the report being printed to screen?
@@ -72,6 +73,7 @@ public function generate(
         $totalFiles,
         $totalErrors,
         $totalWarnings,
+        $totalFixable,
         $showSources=false,
         $width=80,
         $toScreen=true

CodeSniffer/Reporting.php

@@ -57,6 +57,13 @@ class PHP_CodeSniffer_Reporting
      */
     public $totalWarnings = 0;
 
+    /**
+     * Total number of errors/warnings that can be fixed.
+     *
+     * @var int
+     */
+    public $totalFixable = 0;
+
     /**
      * A list of reports that have written partial report output.
      *
@@ -158,6 +165,7 @@ public function cacheFileReport(PHP_CodeSniffer_File $phpcsFile, array $cliValue
             $this->totalFiles++;
             $this->totalErrors   += $reportData['errors'];
             $this->totalWarnings += $reportData['warnings'];
+            $this->totalFixable  += $reportData['fixable'];
         }
 
     }//end cacheFileReport()
@@ -206,6 +214,7 @@ public function printReport(
             $this->totalFiles,
             $this->totalErrors,
             $this->totalWarnings,
+            $this->totalFixable,
             $showSources,
             $reportWidth,
             $toScreen
@@ -244,6 +253,7 @@ public function prepareFileReport(PHP_CodeSniffer_File $phpcsFile)
                    'filename' => $phpcsFile->getFilename(),
                    'errors'   => $phpcsFile->getErrorCount(),
                    'warnings' => $phpcsFile->getWarningCount(),
+                   'fixable'  => $phpcsFile->getFixableCount(),
                    'messages' => array(),
                   );
 
@@ -263,9 +273,10 @@ public function prepareFileReport(PHP_CodeSniffer_File $phpcsFile)
                                     'message'  => $data['message'],
                                     'source'   => $data['source'],
                                     'severity' => $data['severity'],
+                                    'fixable'  => $data['fixable'],
                                     'type'     => 'ERROR',
                                    );
-                }
+                }//end foreach
 
                 $errors[$line][$column] = $newErrors;
             }//end foreach
@@ -281,9 +292,10 @@ public function prepareFileReport(PHP_CodeSniffer_File $phpcsFile)
                                       'message'  => $data['message'],
                                       'source'   => $data['source'],
                                       'severity' => $data['severity'],
+                                      'fixable'  => $data['fixable'],
                                       'type'     => 'WARNING',
                                      );
-                }
+                }//end foreach
 
                 if (isset($errors[$line]) === false) {
                     $errors[$line] = array();

CodeSniffer/Reports/Checkstyle.php

@@ -100,6 +100,7 @@ public function generateFileReport(
      * @param int     $totalFiles    Total number of files processed during the run.
      * @param int     $totalErrors   Total number of errors found during the run.
      * @param int     $totalWarnings Total number of warnings found during the run.
+     * @param int     $totalFixable  Total number of problems that can be fixed.
      * @param boolean $showSources   Show sources?
      * @param int     $width         Maximum allowed line width.
      * @param boolean $toScreen      Is the report being printed to screen?
@@ -111,6 +112,7 @@ public function generate(
         $totalFiles,
         $totalErrors,
         $totalWarnings,
+        $totalFixable,
         $showSources=false,
         $width=80,
         $toScreen=true

CodeSniffer/Reports/Csv.php

@@ -66,7 +66,8 @@ public function generateFileReport(
                     $type     = strtolower($error['type']);
                     $source   = $error['source'];
                     $severity = $error['severity'];
-                    echo "\"$filename\",$line,$column,$type,\"$message\",$source,$severity".PHP_EOL;
+                    $fixable  = (int) $error['fixable'];
+                    echo "\"$filename\",$line,$column,$type,\"$message\",$source,$severity,$fixable".PHP_EOL;
                 }
             }
         }
@@ -84,6 +85,7 @@ public function generateFileReport(
      * @param int     $totalFiles    Total number of files processed during the run.
      * @param int     $totalErrors   Total number of errors found during the run.
      * @param int     $totalWarnings Total number of warnings found during the run.
+     * @param int     $totalFixable  Total number of problems that can be fixed.
      * @param boolean $showSources   Show sources?
      * @param int     $width         Maximum allowed line width.
      * @param boolean $toScreen      Is the report being printed to screen?
@@ -95,11 +97,12 @@ public function generate(
         $totalFiles,
         $totalErrors,
         $totalWarnings,
+        $totalFixable,
         $showSources=false,
         $width=80,
         $toScreen=true
     ) {
-        echo 'File,Line,Column,Type,Message,Source,Severity'.PHP_EOL;
+        echo 'File,Line,Column,Type,Message,Source,Severity,Fixable'.PHP_EOL;
         echo $cachedData;
 
     }//end generate()

CodeSniffer/Reports/Diff.php

@@ -78,6 +78,7 @@ public function generateFileReport(
      * @param int     $totalFiles    Total number of files processed during the run.
      * @param int     $totalErrors   Total number of errors found during the run.
      * @param int     $totalWarnings Total number of warnings found during the run.
+     * @param int     $totalFixable  Total number of problems that can be fixed.
      * @param boolean $showSources   Show sources?
      * @param int     $width         Maximum allowed line width.
      * @param boolean $toScreen      Is the report being printed to screen?
@@ -89,6 +90,7 @@ public function generate(
         $totalFiles,
         $totalErrors,
         $totalWarnings,
+        $totalFixable,
         $showSources=false,
         $width=80,
         $toScreen=true

CodeSniffer/Reports/Emacs.php

@@ -85,6 +85,7 @@ public function generateFileReport(
      * @param int     $totalFiles    Total number of files processed during the run.
      * @param int     $totalErrors   Total number of errors found during the run.
      * @param int     $totalWarnings Total number of warnings found during the run.
+     * @param int     $totalFixable  Total number of problems that can be fixed.
      * @param boolean $showSources   Show sources?
      * @param int     $width         Maximum allowed line width.
      * @param boolean $toScreen      Is the report being printed to screen?
@@ -96,6 +97,7 @@ public function generate(
         $totalFiles,
         $totalErrors,
         $totalWarnings,
+        $totalFixable,
         $showSources=false,
         $width=80,
         $toScreen=true