[9.x] Auto-generate Facade Docblocks (#45154)

* Update Vite docblock

* Update View docblock

* Update Validator docblock

* Update URL docblock

* Update Session docblock

* Update Schema docblock

* Update Response docblock

* Use single quotes

* Update Redirect docblock

* Update RateLimiter docblock

* Update ParallelTesting docblock

* Update Lang docblock

* Update Gate docblock

* Update Event docblock

* Update Crypt docblock

* Update Bus docblock

* Update Artisan docblock

* Update App docblock

* Update "static" reference

* Update Blade docblock

* Update Broadcast docblock

* Update Config docblock

* Update Cookie docblock

* Update DB docblock

* Update Http docblock

* Update Log docblock

* Update Mail docblock

* Update Notification docblock

* Update Redis docblock

* Update Request docblock

* Update Response docblock

* Update Session docblock

* Update Storage docblock

* Replace method docblocks with mixin

* Add Bus fake

* Add Event fake

* Add Mail fake

* Add Notification fake

* Remove methods that conflict with the Facade

* Update Date docblock

* Handle generics and FQCN better

* Update Auth docblock

* Update docblock

* Update Hash docblock

* Update Queue docblock

* Update Password docblock

* Update Route docblock

* Strip comments

* add script

* Tidy

* Remove un-needed check

* Strip out generics

* Code style

* run in actions

* Update facades.php

* Separate job for linting facades

* Rename job

* Comment auto commit for now

* update facade files directly

* normalise mixed types after generic replacement

* re-enable auto-commit of docblock changes

* add bad docblock to test auto-commit

* add linting / replace option

* Lint in CI

* Code style

* test bad docblock

Co-authored-by: Dries Vints <[email protected]>

Author: timacdonald

.github/workflows/static-analysis.yml

@@ -8,7 +8,7 @@ on:
   pull_request:
 
 jobs:
-  src:
+  types:
     runs-on: ubuntu-22.04
 
     strategy:
@@ -25,7 +25,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.0
+          php-version: 8.1
           tools: composer:v2
           coverage: none
 
@@ -38,3 +38,32 @@ jobs:
 
       - name: Execute type checking
         run: vendor/bin/phpstan --configuration="phpstan.${{ matrix.directory }}.neon.dist"
+
+  facades:
+    runs-on: ubuntu-22.04
+
+    strategy:
+      fail-fast: true
+
+    name: Facade DocBlocks
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.1
+          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: Lint facade docblocks
+        run: php -f bin/facades.php -- --lint