phan on CI

Author: codemasher

.github/workflows/ci.yml

@@ -38,6 +38,7 @@ jobs:
           - "8.2"
           - "8.3"
           - "8.4"
+          - "8.5"
 
     steps:
       - name: "Checkout"
@@ -47,21 +48,24 @@ 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: "Validate composer.json"
-        run: composer validate --ansi --strict
+        run: composer validate --no-interaction --ansi --verbose --with-dependencies
 
       - name: "Install dependencies with composer"
         uses: ramsey/composer-install@v3
 
       - name: "Run PHPCodeSniffer"
         run: php vendor/bin/phpcs
 
-      - name: "Run PHPStan"
-        run: php vendor/bin/phpstan
+      - name: "Run phan"
+        run: php vendor/bin/phan --target-php-version=${{ matrix.php-version }}
+
+#      - name: "Run PHPStan"
+#        run: php vendor/bin/phpstan
 
 
   tests:
@@ -80,6 +84,7 @@ jobs:
           - "8.2"
           - "8.3"
           - "8.4"
+          - "8.5"
 
     steps:
       - name: "Checkout"

.phan/config.php

@@ -0,0 +1,62 @@
+<?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'                  => [
+#		'benchmark',
+		'examples',
+		'src',
+		'tests',
+		'vendor',
+#		'.phan/stubs',
+	],
+
+	// 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/',
+		'.phan/stubs',
+	],
+	'suppress_issue_types'            => [
+#		'PhanAccessMethodInternal',
+#		'PhanDeprecatedClass',
+#		'PhanDeprecatedClassConstant',
+#		'PhanNoopNew',
+#		'PhanTypePossiblyInvalidDimOffset',
+	],
+];

composer.json

@@ -36,6 +36,7 @@
 		"ext-sodium": "*"
 	},
 	"require-dev": {
+		"phan/phan": "^6.0.2",
 		"phpmd/phpmd": "^2.15",
 		"phpstan/phpstan": "^2.1.42",
 		"phpstan/phpstan-deprecation-rules": "^2.0",
@@ -56,7 +57,9 @@
 		}
 	},
 	"scripts": {
-		"phpcs": "@php vendor/bin/phpcs",
+		"phan": "@php vendor/bin/phan",
+		"phpcs": "@php vendor/bin/phpcs -v",
+		"phpmd": "@php vendor/bin/phpmd src text ./phpmd.xml.dist",
 		"phpstan": "@php vendor/bin/phpstan",
 		"phpstan-baseline": "@php vendor/bin/phpstan --generate-baseline",
 		"phpunit": "@php vendor/bin/phpunit"

src/Arr.php

@@ -80,6 +80,7 @@ public static function random(array $array):mixed{
 		}
 
 		if(PHP_VERSION_ID >= 80200){
+			/** @phan-suppress-next-line PhanParamTooManyInternal (false positive) */
 			$key = (new \Random\Randomizer(new \Random\Engine\Secure))->pickArrayKeys($array, 1)[0];
 		}
 		else{

src/File.php

@@ -115,6 +115,7 @@ public static function load(string $file, int $offset = 0, int|null $length = nu
 			throw new RuntimeException('cannot read the given file'); // @codeCoverageIgnore
 		}
 
+		/** @phan-suppress-next-line PhanTypeMismatchArgumentNullableInternal (false positive) */
 		$content = file_get_contents(filename: $file, offset: $offset, length: $length);
 
 		if($content === false){

tests/StrTest.php

@@ -22,6 +22,7 @@ final class StrTest extends TestCase{
 
 	/**
 	 * @return array<string, array{0: array<int, string>, 1: bool, 2: bool}>
+	 * @phan-suppress PhanTypeMismatchReturn
 	 */
 	public static function startsWithProvider():array{
 		return [
@@ -44,6 +45,7 @@ public function startsWith(array $needles, bool $ignoreCase, bool $expected):voi
 
 	/**
 	 * @return array<string, array{0: array<int, string>, 1: bool, 2: bool}>
+	 * @phan-suppress PhanTypeMismatchReturn
 	 */
 	public static function containsAllProvider():array{
 		return [
@@ -66,6 +68,7 @@ public function containsAll(array $needles, bool $ignoreCase, bool $expected):vo
 
 	/**
 	 * @return array<string, array{0: array<int, string>, 1: bool, 2: bool}>
+	 * @phan-suppress PhanTypeMismatchReturn
 	 */
 	public static function containsAnyProvider():array{
 		return [