PHPStan level 9

Author: swissspidy

composer.json

@@ -22,14 +22,15 @@
     },
     "require-dev": {
         "wp-cli/db-command": "^1.3 || ^2",
-        "wp-cli/wp-cli-tests": "^4.2.8"
+        "wp-cli/wp-cli-tests": "dev-main"
     },
     "config": {
         "process-timeout": 7200,
         "sort-packages": true,
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true,
-            "johnpbloch/wordpress-core-installer": true
+            "johnpbloch/wordpress-core-installer": true,
+            "phpstan/extension-installer": true
         },
         "lock": false
     },
@@ -67,12 +68,14 @@
         "behat-rerun": "rerun-behat-tests",
         "lint": "run-linter-tests",
         "phpcs": "run-phpcs-tests",
+        "phpstan": "run-phpstan-tests",
         "phpcbf": "run-phpcbf-cleanup",
         "phpunit": "run-php-unit-tests",
         "prepare-tests": "install-package-tests",
         "test": [
             "@lint",
             "@phpcs",
+            "@phpstan",
             "@phpunit",
             "@behat"
         ]

phpstan.neon.dist

@@ -0,0 +1,19 @@
+parameters:
+  level: 9
+  paths:
+    - src
+    - config-command.php
+  scanDirectories:
+    - vendor/wp-cli/wp-cli/php
+    - vendor/wp-cli/wp-cli-tests
+  scanFiles:
+    - vendor/php-stubs/wordpress-stubs/wordpress-stubs.php
+  treatPhpDocTypesAsCertain: false
+  dynamicConstantNames:
+  	- WP_DEBUG
+  	- WP_DEBUG_LOG
+  	- WP_DEBUG_DISPLAY
+  ignoreErrors:
+    - identifier: missingType.iterableValue
+    - identifier: missingType.parameter
+    - identifier: missingType.return

src/Config_Command.php

@@ -215,6 +215,11 @@ public function create( $_, $assoc_args ) {
 		if ( ! Utils\get_flag_value( $assoc_args, 'skip-check' ) ) {
 			// phpcs:disable WordPress.DB.RestrictedFunctions
 			$mysql = mysqli_init();
+
+			if ( ! $mysql ) {
+				WP_CLI::error( 'Database connection error. Could not initialize MySQLi.' );
+			}
+
 			mysqli_report( MYSQLI_REPORT_STRICT );
 			try {
 				// Accept similar format to one used by parse_db_host() e.g. 'localhost:/tmp/mysql.sock'
@@ -259,12 +264,6 @@ public function create( $_, $assoc_args ) {
 			}
 		}
 
-		if ( Utils\wp_version_compare( '4.0', '<' ) ) {
-			$assoc_args['add-wplang'] = true;
-		} else {
-			$assoc_args['add-wplang'] = false;
-		}
-
 		foreach ( $assoc_args as $key => $value ) {
 			$assoc_args[ $key ] = $this->escape_config_value( $key, $value );
 		}
@@ -319,7 +318,7 @@ private function config_file_already_exist_error( $wp_config_file_name ) {
 	public function edit( $_, $assoc_args ) {
 		$path                = $this->get_config_path( $assoc_args );
 		$wp_config_file_name = basename( $path );
-		$contents            = file_get_contents( $path );
+		$contents            = (string) file_get_contents( $path );
 		$r                   = Utils\launch_editor_for_input( $contents, $wp_config_file_name, 'php' );
 		if ( false === $r ) {
 			WP_CLI::warning( "No changes made to {$wp_config_file_name}, aborted." );
@@ -415,7 +414,7 @@ public function path() {
 	public function list_( $args, $assoc_args ) {
 		$path                = $this->get_config_path( $assoc_args );
 		$wp_config_file_name = basename( $path );
-		$strict              = Utils\get_flag_value( $assoc_args, 'strict' );
+		$strict              = (bool) Utils\get_flag_value( $assoc_args, 'strict' );
 		if ( $strict && empty( $args ) ) {
 			WP_CLI::error( 'The --strict option can only be used in combination with a filter.' );
 		}
@@ -569,7 +568,9 @@ private static function get_wp_config_vars( $wp_config_path = '' ) {
 			}
 		}
 
-		unset( $wp_config_vars[ $name_backup ] );
+		if ( isset( $name_backup ) ) {
+			unset( $wp_config_vars[ $name_backup ] );
+		}
 		$wp_config_vars           = array_values( $wp_config_vars );
 		$wp_config_includes       = array_diff( get_included_files(), $wp_cli_original_includes );
 		$wp_config_includes_array = [];
@@ -648,7 +649,11 @@ public function set( $args, $assoc_args ) {
 		$path                 = $this->get_config_path( $assoc_args );
 		$wp_config_file_name  = basename( $path );
 		list( $name, $value ) = $args;
-		$type                 = Utils\get_flag_value( $assoc_args, 'type' );
+
+		/**
+		 * @var string $type
+		 */
+		$type = Utils\get_flag_value( $assoc_args, 'type' );
 
 		$options = [];
 
@@ -661,8 +666,14 @@ public function set( $args, $assoc_args ) {
 		];
 
 		foreach ( $option_flags as $option => $default ) {
+			/**
+			 * @var string|null $option_value
+			 */
 			$option_value = Utils\get_flag_value( $assoc_args, $option, $default );
 			if ( null !== $option_value ) {
+				/**
+				 * @var array<string, string> $options
+				 */
 				$options[ $option ] = $option_value;
 				if ( 'separator' === $option ) {
 					$options['separator'] = $this->parse_separator( $options['separator'] );
@@ -752,7 +763,11 @@ public function delete( $args, $assoc_args ) {
 		$path                = $this->get_config_path( $assoc_args );
 		$wp_config_file_name = basename( $path );
 		list( $name )        = $args;
-		$type                = Utils\get_flag_value( $assoc_args, 'type' );
+
+		/**
+		 * @var string $type
+		 */
+		$type = Utils\get_flag_value( $assoc_args, 'type' );
 
 		try {
 			$config_transformer = new WPConfigTransformer( $path );
@@ -819,7 +834,11 @@ public function has( $args, $assoc_args ) {
 		$path                = $this->get_config_path( $assoc_args );
 		$wp_config_file_name = basename( $path );
 		list( $name )        = $args;
-		$type                = Utils\get_flag_value( $assoc_args, 'type' );
+
+		/**
+		 * @var string $type
+		 */
+		$type = Utils\get_flag_value( $assoc_args, 'type' );
 
 		try {
 			$config_transformer = new WPConfigTransformer( $path, true );
@@ -836,6 +855,7 @@ public function has( $args, $assoc_args ) {
 					} else {
 						WP_CLI::halt( 0 );
 					}
+					// @phpstan-ignore deadCode.unreachable
 					break;
 				case 'constant':
 				case 'variable':
@@ -993,7 +1013,7 @@ private static function fetch_remote_salts( $insecure = false ) {
 		}
 
 		// Adapt whitespace to adhere to WPCS.
-		$salts = preg_replace( '/define\(\'(.*?)\'\);/', 'define( \'$1\' );', $salts );
+		$salts = (string) preg_replace( '/define\(\'(.*?)\'\);/', 'define( \'$1\' );', $salts );
 
 		return $salts;
 	}
@@ -1153,7 +1173,11 @@ protected function get_value( $assoc_args, $args ) {
 		$path                = $this->get_config_path( $assoc_args );
 		$wp_config_file_name = basename( $path );
 		list( $name )        = $args;
-		$type                = Utils\get_flag_value( $assoc_args, 'type' );
+
+		/**
+		 * @var string $type
+		 */
+		$type = Utils\get_flag_value( $assoc_args, 'type' );
 
 		$value = $this->return_value(
 			$name,

templates/wp-config.mustache

@@ -72,18 +72,6 @@ define( 'WP_CACHE_KEY_SALT', '{{wp-cache-key-salt}}' );
  */
 $table_prefix = '{{dbprefix}}';
 
-{{#add-wplang}}
-/**
- * WordPress localized language, defaults to English.
- *
- * Change this to localize WordPress. A corresponding MO file for the chosen
- * language must be installed to wp-content/languages. For example, install
- * de_DE.mo to wp-content/languages and set WPLANG to 'de_DE' to enable German
- * language support.
- */
-define( 'WPLANG', '{{locale}}' );
-{{/add-wplang}}
-
 /* Add any custom values between this line and the "stop editing" line. */
 
 {{extra-php}}