PocketMine-MP/phpstan.neon.dist

includes:
	- tests/phpstan/analyse-for-current-php-version.neon.php
	- tests/phpstan/configs/actual-problems.neon
	- tests/phpstan/configs/impossible-generics.neon
	- tests/phpstan/configs/php-bugs.neon
	- tests/phpstan/configs/phpstan-bugs.neon
	- tests/phpstan/configs/spl-fixed-array-sucks.neon
	- vendor/phpstan/phpstan-phpunit/extension.neon
	- vendor/phpstan/phpstan-phpunit/rules.neon
	- vendor/phpstan/phpstan-strict-rules/rules.neon

rules:
	- pocketmine\phpstan\rules\DisallowDynamicNewRule
	- pocketmine\phpstan\rules\DisallowForeachByReferenceRule
	- pocketmine\phpstan\rules\ExplodeLimitRule
	- pocketmine\phpstan\rules\UnsafeForeachArrayOfStringRule
#	- pocketmine\phpstan\rules\ThreadedSupportedTypesRule

parameters:
	level: 9
	checkMissingCallableSignature: true
	rememberPossiblyImpureFunctionValues: false #risky to remember these, better for performance to avoid repeated calls anyway
	treatPhpDocTypesAsCertain: false
	bootstrapFiles:
		- tests/phpstan/bootstrap.php
	scanDirectories:
		- build
		- tests/plugins/TesterPlugin
		- tools
	scanFiles:
		- src/PocketMine.php
	paths:
		- build
		- src
		- tests/phpstan/DummyPluginOwned.php
		- tests/phpstan/rules
		- tests/phpunit
		- tests/plugins/TesterPlugin
		- tools
	excludePaths:
		analyseAndScan:
			- build/php
	dynamicConstantNames:
		- pocketmine\VersionInfo::IS_DEVELOPMENT_BUILD
		- pocketmine\VersionInfo::BUILD_CHANNEL
		- pocketmine\DEBUG
		- pocketmine\IS_DEVELOPMENT_BUILD
	stubFiles:
		- tests/phpstan/stubs/chunkutils2.stub
		- tests/phpstan/stubs/JsonMapper.stub
		- tests/phpstan/stubs/leveldb.stub
		- tests/phpstan/stubs/pmmpthread.stub
	reportUnmatchedIgnoredErrors: false #no other way to silence platform-specific non-warnings
	typeAliases:
		#variadics don't work for this - mixed probably shouldn't work either, but for now it does
		#what we actually need is something that accepts an infinite number of parameters, but in the absence of that,
		#we'll just fill it with 10 - it's very unlikely to encounter a callable with 10 parameters anyway.
		anyCallable: 'callable(never, never, never, never, never, never, never, never, never, never) : mixed'
		anyClosure: '\Closure(never, never, never, never, never, never, never, never, never, never) : mixed'
phpstan: separate non-PM bugs from the main neon config everything left in here is now a PM problem that needs to be looked into. 2019-12-01 20:12:41 +00:00			`includes:`
Workaround PHPStan "feature" phpstan/phpstan#7701 2022-08-20 16:29:26 +01:00			`- tests/phpstan/analyse-for-current-php-version.neon.php`
restructure ignoreErrors to allow regenerating them file by file 2020-04-25 11:59:06 +01:00			`- tests/phpstan/configs/actual-problems.neon`
Merge branch 'stable' 2021-01-27 20:04:13 +00:00			`- tests/phpstan/configs/impossible-generics.neon`
phpstan: run static analysis on tests 2020-02-06 13:13:12 +00:00			`- tests/phpstan/configs/php-bugs.neon`
phpstan: separate non-PM bugs from the main neon config everything left in here is now a PM problem that needs to be looked into. 2019-12-01 20:12:41 +00:00			`- tests/phpstan/configs/phpstan-bugs.neon`
phpstan 0.12.95 2021-08-20 22:45:38 +01:00			`- tests/phpstan/configs/spl-fixed-array-sucks.neon`
start using phpstan-phpunit not using extension-installer because I want to part-integrate phpstan-strict-rules later on. 2020-02-06 13:23:18 +00:00			`- vendor/phpstan/phpstan-phpunit/extension.neon`
			`- vendor/phpstan/phpstan-phpunit/rules.neon`
finally, integrate phpstan-strict-rules 2020-02-06 19:44:10 +00:00			`- vendor/phpstan/phpstan-strict-rules/rules.neon`
introduced baseline PHPStan configuration 2019-11-05 11:16:49 +00:00
actually use the DisallowEnumComparisonRule (derp) 2020-01-09 17:54:52 +00:00			`rules:`
phpstan: added rule to ban new $class see #6635 for rationale on why we want to get rid of this for now, this rule will prevent this anti-feature from being used in new code 2025-03-09 00:51:12 +00:00			`- pocketmine\phpstan\rules\DisallowDynamicNewRule`
Ban foreach by-reference at the PHPStan level 2023-08-08 17:08:13 +01:00			`- pocketmine\phpstan\rules\DisallowForeachByReferenceRule`
New rule: explode() limit parameter must be set 2025-03-04 20:44:01 +00:00			`- pocketmine\phpstan\rules\ExplodeLimitRule`
Ban foreach(arrayWithStringKeys as k => v) this is not as good as phpstan/phpstan-src#769 (e.g. array_key_first()/array_key_last() aren't covered by this, nor is array_rand()) but it does eliminate the most infuriating cases where this usually crops up. 2021-11-15 22:52:05 +00:00			`- pocketmine\phpstan\rules\UnsafeForeachArrayOfStringRule`
Extract MainLoggerThread unit from MainLogger MainLogger is no longer a Thread, as per the recent changes to pocketmine/log-pthreads. 2021-02-04 16:28:49 +00:00			`# - pocketmine\phpstan\rules\ThreadedSupportedTypesRule`
actually use the DisallowEnumComparisonRule (derp) 2020-01-09 17:54:52 +00:00
introduced baseline PHPStan configuration 2019-11-05 11:16:49 +00:00			`parameters:`
PHPStan 1.0.0 2021-11-01 17:24:20 +00:00			`level: 9`
phpstan: enable checkMissingCallableSignature 2021-01-24 20:27:53 +00:00			`checkMissingCallableSignature: true`
PHPStan: don't remember possibly-impure function return values I don't think we get much benefit from this, and the assumption that functions with a return value are pure is sketchy. In any case, it's better to avoid these repeated calls anyway. 2025-01-08 02:04:06 +00:00			`rememberPossiblyImpureFunctionValues: false #risky to remember these, better for performance to avoid repeated calls anyway`
Silence a PHPStan bug I'm not able to reproduce this one on the playground, but it still shows up even when disabling certain phpdocs... 2021-05-02 13:55:32 +01:00			`treatPhpDocTypesAsCertain: false`
phpstan: update config to use new 0.12.26+ options 2020-06-14 19:57:36 +01:00			`bootstrapFiles:`
fixing some PHPStan complaints about bootstrap this isn't an ideal fix, but it'll do. 2019-11-07 18:22:21 +00:00			`- tests/phpstan/bootstrap.php`
Fixup TesterPlugin to PHPStan standards 2020-08-28 21:17:21 +01:00			`scanDirectories:`
Fixed new files in build/ keeping getting missed 2021-09-07 12:39:54 +01:00			`- build`
phpstan.neon.dist: fix indentation inconsistency fuck you, phpstorm! it doesn't have an option to use tabs for indentation in YAML, and YAML is the closest thing to NEON, so ... 2021-08-29 23:19:35 +01:00			`- tests/plugins/TesterPlugin`
Add tools/ to PHPStan analysis 2021-08-29 23:31:24 +01:00			`- tools`
phpstan: update config to use new 0.12.26+ options 2020-06-14 19:57:36 +01:00			`scanFiles:`
Merge branch 'stable' with changes 2019-11-09 18:01:04 +00:00			`- src/PocketMine.php`
introduced baseline PHPStan configuration 2019-11-05 11:16:49 +00:00			`paths:`
Fixed new files in build/ keeping getting missed 2021-09-07 12:39:54 +01:00			`- build`
introduced baseline PHPStan configuration 2019-11-05 11:16:49 +00:00			`- src`
Update to PHPStan 2.x 2025-01-07 22:34:43 +00:00			`- tests/phpstan/DummyPluginOwned.php`
phpstan: added a custom rule to disallow strict equality operators on enum members comparing enums with equality operators is unreliable because there is no guarantee that the enum objects won't be somehow duplicated, through serialization, cloning or ext-parallel dumb object copying. This means that two equal enum objects may not be thw same object. 2020-01-08 19:45:05 +00:00			`- tests/phpstan/rules`
phpstan: run static analysis on tests 2020-02-06 13:13:12 +00:00			`- tests/phpunit`
Fixup TesterPlugin to PHPStan standards 2020-08-28 21:17:21 +01:00			`- tests/plugins/TesterPlugin`
Add tools/ to PHPStan analysis 2021-08-29 23:31:24 +01:00			`- tools`
Fixed new files in build/ keeping getting missed 2021-09-07 12:39:54 +01:00			`excludePaths:`
			`analyseAndScan:`
phpstan: exclude build/php from analysis in case I built PHP in there, I don't want the install_data getting analysed and screwing up the analysis. 2021-10-05 00:14:21 +00:00			`- build/php`
phpstan: properly fixing FPs on constant comparisons 2019-12-29 14:25:44 +00:00			`dynamicConstantNames:`
Convert VersionInfo into a final class this allows it to be loaded by the autoloader without additional changes. 2020-07-25 19:00:48 +01:00			`- pocketmine\VersionInfo::IS_DEVELOPMENT_BUILD`
New release workflow triggered by the merge of a PR changing IS_DEVELOPMENT_BUILD to false This is more streamlined than the previous approach, and works better for a world where 1 person isn't doing all the work. Now, the flow is simpler: - Do changes (e.g. protocol update), changelog & set IS_DEVELOPMENT_BUILD to false all in a single PR, which can be squash-merged if desired - Once the PR is merged, a draft release will be prepared - RestrictedActions will automatically set IS_DEVELOPMENT_BUILD back to true and bump the version - Tag will be created when the release is published Previously, multiple PRs might be needed, and the PR containing the release changelog couldn't be squash-merged. Manual intervention was also required to create a tag and prepare a release. This PR also includes new CI checks to check for basic errors like forgotten changelog files to ensure changelog links work correctly. Note: Only PRs from PMMP Team members with write access to the repository can trigger release generation. Random people cannot trigger release generation by sending PRs. 2024-10-31 13:52:15 +00:00			`- pocketmine\VersionInfo::BUILD_CHANNEL`
phpstan: properly fixing FPs on constant comparisons 2019-12-29 14:25:44 +00:00			`- pocketmine\DEBUG`
Sort phpstan.neon 2021-09-07 12:32:19 +01:00			`- pocketmine\IS_DEVELOPMENT_BUILD`
phpstan: stub out the iterable bullshit with pthreads this isn't a perfect fix, but it's better than it whining about all the things. 2020-01-30 22:31:15 +00:00			`stubFiles:`
Stub PalettedBlockArray functions that work with arrays and workaround PHPStan stupidity 2025-01-08 01:48:15 +00:00			`- tests/phpstan/stubs/chunkutils2.stub`
LoginPacket: use netresearch/jsonmapper for login data decoding this makes retrieval static analysis friendly without extra steps. 2020-03-23 21:58:12 +00:00			`- tests/phpstan/stubs/JsonMapper.stub`
phpstan: add LevelDB::get() stub to fix return type 2020-06-10 10:31:54 +01:00			`- tests/phpstan/stubs/leveldb.stub`
pmmpthread support 2023-05-20 01:29:26 +01:00			`- tests/phpstan/stubs/pmmpthread.stub`
phpstan: silence leveldb noise maybe there's a better way to do this, but I don't know it yet. 2019-11-05 20:21:36 +00:00			`reportUnmatchedIgnoredErrors: false #no other way to silence platform-specific non-warnings`
phpstan: better hack for any-callable parameters variadics are a bad fit for this because what we really need is to accept callable with any number of arguments. LSP requires that the provided number of arguments must be >= than the required number of arguments. 2021-01-27 19:25:28 +00:00			`typeAliases:`
phpstan.neon.dist: fix indentation inconsistency fuck you, phpstorm! it doesn't have an option to use tabs for indentation in YAML, and YAML is the closest thing to NEON, so ... 2021-08-29 23:19:35 +01:00			`#variadics don't work for this - mixed probably shouldn't work either, but for now it does`
			`#what we actually need is something that accepts an infinite number of parameters, but in the absence of that,`
			`#we'll just fill it with 10 - it's very unlikely to encounter a callable with 10 parameters anyway.`
phpstan 0.12.99 2021-10-09 19:33:43 +01:00			`anyCallable: 'callable(never, never, never, never, never, never, never, never, never, never) : mixed'`
			`anyClosure: '\Closure(never, never, never, never, never, never, never, never, never, never) : mixed'`