Merge pull request #258 from wp-cli/203-add-phpstan

Author: swissspidy

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: 6
+  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>#'