[9.x] Adds type checking (#705)

* Adds type checking

* Apply fixes from StyleCI

---------

Co-authored-by: StyleCI Bot <[email protected]>

Author: nunomaduro

.gitattributes

@@ -14,6 +14,7 @@
 .gitignore export-ignore
 .styleci.yml export-ignore
 CHANGELOG.md export-ignore
+phpstan.neon.dist export-ignore
 phpunit.xml.dist export-ignore
 RELEASE.md export-ignore
 UPGRADE.md export-ignore

.github/workflows/static-analysis.yml

@@ -0,0 +1,41 @@
+name: static analysis
+
+on:
+  push:
+    branches:
+      - master
+      - '*.x'
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    runs-on: ubuntu-22.04
+
+    strategy:
+      fail-fast: true
+
+    name: Static Analysis
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          tools: composer:v2
+          coverage: none
+
+      - name: Install dependencies
+        uses: nick-fields/retry@v2
+        with:
+          timeout_minutes: 5
+          max_attempts: 5
+          command: composer update --prefer-stable --prefer-dist --no-interaction --no-progress
+
+      - name: Execute type checking
+        run: vendor/bin/phpstan

composer.json

@@ -24,10 +24,12 @@
         "illuminate/support": "^8.0|^9.0|^10.0"
     },
     "require-dev": {
+        "algolia/algoliasearch-client-php": "^3.2",
         "meilisearch/meilisearch-php": "^0.19",
         "mockery/mockery": "^1.0",
-        "php-http/guzzle7-adapter": "^1.0",
         "orchestra/testbench": "^6.17|^7.0|^8.0",
+        "php-http/guzzle7-adapter": "^1.0",
+        "phpstan/phpstan": "^1.10",
         "phpunit/phpunit": "^9.3"
     },
     "autoload": {

phpstan.neon.dist

@@ -0,0 +1,11 @@
+parameters:
+  paths:
+    - config
+    - src
+
+  level: 0
+
+  ignoreErrors:
+    - "#\\(void\\) is used.#"
+    - "#MeiliSearch\\\\Client referenced with incorrect case#"
+    - "#MeiliSearch\\\\MeiliSearch referenced with incorrect case#"

src/SearchableScope.php

@@ -48,6 +48,7 @@ public function extend(EloquentBuilder $builder)
         });
 
         HasManyThrough::macro('searchable', function ($chunk = null) {
+            /** @var HasManyThrough $this */
             $this->chunkById($chunk ?: config('scout.chunk.searchable', 500), function ($models) {
                 $models->filter->shouldBeSearchable()->searchable();
 
@@ -56,6 +57,7 @@ public function extend(EloquentBuilder $builder)
         });
 
         HasManyThrough::macro('unsearchable', function ($chunk = null) {
+            /** @var HasManyThrough $this */
             $this->chunkById($chunk ?: config('scout.chunk.searchable', 500), function ($models) {
                 $models->unsearchable();