Further improve the output of the phpcs-diff script. Also make the log messages more verbose.

Author: zaantar

bin/phpcs-diff

@@ -140,9 +140,11 @@ try {
 }
 
 
-function render_line( $filename, $line, $column, $message, $source ) {
+function render_line( $filename, $line, $column, $message, $source, $issue_number ) {
 	global $colour_primary, $colour_secondary;
-    return OUTPUT_BOLD . $colour_primary . "* " . $filename . ":" . $line . ':' . $column . OUTPUT_UNBOLD . PHP_EOL
+    return OUTPUT_BOLD . $colour_primary . "* "
+        . $colour_secondary . OUTPUT_REVERSE . $issue_number . OUTPUT_UNREVERSE . " "
+	    . $colour_primary . $filename . ":" . $line . ':' . $column . OUTPUT_UNBOLD . PHP_EOL
         . "\t" . $source . ": " . PHP_EOL
         . "\t" . $colour_secondary . $message . OUTPUT_RESET;
 }
@@ -151,14 +153,14 @@ $blockers = $warnings = $notes = [];
 foreach ( $found_issues as $filename => $issues ) {
 	foreach ( $issues as $line => $line_issues ) {
 		foreach( $line_issues as $issue ) {
-		    $output = render_line( $filename, $line, $issue['column'],  $issue['message'], $issue['source'] );
+		    $line_args = [ $filename, $line, $issue['column'],  $issue['message'], $issue['source'] ];
 
 			if ( 'ERROR' === $issue['level'] ) {
-				$blockers[] = $output;
+				$blockers[] = $line_args;
 			} else if ( 'WARNING' === $issue['level'] ) {
-				$warnings[] = $output;
+				$warnings[] = $line_args;
 			} else if ( 'NOTE' === $issue['level'] ) {
-				$notes[] = $output;
+				$notes[] = $line_args;
 			}
 		}
 	}
@@ -172,8 +174,11 @@ function echo_chapter( $title, $items ) {
     }
 
 	echo OUTPUT_REVERSE . OUTPUT_BOLD . $colour_primary . "### " . $title . OUTPUT_RESET . PHP_EOL . PHP_EOL;
-	foreach ( $items as $item ) {
-		echo $item . PHP_EOL;
+
+	$issue_number = 1;
+	foreach ( $items as $line_args ) {
+	    $line_args[] = $issue_number++;
+		echo call_user_func_array( '\PHPCSDiff\render_line', $line_args ) . PHP_EOL;
 	}
 
 	echo PHP_EOL;
@@ -201,4 +206,4 @@ if( 'blockers' === $tolerance ) {
     }
 }
 
-exit(1);
+exit(1);

inc/Main.php

@@ -95,13 +95,25 @@ public function run( $oldest_rev, $newest_rev, $directory = '' ) {
 
 		$diff_info	  = $this->version_control->parse_diff_for_info( $diff );
 		$file_diffs   = $diff_info['file_diffs'];
+		$total_changed_file_count = count( $file_diffs );
+		$this->log->log( LoggerInterface::INFO, sprintf( 'Retrieved diffs for %d changed files.', $total_changed_file_count ) );
 
 		$found_issues = array();
 		$found_issues_count = 0;
+		$current_file_number = 1;
 		foreach( $file_diffs as $filename => $file_info ) {
+
+			$this->log->log( LoggerInterface::INFO, sprintf(
+				'Processing file %d of %d: %s...',
+				$current_file_number++,
+				$total_changed_file_count,
+				$filename
+			) );
+
 			$line_mapping = new LineMapping();
 			$line_mapping->count_lines( $file_info['lines'] );
 			if ( ! $line_mapping->has_actionable_changes() ) {
+				$this->log->log( LoggerInterface::INFO, 'No actionable changes found.' );
 				continue;
 			}
 
@@ -116,6 +128,9 @@ public function run( $oldest_rev, $newest_rev, $directory = '' ) {
 			}
 			$found_issues[ $filename ] = $processed_file;
 			$found_issues_count += count( $processed_file );
+			$this->log->log( LoggerInterface::INFO, sprintf(
+				'Found %d issues in the changed code.', count( $processed_file )
+			) );
 		}
 
 		return $found_issues;