phpstan.neon.dist

includes:
	- phar://phpstan.phar/conf/bleedingEdge.neon
parameters:
	level: 8
	treatPhpDocTypesAsCertain: false
	paths:
		- plugins
		- performance.php
	bootstrapFiles:
		- tools/phpstan/constants.php
	scanDirectories:
		- vendor/wp-phpunit/wp-phpunit/
	scanFiles:
		# These are needed due config.platform.php being 7.4 in composer.json and wordpress-stubs not including polyfills.
		# See <https://github.com/php-stubs/wordpress-stubs/issues/100>.
		- vendor/phpstan/php-8-stubs/stubs/ext/standard/str_contains.php
		- vendor/phpstan/php-8-stubs/stubs/ext/standard/str_starts_with.php
		- vendor/phpstan/php-8-stubs/stubs/ext/standard/str_ends_with.php
		# ValueError is a PHP 8 class, caught for forward compatibility but absent under the PHP 7.4 platform target.
		- vendor/phpstan/php-8-stubs/stubs/Zend/ValueError.php
	stubFiles:
		- tools/phpstan/filtered-functions.stub
	dynamicConstantNames:
		- PERFLAB_OBJECT_CACHE_DROPIN_VERSION
	strictRules:
		strictArrayFilter: false
	ignoreErrors:
		# Allow using a plugin's private functions in itself.
		-
			identifier: no.private.function
			message: '/function dominant_color_.*/'
			path: plugins/dominant-color-images/*
		-
			identifier: no.private.class
			message: '/class Image_Prioritizer_.*/'
			path: plugins/image-prioritizer/*
		-
			identifier: no.private.class
			message: '/class Embed_Optimizer_.*/'
			path: plugins/embed-optimizer/*
		-
			identifier: no.private.class
			message: '/class OD_.*/'
			path: plugins/optimization-detective/*
		-
			identifier: no.private.method
			message: '/class OD_.*/'
			path: plugins/optimization-detective/*
		-
			identifier: no.private.function
			message: '/function od_.*/'
			path: plugins/optimization-detective/*
		-
			identifier: no.private.function
			message: '/function webp_uploads_.*/'
			path: plugins/webp-uploads/*
		-
			identifier: no.private.function
			message: '/function plwwo_.*/'
			path: plugins/web-worker-offloading/*
		-
			identifier: no.private.function
			message: '/function embed_optimizer_.*/'
			path: plugins/embed-optimizer/*
		-
			identifier: no.private.function
			message: '/function image_prioritizer_.*/'
			path: plugins/image-prioritizer/*
		-
			identifier: no.private.function
			message: '/function plsr_.*/'
			path: plugins/speculation-rules/*
		-
			identifier: no.private.function
			message: '/function plvt_.*/'
			path: plugins/view-transitions/*
		-
			identifier: no.private.class
			message: '/class PLVT_.*/'
			path: plugins/view-transitions/*
		-
			identifier: no.private.function
			message: '/function perflab_.*/'
			path: plugins/performance-lab/*
		# Ignore require/include errors in test bootstraps that load files via the TESTS_PLUGIN_DIR sentinel, which is set to the plugin-under-test dir at runtime and cannot be modeled during analysis. See tools/phpstan/constants.php.
		-
			identifier: requireOnce.fileNotFound
			message: '#/tests-plugin-dir/#'
		-
			identifier: require.fileNotFound
			message: '#/tests-plugin-dir/#'
		# The build/*.asset.php files are generated by `npm run build`, which does not run in the PHPStan CI job. When they are present the error is not raised, hence reportUnmatched.
		-
			identifier: require.fileNotFound
			message: '#/build/.+\.asset\.php#'
			reportUnmatched: false
		-
			# Ignore error related to PHP 8 using a GdImage but PHP 7 using a resource.
			message: '/^Parameter .+? of function .+? expects resource, GdImage\|resource given\.$/'
			path: plugins/dominant-color-images/*.php
		# Hook callbacks receive their arguments positionally, so an unused parameter cannot be removed when a later one is used.
		-
			identifier: function.unusedParameter

		# The following ignored errors are all for tests. They are likely excessively strict and do not warrant being fixed.
		-
			identifier: argument.type
			path: */tests/*
		-
			identifier: offsetAccess.nonArray
			path: */tests/*
		-
			identifier: method.notFound
			path: */tests/*
		-
			identifier: offsetAccess.notFound
			path: */tests/*
		-
			identifier: encapsedStringPart.nonString
			path: */tests/*
		-
			identifier: assign.propertyType
			path: */tests/*
		-
			identifier: method.nonObject
			path: */tests/*
		-
			identifier: cast.string
			path: */tests/*
		-
			identifier: staticMethod.dynamicCall
			path: */tests/*
		-
			identifier: phpunit.assertEquals
			path: */tests/*
		-
			identifier: catch.internalClass
			path: */tests/*
		-
			identifier: method.alreadyNarrowedType
			path: */tests/*
		-
			identifier: no.private.method
			path: */tests/*
		-
			identifier: no.private.function
			path: */tests/*