Merge pull request #152 from cakephp/ide-helper

add ide helper + PHPStan

Author: LordSimal

.github/workflows/ci.yml

@@ -82,3 +82,6 @@ jobs:
 
     - name: Run PHP CodeSniffer
       run: vendor/bin/phpcs --report=checkstyle | cs2pr
+
+    - name: Run PHPStan
+      run: vendor/bin/phpstan analyse -c phpstan.neon --error-format=checkstyle | cs2pr

composer.json

@@ -17,9 +17,11 @@
         "mobiledetect/mobiledetectlib": "^4.8.03"
     },
     "require-dev": {
+        "cakedc/cakephp-phpstan": "^4.0",
         "cakephp/bake": "^3.0.0",
         "cakephp/cakephp-codesniffer": "^5.0",
         "cakephp/debug_kit": "^5.0.0",
+        "dereuromark/cakephp-ide-helper": "dev-master",
         "josegonzalez/dotenv": "^4.0",
         "phpunit/phpunit": "^10.5.5 || ^11.1.3 || ^12.1"
     },
@@ -58,6 +60,10 @@
         ],
         "cs-check": "phpcs --colors -p",
         "cs-fix": "phpcbf --colors -p",
-        "test": "phpunit --colors=always"
+        "test": "phpunit --colors=always",
+        "annotate": "bin/cake annotate all",
+        "illuminate": "bin/cake illuminate code",
+        "phpstan": "phpstan analyse",
+        "phpstan-baseline": "phpstan --generate-baseline"
     }
 }

composer.lock

@@ -36,5 +36,5 @@ export DATABASE_URL="mysql://db:db@db:3306/db"
 # Uncomment these to define logging configuration via environment variables.
 #export LOG_DEBUG_URL="file:///path/to/logs/?levels[]=notice&levels[]=info&levels[]=debug&file=debug"
 #export LOG_ERROR_URL="file:///path/to/logs/?levels[]=warning&levels[]=error&levels[]=critical&levels[]=alert&levels[]=emergency&file=error"
-export DEBUG_KIT_SAFE_TLD="site"
 export APP_FULL_BASE_URL="https://plugins.cakephp.org.ddev.site"
+export DEBUG_KIT_SAFE_TLD="site"

config/.env.ddev

@@ -479,4 +479,11 @@
     'Migrations' => [
         'add_timestamps_use_datetime' => true,
     ],
+
+    'IdeHelper' => [
+        'tableBehaviors' => true,
+        'arrayAsGenerics' => true,
+        'objectAsGenerics' => true,
+        'assocsAsGenerics' => true,
+    ],
 ];

config/app.php

@@ -37,4 +37,5 @@
     'Tags',
     'ADmad/SocialAuth',
     'Authentication',
+    'IdeHelper',
 ];

config/plugins.php

@@ -1,7 +1,9 @@
+includes:
+    - vendor/cakedc/cakephp-phpstan/extension.neon
+
 parameters:
-    level: 8
+    level: 5
     treatPhpDocTypesAsCertain: false
-    checkGenericClassInNonGenericObjectType: false
     bootstrapFiles:
         - config/bootstrap.php
     paths:

phpstan.neon

@@ -127,6 +127,7 @@ public function execute(Arguments $args, ConsoleIo $io)
         }
 
         // Remove packages that were not touched
+        /** @var \Cake\ORM\ResultSet<array-key, \App\Model\Entity\Package> $toDeletePackages */
         $toDeletePackages = $packagesTable->find()->where(['id NOT IN' => $touchedIds])->all();
         foreach ($toDeletePackages as $package) {
             if (!$packagesTable->delete($package)) {
@@ -241,7 +242,7 @@ private function hasExplicitCakePhpDependency(array $tags): bool
      * @param array $meta The meta array to adjust
      * @param string $packageConstraint The meta array which contains the current version strings
      * @param string $tagPrefix The prefix which should be used for the tag
-     * @param array<string, array<int>> $versions The versions to check
+     * @param array<array-key, array<int>> $versions The versions to check
      * @return array
      */
     private function appendVersionTags(

src/Command/SyncPackagesCommand.php

@@ -25,6 +25,8 @@
  * will inherit them.
  *
  * @link https://book.cakephp.org/5/en/controllers.html#the-app-controller
+ * @property \Search\Controller\Component\SearchComponent $Search
+ * @property \Authentication\Controller\Component\AuthenticationComponent $Authentication
  */
 class AppController extends Controller
 {

src/Controller/AppController.php

@@ -25,6 +25,8 @@
  */
 class ErrorController extends AppController
 {
+    protected ?string $defaultTable = '';
+
     /**
      * Initialization hook method.
      *