feat: add --format param for core checksums verification

Author: alaminfirdows

src/Checksum_Core_Command.php

@@ -1,5 +1,6 @@
 <?php
 
+use WP_CLI\Formatter;
 use WP_CLI\Utils;
 use WP_CLI\WpOrgApi;
 
@@ -24,6 +25,13 @@ class Checksum_Core_Command extends Checksum_Base_Command {
 	 */
 	private $exclude_files = [];
 
+	/**
+	 * Array of detected errors.
+	 *
+	 * @var array
+	 */
+	private $errors = [];
+
 	/**
 	 * Verifies WordPress files against WordPress.org's checksums.
 	 *
@@ -54,6 +62,18 @@ class Checksum_Core_Command extends Checksum_Base_Command {
 	 * [--exclude=<files>]
 	 * : Exclude specific files from the checksum verification. Provide a comma-separated list of file paths.
 	 *
+	 * [--format=<format>]
+	 * : Render output in a specific format.
+	 * ---
+	 * default: table
+	 * options:
+	 *   - table
+	 *   - json
+	 *   - csv
+	 *   - yaml
+	 *   - count
+	 * ---
+	 *
 	 * ## EXAMPLES
 	 *
 	 *     # Verify checksums
@@ -79,6 +99,10 @@ class Checksum_Core_Command extends Checksum_Base_Command {
 	 *     $ wp core verify-checksums --exclude="readme.html"
 	 *     Success: WordPress installation verifies against checksums.
 	 *
+	 *     # Verify checksums with formatted output
+	 *     $ wp core verify-checksums --format=json
+	 *     Success: WordPress installation verifies against checksums.
+	 *
 	 * @when before_wp_load
 	 */
 	public function __invoke( $args, $assoc_args ) {
@@ -137,14 +161,14 @@ public function __invoke( $args, $assoc_args ) {
 			}
 
 			if ( ! file_exists( ABSPATH . $file ) ) {
-				WP_CLI::warning( "File doesn't exist: {$file}" );
+				$this->add_error( $file, "File doesn't exist" );
 				$has_errors = true;
 				continue;
 			}
 
 			$md5_file = md5_file( ABSPATH . $file );
 			if ( $md5_file !== $checksum ) {
-				WP_CLI::warning( "File doesn't verify against checksum: {$file}" );
+				$this->add_error( $file, "File doesn't verify against checksum" );
 				$has_errors = true;
 			}
 		}
@@ -158,10 +182,18 @@ public function __invoke( $args, $assoc_args ) {
 				if ( in_array( $additional_file, $this->exclude_files, true ) ) {
 					continue;
 				}
-				WP_CLI::warning( "File should not exist: {$additional_file}" );
+				$this->add_error( $additional_file, 'File should not exist' );
 			}
 		}
 
+		if ( ! empty( $this->errors ) ) {
+			$formatter = new Formatter(
+				$assoc_args,
+				array( 'file', 'message' )
+			);
+			$formatter->display_items( $this->errors );
+		}
+
 		if ( ! $has_errors ) {
 			WP_CLI::success( 'WordPress installation verifies against checksums.' );
 		} else {
@@ -203,7 +235,7 @@ private static function get_wp_details() {
 		if ( ! is_readable( $versions_path ) ) {
 			WP_CLI::error(
 				"This does not seem to be a WordPress install.\n" .
-				'Pass --path=`path/to/wordpress` or run `wp core download`.'
+					'Pass --path=`path/to/wordpress` or run `wp core download`.'
 			);
 		}
 
@@ -245,4 +277,16 @@ private static function find_var( $var_name, $code ) {
 
 		return trim( $value, " '" );
 	}
+
+	/**
+	 * Adds a new error to the array of detected errors.
+	 *
+	 * @param string $file    Relative path to the file that had the error.
+	 * @param string $message Message explaining the error.
+	 */
+	private function add_error( $file, $message ) {
+		$error['file']    = $file;
+		$error['message'] = $message;
+		$this->errors[]   = $error;
+	}
 }