Add initial PHPStan configuration

bin/run-phpstan-tests

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+# Run the code style check only if a configuration file exists.
+if [ -f "phpstan.dist.neon" ] || [ -f "phpstan.neon.dist" ] || [ -f "phpstan.neon" ]
+then
+	vendor/bin/phpstan --memory-limit=2048M analyse "$@"
+fi

composer.json

@@ -15,6 +15,9 @@
         "php-parallel-lint/php-console-highlighter": "^1.0",
         "php-parallel-lint/php-parallel-lint": "^1.3.1",
         "phpcompatibility/php-compatibility": "dev-develop",
+        "phpstan/extension-installer": "^1.4.3",
+        "phpstan/phpstan": "^1.12.26",
+        "szepeviktor/phpstan-wordpress": "^v1.3.5",
         "wp-cli/config-command": "^1 || ^2",
         "wp-cli/core-command": "^1 || ^2",
         "wp-cli/eval-command": "^1 || ^2",
@@ -28,7 +31,8 @@
     "config": {
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true,
-            "johnpbloch/wordpress-core-installer": true
+            "johnpbloch/wordpress-core-installer": true,
+            "phpstan/extension-installer": true
         },
         "sort-packages": true,
         "lock": false
@@ -63,19 +67,22 @@
         "bin/run-linter-tests",
         "bin/run-php-unit-tests",
         "bin/run-phpcs-tests",
-        "bin/run-phpcbf-cleanup"
+        "bin/run-phpcbf-cleanup",
+        "bin/run-phpstan-tests"
     ],
     "scripts": {
         "behat": "run-behat-tests",
         "behat-rerun": "rerun-behat-tests",
         "lint": "run-linter-tests",
         "phpcs": "run-phpcs-tests",
         "phpcbf": "run-phpcbf-cleanup",
+        "phpstan": "run-phpstan-tests",
         "phpunit": "run-php-unit-tests",
         "prepare-tests": "install-package-tests",
         "test": [
             "@lint",
             "@phpcs",
+            "@phpstan",
             "@phpunit",
             "@behat"
         ]

phpcs.xml.dist

@@ -59,6 +59,8 @@
 	#############################################################################
 	-->
 
+	<exclude-pattern>tests/phpstan/scan-files.php</exclude-pattern>
+
 	<!-- This is a procedural stand-alone file that is never loaded in a WordPress context,
 		 so this file does not have to comply with WP naming conventions. -->
 	<rule ref="WordPress.NamingConventions.PrefixAllGlobals">

phpstan.neon.dist

@@ -0,0 +1,19 @@
+parameters:
+  level: 5
+  paths:
+    - src
+    - tests
+  scanDirectories:
+    - vendor/wp-cli/wp-cli
+    - vendor/phpunit/php-code-coverage
+    - vendor/behat/behat
+  scanFiles:
+    - tests/phpstan/scan-files.php
+  treatPhpDocTypesAsCertain: false
+  dynamicConstantNames:
+  	- WP_DEBUG
+  	- WP_DEBUG_LOG
+  	- WP_DEBUG_DISPLAY
+  ignoreErrors:
+    # Needs fixing in WP-CLI.
+    - message: '#Parameter \#1 \$cmd of function WP_CLI\\Utils\\esc_cmd expects array<string>#'

src/Context/FeatureContext.php

@@ -1179,14 +1179,11 @@
 			'skip-email'     => true,
 		];
 
-		$run_dir            = '' !== $subdir ? ( $this->variables['RUN_DIR'] . "/$subdir" ) : $this->variables['RUN_DIR'];
-		$install_cache_path = '';
+		$run_dir = '' !== $subdir ? ( $this->variables['RUN_DIR'] . "/$subdir" ) : $this->variables['RUN_DIR'];
 
-		if ( self::$install_cache_dir ) {
-			$install_cache_path = self::$install_cache_dir . '/install_' . md5( implode( ':', $install_args ) . ':subdir=' . $subdir );
-		}
+		$install_cache_path = self::$install_cache_dir . '/install_' . md5( implode( ':', $install_args ) . ':subdir=' . $subdir );
 
-		if ( $install_cache_path && file_exists( $install_cache_path ) ) {
+		if ( file_exists( $install_cache_path ) ) {
 			self::copy_dir( $install_cache_path, $run_dir );
 
 			// This is the sqlite equivalent of restoring a database dump in MySQL
@@ -1198,26 +1195,24 @@
 		} else {
 			$this->proc( 'wp core install', $install_args, $subdir )->run_check();
 
-			if ( $install_cache_path ) {
-				mkdir( $install_cache_path );
+			mkdir( $install_cache_path );
 
-				self::dir_diff_copy( $run_dir, self::$cache_dir, $install_cache_path );
+			self::dir_diff_copy( $run_dir, self::$cache_dir, $install_cache_path );
 
-				if ( 'sqlite' !== self::$db_type ) {
-					$mysqldump_binary          = Utils\get_sql_dump_command();
-					$mysqldump_binary          = Utils\force_env_on_nix_systems( $mysqldump_binary );
-					$support_column_statistics = exec( "{$mysqldump_binary} --help | grep 'column-statistics'" );
-					$command                   = "{$mysqldump_binary} --no-defaults --no-tablespaces";
-					if ( $support_column_statistics ) {
-						$command .= ' --skip-column-statistics';
-					}
-					self::run_sql( $command, [ 'result-file' => "{$install_cache_path}.sql" ], true /*add_database*/ );
+			if ( 'sqlite' !== self::$db_type ) {
+				$mysqldump_binary          = Utils\get_sql_dump_command();
+				$mysqldump_binary          = Utils\force_env_on_nix_systems( $mysqldump_binary );
+				$support_column_statistics = exec( "{$mysqldump_binary} --help | grep 'column-statistics'" );
+				$command                   = "{$mysqldump_binary} --no-defaults --no-tablespaces";
+				if ( $support_column_statistics ) {
+					$command .= ' --skip-column-statistics';
 				}
+				self::run_sql( $command, [ 'result-file' => "{$install_cache_path}.sql" ], true /*add_database*/ );
+			}
 
-				if ( 'sqlite' === self::$db_type ) {
-					// This is the sqlite equivalent of creating a database dump in MySQL
-					copy( "$run_dir/wp-content/database/.ht.sqlite", "{$install_cache_path}.sqlite" );
-				}
+			if ( 'sqlite' === self::$db_type ) {
+				// This is the sqlite equivalent of creating a database dump in MySQL
+				copy( "$run_dir/wp-content/database/.ht.sqlite", "{$install_cache_path}.sqlite" );
 			}
 		}
 	}
@@ -1557,11 +1552,6 @@
 	$framework_folder = FeatureContext::get_framework_dir();
 	wp_cli_behat_env_debug( "Framework folder location: {$framework_folder}" );
 
-	// Didn't manage to detect a valid framework folder.
-	if ( empty( $vendor_folder ) ) {
-		return;
-	}
-
 	// Load helper functionality that is needed for the tests.
 	require_once "{$framework_folder}/php/utils.php";
 	require_once "{$framework_folder}/php/WP_CLI/Process.php";

src/Context/Support.php

@@ -70,7 +70,7 @@
 				break;
 
 			default:
-				throw new PendingException();
+				throw new \Behat\Behat\Tester\Exception\PendingException();
 		}
 
 		if ( ! $r ) {

src/Context/ThenStepDefinitions.php

@@ -423,6 +423,7 @@
 				}
 				$action   = substr( $action, 0, -1 );
 				$expected = $this->replace_variables( (string) $expected );
+				$contents = '';
 				if ( 'file' === $type ) {
 					$contents = file_get_contents( $path );
 				} elseif ( 'directory' === $type ) {

tests/phpstan/scan-files.php

@@ -0,0 +1,6 @@
+<?php
+
+namespace SebastianBergmann\CodeCoverage\Driver {
+ class Xdebug {
+ }
+}