woocommerce/phpcs.xml

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

	<description>WooCommerce dev PHP_CodeSniffer ruleset.</description>

	<!-- Exclude paths -->
	<exclude-pattern>tests/cli/</exclude-pattern>
	<exclude-pattern>apigen/</exclude-pattern>
	<exclude-pattern>includes/gateways/simplify-commerce</exclude-pattern>
	<exclude-pattern>includes/libraries/</exclude-pattern>
	<exclude-pattern>includes/legacy/</exclude-pattern>
	<exclude-pattern>includes/api/legacy/</exclude-pattern>
	<exclude-pattern>includes/api/v1/</exclude-pattern>
	<exclude-pattern>includes/class-wc-geo-ip.php</exclude-pattern>
	<exclude-pattern>includes/wc-deprecated-functions.php</exclude-pattern>
	<exclude-pattern>*/node_modules/*</exclude-pattern>
	<exclude-pattern>*/vendor/*</exclude-pattern>

	<!-- Configs -->
	<config name="minimum_supported_wp_version" value="4.7" />
	<config name="testVersion" value="5.2-"/>

	<!-- Rules -->
	<rule ref="WooCommerce-Core" />
	<rule ref="PHPCompatibility">
		<exclude name="PHPCompatibility.PHP.NewFunctions.hash_equalsFound" />
		<exclude name="PHPCompatibility.PHP.NewInterfaces.jsonserializableFound" />
		<exclude name="PHPCompatibility.PHP.NewKeywords.t_namespaceFound" />
		<exclude-pattern>tests/</exclude-pattern>
	</rule>

	<rule ref="WordPress">
		<exclude name="WordPress.VIP.DirectDatabaseQuery.NoCaching" />
		<exclude name="WordPress.VIP.DirectDatabaseQuery.DirectQuery" />
		<exclude name="WordPress.VIP.DirectDatabaseQuery.SchemaChange" />
		<exclude name="WordPress.VIP.FileSystemWritesDisallow.file_ops_fwrite" />
		<exclude name="WordPress.VIP.OrderByRand" />
		<exclude name="WordPress.VIP.RestrictedFunctions" />
		<exclude name="WordPress.VIP.RestrictedVariables.user_meta__wpdb__usermeta" />
		<exclude name="WordPress.VIP.PostsPerPage.posts_per_page_posts_per_page" />
		<exclude name="WordPress.VIP.RestrictedVariables.cache_constraints___COOKIE" />
	</rule>
	<rule ref="WordPress.VIP.ValidatedSanitizedInput">
		<properties>
			<property name="customSanitizingFunctions" type="array" value="wc_clean,wc_sanitize_tooltip,wc_format_decimal,wc_stock_amount,wc_sanitize_permalink,wc_sanitize_textarea" />
		</properties>
	</rule>
	<rule ref="WordPress.XSS.EscapeOutput">
		<properties>
			<property name="customEscapingFunctions" type="array" value="wc_help_tip,wc_sanitize_tooltip" />
		</properties>
	</rule>
	<rule ref="WordPress.WP.I18n">
		<properties>
			<property name="text_domain" type="array" value="woocommerce" />
		</properties>
	</rule>
	<rule ref="WordPress.Files.FileName.InvalidClassFileName">
		<exclude-pattern>includes/**/abstract-*.php</exclude-pattern>
		<exclude-pattern>tests/*</exclude-pattern>
	</rule>
	<rule ref="Generic.Commenting">
		<exclude-pattern>tests/</exclude-pattern>
	</rule>
	<rule ref="Squiz.Commenting">
		<exclude-pattern>tests/</exclude-pattern>
		<exclude name="Squiz.Commenting.LongConditionClosingComment" />
		<exclude name="Squiz.Commenting.PostStatementComment" />
	</rule>
	<rule ref="PEAR.Functions.FunctionCallSignature.EmptyLine">
		<exclude-pattern>tests/e2e-tests/</exclude-pattern>
	</rule>
	<rule ref="WordPress.Files.FileName.NotHyphenatedLowercase">
		<exclude-pattern>i18n/</exclude-pattern>
	</rule>

	<!-- CLI commands require PHP >= 5.5 instead of 5.2 -->
	<rule ref="PHPCompatibility.PHP.NewLanguageConstructs.t_ns_separatorFound">
		<exclude-pattern>includes/cli/</exclude-pattern>
	</rule>
	<rule ref="PHPCompatibility.PHP.NewFunctions.array_columnFound">
		<exclude-pattern>includes/cli/</exclude-pattern>
	</rule>
	<rule ref="PHPCompatibility.PHP.NewClosure.Found">
		<exclude-pattern>includes/cli/</exclude-pattern>
	</rule>
	<rule ref="WordPress.Files.FileName.NotHyphenatedLowercase">
		<exclude-pattern>i18n/</exclude-pattern>
	</rule>
</ruleset>