phpcs.xml.dist

<?xml version="1.0"?>
<ruleset name="WordPress Theme Coding Standards">
	<!-- See https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
	<!-- See https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards -->
	<!-- See https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki -->
	<!-- See https://github.com/wimg/PHPCompatibility -->

	<!-- Set a description for this ruleset. -->
	<description>A custom set of code standard rules to check for WordPress themes.</description>

	<!--
	#############################################################################
	COMMAND LINE ARGUMENTS
	https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml
	#############################################################################
	-->

	<!-- Only check the PHP, CSS and SCSS files. JS files are checked separately with JSCS and JSHint. -->
	<arg name="extensions" value="php"/>

	<!-- Show sniff codes in all reports -->
	<arg value="s"/>

	<!-- Check all files in this directory and the directories below it. -->
	<file>.</file>

	<!-- Strip the filepaths down to the relevant bit. -->
	<arg name="basepath" value="./" />

	<!-- Check up to 20 files simultaneously. -->
	<arg name="parallel" value="20" />

	<rule ref="Squiz.Classes.ClassFileName">
		<exclude-pattern>tests/**</exclude-pattern>
	</rule>

	<rule ref="PSR1.Classes.ClassDeclaration">
		<exclude-pattern>tests/**</exclude-pattern>
	</rule>

	<!--
	#############################################################################
	USE THE WordPress RULESET
	#############################################################################
	-->

	<rule ref="rtCampWP">
		<!-- Excluding sniff to allow shorthand array syntax usage. -->
		<exclude name="Universal.Arrays.DisallowShortArraySyntax.Found" />
	</rule>

	<!--
	#############################################################################
	SNIFF SPECIFIC CONFIGURATION
	#############################################################################
	-->

	<!-- Verify that the text_domain is set to the desired text-domain.
		Add one <element> per additional valid text domain. -->
	<rule ref="WordPress.WP.I18n">
		<properties>
			<property name="text_domain" type="array">
				<element value="elementary-theme"/>
			</property>
		</properties>
	</rule>

	<!-- Allow for theme specific exceptions to the file name rules based
		on the theme hierarchy. -->
	<rule ref="WordPress.Files.FileName">
		<properties>
			<property name="is_theme" value="true"/>
		</properties>
		<exclude name="WordPress.Files.FileName.InvalidClassFileName" />
		<exclude name="WordPress.Files.FileName.NotHyphenatedLowercase" />
	</rule>

	<!-- Set the minimum supported WP version. This is used by several sniffs.
		The minimum version set here should be in line with the minimum WP version
		as set in the "Requires at least" tag in the readme.txt file. -->
	<config name="minimum_supported_wp_version" value="6.6"/>

	<rule ref="WordPress.Arrays.MultipleStatementAlignment">
		<properties>
			<!-- No need to adjust alignment of large arrays when the item with the largest key is removed. -->
			<property name="exact" value="false"/>
			<!-- Don't align multi-line items if ALL items in the array are multi-line. -->
			<property name="alignMultilineItems" value="!=100"/>
			<!-- Array assignment operator should always be on the same line as the array key. -->
			<property name="ignoreNewlines" value="false"/>
		</properties>
	</rule>

	<!-- Verify that everything in the global namespace is prefixed with a theme specific prefix.
		Multiple valid prefixes can be provided as a comma-delimited list. -->
	<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
		<properties>
			<property name="prefixes" type="array">
				<element value="elementary_theme"/>
				<element value="ELEMENTARY_THEME"/>
				<element value="rtCamp\Theme\Elementary"/>
			</property>
		</properties>
		<exclude-pattern>tests/bootstrap.php</exclude-pattern>
		<!-- Component partials are always require'd inside ComponentLoader::render(), so variables are method-scoped at runtime. -->
		<exclude-pattern>src/components/*</exclude-pattern>
	</rule>

	<rule ref="WordPress-Docs">
		<exclude-pattern>tests/*</exclude-pattern>
	</rule>

	<!-- The wp:example:* region markers in inc/Main.php are intentional scaffold tags
	     (stripped by `npm run init`), not prose comments, so exempt just those lines
	     from the inline-comment end-char rule. -->
	<rule ref="Squiz.Commenting.InlineComment.InvalidEndChar">
		<exclude-pattern>inc/Main.php</exclude-pattern>
	</rule>

	<rule ref="WordPress-VIP-Go">
		<exclude-pattern>tests/*</exclude-pattern>
	</rule>

	<!--
		rtCampWP bundles the VIP sniffs itself, so the exclusion above (which only
		applies to this ruleset's own WordPress-VIP-Go reference) no longer reaches
		them. Tests legitimately write temp fixtures; the VIP filesystem restrictions
		target production runtime code.
	-->
	<rule ref="WordPressVIPMinimum.Functions.RestrictedFunctions">
		<exclude-pattern>tests/*</exclude-pattern>
	</rule>

	<!-- Tests read local fixture files; the caching advice is about remote URLs. -->
	<rule ref="WordPressVIPMinimum.Performance.FetchingRemoteData">
		<exclude-pattern>tests/*</exclude-pattern>
	</rule>

	<rule ref="WordPress.WP.GlobalVariablesOverride.Prohibited">
		<exclude-pattern>tests/*</exclude-pattern>
		<!-- Component partials are always require'd inside ComponentLoader::render(), so variables are method-scoped at runtime. -->
			<exclude-pattern>src/components/*</exclude-pattern>
	</rule>

	<!--
	#############################################################################
	USE THE PHPCompatibility RULESET
	#############################################################################
	-->

	<!-- PHP compatibility range: 8.2 minimum -->
	<config name="testVersion" value="8.2-"/>
	<rule ref="PHPCompatibilityWP">
		<exclude name="Generic.Arrays.DisallowShortArraySyntax.Found"/>
	</rule>

	<!-- Exclude patterns folder -->
	<exclude-pattern>*patterns/*</exclude-pattern>

	<!-- Third-party or auto-generated code -->
	<exclude-pattern>*/build/*</exclude-pattern>
	<exclude-pattern>*/data/*</exclude-pattern>
	<exclude-pattern>packages/e2e-tests/src/plugins/*</exclude-pattern>
	<exclude-pattern>*/node_modules/*</exclude-pattern>
	<exclude-pattern>*/third-party/*</exclude-pattern>
	<exclude-pattern>*/vendor/*</exclude-pattern>
	<exclude-pattern>assets/js/*.asset.php</exclude-pattern>
	<exclude-pattern>assets/js/*.chunks.php</exclude-pattern>
	<exclude-pattern>includes/polyfills/mbstring.php</exclude-pattern>
	<exclude-pattern>tests/phpstan/*</exclude-pattern>
	<exclude-pattern>tests/phpunit/includes/MarkupComparison.php</exclude-pattern>

</ruleset>