introduce phpstan (#866)

Introduce phpstan

Co-authored-by: ADmad <[email protected]>

Author: LordSimal

.editorconfig

@@ -10,3 +10,6 @@ indent_style = space
 indent_size = 4
 insert_final_newline = true
 trim_trailing_whitespace = true
+
+[*.neon]
+indent_style = tab

.github/workflows/ci.yml

@@ -112,11 +112,14 @@ jobs:
         tools: cs2pr
 
     - name: Composer Install
-      run: composer psalm-setup
+      run: composer stan-setup
 
     - name: Run phpcs
       run: vendor/bin/phpcs --report=checkstyle src/ tests/ | cs2pr
 
     - name: Run psalm
-      if: always()
       run: vendor/bin/psalm.phar --output-format=github
+
+    - name: Run phpstan
+      if: always()
+      run: vendor/bin/phpstan.phar analyse --error-format=github

composer.json

@@ -54,9 +54,16 @@
     "scripts": {
         "cs-check": "phpcs --colors --parallel=16 -p src/ tests/",
         "cs-fix": "phpcbf --colors --parallel=16 -p src/ tests/",
-        "test": "phpunit",
+        "phpstan": "phpstan.phar analyse",
         "psalm": "psalm.phar --show-info=false",
-        "psalm-setup": "cp composer.json composer.backup && composer require --dev psalm/phar:^4.22 && mv composer.backup composer.json"
+        "stan": [
+            "@phpstan",
+            "@psalm"
+        ],
+        "stan-baseline": "phpstan.phar --generate-baseline",
+        "psalm-baseline": "psalm.phar --set-baseline=psalm-baseline.xml",
+        "stan-setup": "cp composer.json composer.backup && composer require --dev symfony/polyfill-php81 phpstan/phpstan:~1.7.0 psalm/phar:~4.23.0 && mv composer.backup composer.json",
+        "test": "phpunit"
     },
     "prefer-stable": true,
     "config": {

phpstan-baseline.neon

@@ -0,0 +1,36 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^PHPDoc type array\\<string, mixed\\>\\|Cake\\\\Cache\\\\CacheEngine of property DebugKit\\\\Cache\\\\Engine\\\\DebugEngine\\:\\:\\$_config is not covariant with PHPDoc type array\\<string, mixed\\> of overridden property Cake\\\\Cache\\\\CacheEngine\\:\\:\\$_config\\.$#"
+			count: 1
+			path: src/Cache/Engine/DebugEngine.php
+
+		-
+			message: "#^Property DebugKit\\\\Cache\\\\Engine\\\\DebugEngine\\:\\:\\$_engine \\(Cake\\\\Cache\\\\CacheEngine\\) in isset\\(\\) is not nullable\\.$#"
+			count: 1
+			path: src/Cache/Engine/DebugEngine.php
+
+		-
+			message: "#^Unreachable statement \\- code above always terminates\\.$#"
+			count: 1
+			path: src/Cache/Engine/DebugEngine.php
+
+		-
+			message: "#^Call to function file_get_contents\\(\\) on a separate line has no effect\\.$#"
+			count: 1
+			path: src/Command/BenchmarkCommand.php
+
+		-
+			message: "#^Method DebugKit\\\\Mailer\\\\Transport\\\\DebugKitTransport\\:\\:send\\(\\) should return array\\{headers\\: string, message\\: string\\} but returns array\\{headers\\: non\\-empty\\-array\\<string\\>, message\\: array\\{text\\: string, html\\: string\\}\\}\\.$#"
+			count: 1
+			path: src/Mailer/Transport/DebugKitTransport.php
+
+		-
+			message: "#^Parameter \\#1 \\$request of method DebugKit\\\\ToolbarService\\:\\:saveData\\(\\) expects Cake\\\\Http\\\\ServerRequest, Psr\\\\Http\\\\Message\\\\ServerRequestInterface given\\.$#"
+			count: 1
+			path: src/Middleware/DebugKitMiddleware.php
+
+		-
+			message: "#^Call to an undefined method Cake\\\\ORM\\\\Locator\\\\LocatorInterface\\:\\:genericInstances\\(\\)\\.$#"
+			count: 1
+			path: src/Panel/SqlLogPanel.php

phpstan.neon

@@ -0,0 +1,13 @@
+includes:
+	- phpstan-baseline.neon
+
+parameters:
+	level: 6
+	checkMissingIterableValueType: false
+	checkGenericClassInNonGenericObjectType: false
+	treatPhpDocTypesAsCertain: false
+	bootstrapFiles:
+		- tests/bootstrap.php
+		- vendor/cakephp/cakephp/src/Core/Exception/CakeException.php
+	paths:
+		- src/

psalm-baseline.xml

@@ -45,11 +45,6 @@
       <code>new $className($config)</code>
     </PropertyTypeCoercion>
   </file>
-  <file src="src/Middleware/DebugKitMiddleware.php">
-    <ArgumentTypeCoercion occurrences="1">
-      <code>$request</code>
-    </ArgumentTypeCoercion>
-  </file>
   <file src="src/Panel/DeprecationsPanel.php">
     <InvalidScalarArgument occurrences="4">
       <code>$pluginName</code>
@@ -66,11 +61,6 @@
       <code>$vendorName</code>
     </InvalidScalarArgument>
   </file>
-  <file src="src/Panel/LogPanel.php">
-    <UndefinedInterfaceMethod occurrences="1">
-      <code>count</code>
-    </UndefinedInterfaceMethod>
-  </file>
   <file src="src/Panel/PanelRegistry.php">
     <LessSpecificImplementedReturnType occurrences="1">
       <code>string|null</code>
@@ -83,16 +73,10 @@
     </UnsafeInstantiation>
   </file>
   <file src="src/Panel/SqlLogPanel.php">
-    <TypeDoesNotContainType occurrences="1">
-      <code>!$connection instanceof ConnectionInterface</code>
-    </TypeDoesNotContainType>
     <UndefinedInterfaceMethod occurrences="1">
       <code>genericInstances</code>
     </UndefinedInterfaceMethod>
   </file>
-  <file src="src/Plugin.php">
-    <InvalidArgument occurrences="1"/>
-  </file>
   <file src="src/View/Helper/ToolbarHelper.php">
     <DeprecatedMethod occurrences="1">
       <code>makeNeatArray</code>

psalm.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <psalm
-    resolveFromConfigFile="true"
+    reportMixedIssues="false"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
@@ -16,11 +16,16 @@
     </projectFiles>
 
     <issueHandlers>
+        <LessSpecificReturnType errorLevel="info" />
+
         <MissingClosureReturnType errorLevel="info" />
 
         <PropertyNotSetInConstructor errorLevel="info" />
         <MissingConstructor errorLevel="info" />
         <MissingClosureParamType errorLevel="info" />
         <MissingParamType errorLevel="info" />
+
+        <DocblockTypeContradiction errorLevel="info" />
+        <RedundantConditionGivenDocblockType errorLevel="info" />
     </issueHandlers>
 </psalm>

src/Controller/DashboardController.php

@@ -62,6 +62,7 @@ public function index()
     public function reset()
     {
         $this->request->allowMethod('post');
+        /** @var \DebugKit\Model\Table\RequestsTable $requestsModel */
         $requestsModel = $this->fetchTable('DebugKit.Requests');
 
         $requestsModel->Panels->deleteAll('1=1');

src/Controller/MailPreviewController.php

@@ -99,7 +99,7 @@ public function sent($panelId, $number)
      *
      * @param string $name The Mailer name
      * @param string $method The mailer preview method
-     * @return \Psr\Http\Message\ResponseInterface|null
+     * @return \Psr\Http\Message\ResponseInterface|void
      */
     public function email($name, $method)
     {
@@ -158,9 +158,8 @@ protected function respondWithPart($email, $partType)
         if ($partType === 'text') {
             $part = '<pre>' . $part . '</pre>';
         }
-        $response = $response->withStringBody($part);
 
-        return $response;
+        return $response->withStringBody($part);
     }
 
     /**

src/DebugSql.php

@@ -73,7 +73,7 @@ public static function sql(Query $query, $showValues = true, $showHtml = null, $
 
         $sql = (string)$query;
         if ($showValues) {
-            $sql = static::interpolate($sql, $query->getValueBinder()->bindings());
+            $sql = self::interpolate($sql, $query->getValueBinder()->bindings());
         }
 
         /** @var array $trace */
@@ -92,16 +92,16 @@ public static function sql(Query $query, $showValues = true, $showHtml = null, $
             $file = str_replace($search, '', $file);
         }
 
-        $template = static::$templateHtml;
+        $template = self::$templateHtml;
         $sqlHighlight = true;
         if ((PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') || $showHtml === false) {
-            $template = static::$templateText;
+            $template = self::$templateText;
             $sqlHighlight = false;
             if ($file && $line) {
                 $lineInfo = sprintf('%s (line %s)', $file, $line);
             }
         }
-        if ($showHtml === null && $template !== static::$templateText) {
+        if ($showHtml === null && $template !== self::$templateText) {
             $showHtml = true;
         }
 
@@ -113,7 +113,7 @@ public static function sql(Query $query, $showValues = true, $showHtml = null, $
         );
 
         if ($showHtml) {
-            $template = static::$templateHtml;
+            $template = self::$templateHtml;
             if ($file && $line) {
                 $lineInfo = sprintf('<span><strong>%s</strong> (line <strong>%s</strong>)</span>', $file, $line);
             }