Add wp-cli integration

.vscode/launch.json

@@ -0,0 +1,48 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Listen for Xdebug",
+            "type": "php",
+            "request": "launch",
+            "port": 9003
+        },
+        {
+            "name": "Launch currently open script",
+            "type": "php",
+            "request": "launch",
+            "program": "${file}",
+            "cwd": "${fileDirname}",
+            "port": 0,
+            "runtimeArgs": [
+                "-dxdebug.start_with_request=yes"
+            ],
+            "env": {
+                "XDEBUG_MODE": "debug,develop",
+                "XDEBUG_CONFIG": "client_port=${port}"
+            }
+        },
+        {
+            "name": "Launch Built-in web server",
+            "type": "php",
+            "request": "launch",
+            "runtimeArgs": [
+                "-dxdebug.mode=debug",
+                "-dxdebug.start_with_request=yes",
+                "-S",
+                "localhost:0"
+            ],
+            "program": "",
+            "cwd": "${workspaceRoot}",
+            "port": 9003,
+            "serverReadyAction": {
+                "pattern": "Development Server \\(http://localhost:([0-9]+)\\) started",
+                "uriFormat": "http://localhost:%s",
+                "action": "openExternally"
+            }
+        }
+    ]
+}

README.md

@@ -50,5 +50,23 @@ add_filter( 'tc_skip_development_directories', '__return_true' );
 
 To add more directories to the paths where other files are excluded then add them to the array through the `tc_common_dev_directories` filter.
 
+### Usage with wp-cli
+
+To use with [wp-cli](https://wp-cli.org/), ensure the theme check plugin is active and `wp-cli` is installed. The `theme-check` subcommand is added to `wp-cli` and can be used as follows:
+
+`wp theme-check run [<theme>] [--format=<format>]`
+
+#### Options
+| Option | Accepts | Required | Default
+| -- | -- | -- | -- | 
+| `theme` | The slug of the theme to check | No | Current theme slug
+| `format` | `cli` or `json` | No | `cli`
+
+#### Examples
+`wp theme-check run`
+`wp theme-check run twentytwentyfour`
+`wp theme-check run --format=json`
+`wp theme-check run twentytwentyfour --format=json`
+
 ## Contributors
 Otto42, pross, The theme review team

theme-check.php

@@ -14,6 +14,10 @@ class ThemeCheckMain {
 	function __construct() {
 		add_action( 'admin_init', array( $this, 'tc_i18n' ) );
 		add_action( 'admin_menu', array( $this, 'themecheck_add_page' ) );
+
+		if ( defined( 'WP_CLI' ) && WP_CLI ) {
+			include 'wp-cli/class-theme-check-cli.php';
+		}
 	}
 
 	function tc_i18n() {

wp-cli/class-theme-check-cli.php

@@ -0,0 +1,157 @@
+<?php
+
+if ( defined( 'WP_CLI' ) && WP_CLI ) {
+	$parent_dir = dirname( __DIR__ );
+	require_once $parent_dir . '/checkbase.php';
+	require_once $parent_dir . '/main.php';
+	WP_CLI::add_command( 'theme-check', 'Theme_Check_Command' );
+}
+
+class Theme_Check_Command extends WP_CLI_Command {
+	/**
+	 * Run a theme check on the specified theme or the current theme.
+	 *
+	 * @param array $args       Indexed array of positional arguments.
+	 * @param array $assoc_args Associative array of options.
+	 * @return void
+	 *
+	 * ## OPTIONS
+	 * [<theme>]
+	 * : The slug of the theme to check. If not provided, checks the current theme.
+	 *
+	 * [--format=<format>]
+	 * : Render output in a particular format.
+	 * ---
+	 * default: cli
+	 * options:
+	 *   - cli
+	 *   - json
+	 * ---
+	 *
+	 * ## EXAMPLES
+	 * 	   # Check the current active theme
+	 *     wp theme-check run
+	 * 
+	 *     # Check a specific theme
+	 *     wp theme-check run twentytwentyfour
+	 * 
+	 *     # Check the current active theme and output results as JSON
+	 *     wp theme-check run --format=json
+	 * 
+	 *     # Check a specific theme and output results as JSON
+	 *     wp theme-check run twentytwentyfour --format=json
+	 */
+	public function run( $args, $assoc_args ) {
+		$format = \WP_CLI\Utils\get_flag_value( $assoc_args, 'format', 'cli' );
+
+		// Get the current theme
+		$current_theme      = wp_get_theme();
+		$current_theme_slug = $current_theme->get_stylesheet();
+
+		// Use the provided theme slug if available, otherwise use the current theme
+		$check_theme_slug = ! empty( $args[0] ) ? $args[0] : $current_theme_slug;
+
+		// Get the theme
+		$theme = wp_get_theme( $check_theme_slug );
+
+		if ( ! $theme->exists() ) {
+			if ( $format === 'json' ) {
+				$json_output = array(
+					'completed' => false,
+					'result'          => "Error: Theme '{$check_theme_slug}' not found.",
+					'messages'        => array(),
+				);
+				WP_CLI::line( wp_json_encode( $json_output, JSON_PRETTY_PRINT ) );
+				return;
+			}
+			WP_CLI::error( "Theme '{$check_theme_slug}' not found." );
+		}
+
+		// Run the checks.
+		$success = run_themechecks_against_theme( $theme, $check_theme_slug );
+
+		if ( $format === 'json' ) {
+			if ( ! $success ) {
+				$json_output = array(
+					'completed' => false,
+					'result'          => "Error: Theme check failed for {$check_theme_slug}.",
+					'messages'        => array(),
+				);
+				WP_CLI::line( wp_json_encode( $json_output, JSON_PRETTY_PRINT ) );
+				return;
+			}
+			$this->display_themechecks_as_json( $check_theme_slug );
+		} else {
+			if ( ! $success ) {
+				WP_CLI::error( "Theme check failed for {$check_theme_slug}." );
+			}
+			$this->display_themechecks_in_cli( $check_theme_slug );
+		}
+	}
+
+	/**
+	 * Process theme check messages.
+	 *
+	 * @return array Processed messages.
+	 */
+	private function process_themecheck_messages() {
+		global $themechecks;
+		$messages = array();
+
+		foreach ( $themechecks as $check ) {
+			if ( $check instanceof themecheck ) {
+				$error = $check->getError();
+				$error = (array) $error;
+				if ( ! empty( $error ) ) {
+					$messages = array_merge( $messages, $error );
+				}
+			}
+		}
+
+		$processed_messages = array_map(function($message) {
+			return html_entity_decode( wp_strip_all_tags( $message ), ENT_QUOTES, 'UTF-8' );
+		}, $messages);
+
+		return $processed_messages;
+	}
+
+	/**
+	 * Display the theme checks in the CLI.
+	 *
+	 * @param string $slug The slug of the theme to display the checks for.
+	 * @return void
+	 */
+	private function display_themechecks_in_cli( $slug ) {
+		$processed_messages = $this->process_themecheck_messages();
+
+		WP_CLI::success( "Theme check completed for {$slug}." );
+
+		if ( empty( $processed_messages ) ) {
+			WP_CLI::line( 'No issues found.' );
+			return;
+		}
+
+		foreach ( $processed_messages as $message ) {
+			WP_CLI::line( '' );
+			WP_CLI::line( $message );
+		}
+	}
+
+	/**
+	 * Display the theme checks in JSON format.
+	 *
+	 * @param string $slug The slug of the theme to display the checks for.
+	 * @return void
+	 */
+	private function display_themechecks_as_json( $slug ) {
+		$processed_messages = $this->process_themecheck_messages();
+
+		$json_output = array(
+			'completed' => true,
+			'result'          => "Theme check completed for {$slug}.",
+			'messages'        => $processed_messages,
+		);
+
+		WP_CLI::line( wp_json_encode( $json_output, JSON_PRETTY_PRINT ) );
+	}
+}