reintroduce phan because phpstan keeps making trouble

Author: codemasher

.github/workflows/ci.yml

@@ -31,6 +31,10 @@ jobs:
     name: "Static Code Analysis"
     runs-on: ubuntu-latest
 
+    env:
+      PHAN_ALLOW_XDEBUG: 0
+      PHAN_DISABLE_XDEBUG_WARN: 1
+
     strategy:
       fail-fast: true
       matrix:
@@ -48,19 +52,22 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
-          extensions: ${{ env.PHP_EXTENSIONS }}
+          extensions: ast, ${{ env.PHP_EXTENSIONS }}
           ini-values: ${{ env.PHP_INI_VALUES }}
           coverage: none
 
       - name: "Install dependencies with composer"
         uses: ramsey/composer-install@v3
 
-      - name: "Run PHPStan"
-        run: php vendor/bin/phpstan
-
       - name: "Run PHP_CodeSniffer"
         run: php vendor/bin/phpcs
 
+      - name: "Run phan"
+        run: php vendor/bin/phan --target-php-version=${{ matrix.php-version }}
+
+      - name: "Run PHPStan"
+        run: php vendor/bin/phpstan
+
 
   tests:
     name: "Unit Tests"

.phan/config.php

@@ -0,0 +1,55 @@
+<?php
+/**
+ * This configuration will be read and overlaid on top of the
+ * default configuration. Command-line arguments will be applied
+ * after this file is read.
+ */
+return [
+	// If this is set to `null`,
+	// then Phan assumes the PHP version which is closest to the minor version
+	// of the php executable used to execute Phan.
+	//
+	// Note that the **only** effect of choosing `'5.6'` is to infer
+	// that functions removed in php 7.0 exist.
+	// (See `backward_compatibility_checks` for additional options)
+	'target_php_version'              => null,
+	'minimum_target_php_version'      => '8.1',
+
+	// A list of directories that should be parsed for class and
+	// method information. After excluding the directories
+	// defined in exclude_analysis_directory_list, the remaining
+	// files will be statically analyzed for errors.
+	//
+	// Thus, both first-party and third-party code being used by
+	// your application should be included in this list.
+	'directory_list'                  => [
+		'examples',
+		'src',
+		'tests',
+		'vendor',
+	],
+
+	// A regex used to match every file name that you want to
+	// exclude from parsing. Actual value will exclude every
+	// "test", "tests", "Test" and "Tests" folders found in
+	// "vendor/" directory.
+	'exclude_file_regex'              => '@^vendor/.*/(tests?|Tests?)/@',
+
+	// A directory list that defines files that will be excluded
+	// from static analysis, but whose class and method
+	// information should be included.
+	//
+	// Generally, you'll want to include the directories for
+	// third-party code (such as "vendor/") in this list.
+	//
+	// n.b.: If you'd like to parse but not analyze 3rd
+	//       party code, directories containing that code
+	//       should be added to both the `directory_list`
+	//       and `exclude_analysis_directory_list` arrays.
+	'exclude_analysis_directory_list' => [
+		'vendor',
+	],
+	'suppress_issue_types'            => [
+		'PhanUndeclaredGlobalVariable', // happens in get-token examples
+	],
+];

composer.json

@@ -47,6 +47,7 @@
 		"chillerlan/phpunit-http": "^1.0",
 		"guzzlehttp/guzzle": "^7.9",
 		"monolog/monolog": "^3.7",
+		"phan/phan": "^5.5.0",
 		"phpmd/phpmd": "^2.15",
 		"phpstan/phpstan": "^2.1.18",
 		"phpstan/phpstan-deprecation-rules": "^2.0.3",
@@ -68,6 +69,7 @@
 		}
 	},
 	"scripts": {
+		"phan": "@php vendor/bin/phan",
 		"phpcs": "@php vendor/bin/phpcs",
 		"phpstan": "@php vendor/bin/phpstan",
 		"phpstan-baseline": "@php vendor/bin/phpstan --generate-baseline",

src/Core/ClientCredentialsTrait.php

@@ -6,6 +6,8 @@
  * @author       smiley <[email protected]>
  * @copyright    2024 smiley
  * @license      MIT
+ *
+ * @phan-file-suppress PhanUndeclaredConstantOfClass, PhanUndeclaredProperty, PhanUndeclaredMethod
  */
 declare(strict_types=1);
 

src/Core/PARTrait.php

@@ -6,6 +6,8 @@
  * @author       smiley <[email protected]>
  * @copyright    2024 smiley
  * @license      MIT
+ *
+ * @phan-file-suppress PhanUndeclaredProperty, PhanUndeclaredMethod
  */
 declare(strict_types=1);
 

src/Core/PKCETrait.php

@@ -6,6 +6,8 @@
  * @author       smiley <[email protected]>
  * @copyright    2024 smiley
  * @license      MIT
+ *
+ * @phan-file-suppress PhanUndeclaredProperty, PhanUndeclaredMethod
  */
 declare(strict_types=1);
 

src/Core/TokenInvalidateTrait.php

@@ -6,6 +6,8 @@
  * @author       smiley <[email protected]>
  * @copyright    2024 smiley
  * @license      MIT
+ *
+ * @phan-file-suppress PhanUndeclaredProperty, PhanUndeclaredMethod
  */
 declare(strict_types=1);
 
@@ -42,6 +44,7 @@ public function invalidateAccessToken(AccessToken|null $token = null, string|nul
 		}
 
 		$tokenToInvalidate = ($token ?? $this->storage->getAccessToken($this->name));
+		/** @phan-suppress-next-line PhanTypeMismatchArgumentNullable */
 		$body              = $this->getInvalidateAccessTokenBodyParams($tokenToInvalidate, $type);
 		$response          = $this->sendTokenInvalidateRequest($this->revokeURL, $body);
 

tests/Core/AccessTokenTest.php

@@ -75,6 +75,7 @@ public static function expiryDataProvider():array{
 
 	#[DataProvider('expiryDataProvider')]
 	public function testSetExpiry(DateTime|DateInterval|int|null $expires, int $expected):void{
+		/** @phan-suppress-next-line PhanPossiblyNullTypeMismatchProperty */
 		$this->token->expires = $expires;
 
 		// time tests are a bit wonky sometimes