<?xml version="1.0"?>
<ruleset>
	<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki" />

	<rule ref="Generic.PHP.RequireStrictTypes" />

	<!-- Starting a function's body with an empty line can be helpful after a very large header.
		The code is not guaranteed to be easier to read if this is disallowed. -->
	<rule ref="Squiz.WhiteSpace.FunctionOpeningBraceSpace.SpacingAfter">
		<severity>0</severity>
	</rule>

	<!-- Even if we encourage to use spaces in comments, we don't think this sniff should block
		patches from being merged. -->
	<rule ref="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment">
		<severity>0</severity>
	</rule>

	<!-- Disallows any content outside of <?php … ?> tags. -->
	<rule ref="Generic.Files.InlineHTML" />

	<rule ref="MediaWiki.NamingConventions.LowerCamelFunctionsName">
		<!-- Exclude test methods like "testGivenInvalidInput_methodThrowsException". -->
		<exclude-pattern>tests*Test*\.php</exclude-pattern>
	</rule>

	<!-- NOTE: We can not use the Squiz.Arrays.ArrayBracketSpacing sniff because it conflicts with
		the MediaWiki style that encourages to use spaces inside brackets, see
		https://www.mediawiki.org/wiki/Manual:Coding_conventions/JavaScript#Whitespace -->

	<rule ref="Squiz.Functions.GlobalFunction" />

	<rule ref="MediaWiki.Classes.FullQualifiedClassName">
		<severity>5</severity>
		<properties>
			<property name="allowFunctions" value="false" />
		</properties>
	</rule>

	<rule ref="MediaWiki.Commenting.ClassLevelLicense">
		<properties>
			<property name="license" value="GPL-2.0-or-later" />
		</properties>
	</rule>

	<rule ref="MediaWiki.Arrays.TrailingComma">
		<properties>
			<property name="singleLine" value="false" />
			<property name="multiLine" value="true" />
		</properties>
	</rule>

	<rule ref="Generic.Metrics.CyclomaticComplexity">
		<exclude-pattern>AutocommentFormatter\.php</exclude-pattern>
	</rule>
	<rule ref="Generic.Metrics.NestingLevel" />
	<rule ref="Squiz.Strings.DoubleQuoteUsage">
		<exclude name="Squiz.Strings.DoubleQuoteUsage.ContainsVar" />
	</rule>

	<file>.</file>
	<arg name="extensions" value="php" />
	<arg name="encoding" value="UTF-8" />
	<exclude-pattern>.phan/stubs</exclude-pattern>
	<exclude-pattern>cypress/.cache</exclude-pattern>
</ruleset>
