build: add phan

cscott · cscott · commit e3c0ef82935f · 2023-11-03T18:07:40.000-04:00
Change-Id: I494dff2cb8f0dfc92001deff30e69847591108ba
diff --git a/.phan/config.php b/.phan/config.php
@@ -0,0 +1,7 @@
+<?php
+
+$cfg = require __DIR__ . '/../vendor/mediawiki/mediawiki-phan-config/src/config-library.php';
+
+$cfg['directory_list'][] = 'tests';
+
+return $cfg;
diff --git a/composer.json b/composer.json
@@ -32,6 +32,7 @@
 	},
 	"require-dev": {
 		"mediawiki/mediawiki-codesniffer": "41.0.0",
+		"mediawiki/mediawiki-phan-config": "0.12.1",
 		"mediawiki/minus-x": "1.1.1",
 		"ockcyp/covers-validator": "1.6.0",
 		"php-parallel-lint/php-console-highlighter": "1.0.0",
@@ -40,12 +41,18 @@
 	},
 	"scripts": {
 		"test": [
-			"parallel-lint . --exclude vendor",
-			"phpunit",
-			"covers-validator",
+			"@lint",
+			"@phan",
+			"@phpunit"
+		],
+		"lint": [
+			"parallel-lint . --exclude vendor --exclude node_modules",
 			"@phpcs",
-			"minus-x check ."
+			"minus-x check .",
+			"covers-validator"
 		],
+		"phan": "phan --allow-polyfill-parser",
+		"phpunit": "phpunit",
 		"cover": "phpunit --coverage-html coverage",
 		"fix": [
 			"minus-x fix .",
diff --git a/src/TestingAccessWrapper.php b/src/TestingAccessWrapper.php
@@ -50,7 +50,7 @@ public static function newFromObject( $object ) {
 	 * Allow access to non-public static methods and properties of the class.
 	 * Returns an object whose methods/properties will correspond to the
 	 * static methods/properties of the given class.
-	 * @param string $className
+	 * @param class-string $className
 	 * @return self
 	 * @throws InvalidArgumentException
 	 */
diff --git a/tests/TestingAccessWrapperTest.php b/tests/TestingAccessWrapperTest.php
@@ -20,11 +20,13 @@ protected function setUp(): void {
 
 	public function testConstructorException() {
 		$this->expectException( \InvalidArgumentException::class );
+		// @phan-suppress-next-line PhanTypeMismatchArgumentProbablyReal
 		TestingAccessWrapper::newFromObject( WellProtectedClass::class );
 	}
 
 	public function testStaticConstructorException() {
 		$this->expectException( \InvalidArgumentException::class );
+		// @phan-suppress-next-line PhanTypeMismatchArgumentProbablyReal
 		TestingAccessWrapper::newFromClass( new WellProtectedClass() );
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -20,11 +20,13 @@ protected function setUp(): void {`
`20`	`20`
`21`	`21`	`public function testConstructorException() {`
`22`	`22`	`$this->expectException( \InvalidArgumentException::class );`
	`23`	`+ // @phan-suppress-next-line PhanTypeMismatchArgumentProbablyReal`
`23`	`24`	`TestingAccessWrapper::newFromObject( WellProtectedClass::class );`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`public function testStaticConstructorException() {`
`27`	`28`	`$this->expectException( \InvalidArgumentException::class );`
	`29`	`+ // @phan-suppress-next-line PhanTypeMismatchArgumentProbablyReal`
`28`	`30`	`TestingAccessWrapper::newFromClass( new WellProtectedClass() );`
`29`	`31`	`}`
`30`	`32`