phpcs.xml.dist

<?xml version="1.0"?>
<ruleset name="WordPress Coding Standards for Gutenberg Plugin">
	<description>Sniffs for WordPress plugins, with minor modifications for Gutenberg</description>

	<!-- Check for cross-version support for PHP 7.0 and higher. -->
	<config name="testVersion" value="7.0-"/>
	<rule ref="PHPCompatibilityWP">
		<include-pattern>*\.php$</include-pattern>
	</rule>

	<rule ref="WordPress-Core"/>
	<rule ref="WordPress.WP.I18n">
		<properties>
			<property name="text_domain" type="array">
				<element value="gutenberg"/>
				<element value="default"/>
			</property>
		</properties>
	</rule>

	<rule ref="VariableAnalysis.CodeAnalysis.VariableAnalysis">
		<properties>
			<property name="allowUnusedParametersBeforeUsed" value="true"/>
		</properties>
	</rule>

	<rule ref="PEAR.Functions.FunctionCallSignature">
		<properties>
			<property name="allowMultipleArguments" value="false"/>
		</properties>
	</rule>

	<rule ref="WordPress.WP.I18n.MissingArgDomainDefault">
		<exclude-pattern>lib/compat/*</exclude-pattern>
		<exclude-pattern>packages/block-library/src/*</exclude-pattern>
		<exclude-pattern>build/block-library/*</exclude-pattern>
	</rule>

	<arg value="ps"/>
	<arg name="extensions" value="php"/>

	<!-- Cache the scan results and re-use those for unchanged files on the next scan. -->
	<arg name="cache" value=".cache/phpcs.json"/>

	<file>./bin</file>
	<file>./gutenberg.php</file>
	<file>./lib</file>
	<file>./packages</file>
	<file>./phpunit</file>
	<file>./post-content.php</file>

	<!-- Exclude generated files -->
	<exclude-pattern>./packages/block-serialization-spec-parser/parser.php</exclude-pattern>
	<exclude-pattern>node_modules/*</exclude-pattern>
	<exclude-pattern>build/*</exclude-pattern>

	<!-- Exclude third party libraries -->
	<exclude-pattern>./vendor/*</exclude-pattern>
	<exclude-pattern>./test/php/gutenberg-coding-standards/*</exclude-pattern>

	<!-- Ignore filename error since it requires WP core build process change -->
	<rule ref="WordPress.Files.FileName.InvalidClassFileName">
		<exclude-pattern>/phpunit/*</exclude-pattern>
	</rule>

	<!-- Ignore empty files in tests/gutenberg-test-themes -->
	<rule ref="Internal.NoCodeFound">
		<exclude-pattern>./test/gutenberg-test-themes/*</exclude-pattern>
	</rule>

	<!-- Exclude PHPUnit tests from file and class name sniffs (for Core parity). -->
	<rule ref="WordPress.Files.FileName.NotHyphenatedLowercase">
		<exclude-pattern>/phpunit/*</exclude-pattern>
	</rule>
	<rule ref="PEAR.NamingConventions.ValidClassName.Invalid">
		<exclude-pattern>/phpunit/*</exclude-pattern>
	</rule>

	<!-- Enforce checks against redeclaration for functions and classes. -->
	<rule ref="Gutenberg.CodeAnalysis.GuardedFunctionAndClassNames">
		<exclude-pattern>./phpunit/*</exclude-pattern>
		<exclude-pattern>./packages/*</exclude-pattern>
		<exclude-pattern>./bin/generate-gutenberg-php</exclude-pattern>
		<properties>
			<property name="functionsWhiteList" type="array">
				<element value="/^_?gutenberg.+/"/>
			</property>
			<property name="classesWhiteList" type="array">
				<element value="/^Gutenberg.+/"/>
			</property>
		</properties>
	</rule>

	<rule ref="Gutenberg.NamingConventions.ValidBlockLibraryFunctionName">
		<include-pattern>./packages/block-library/src/*/*.php</include-pattern>
		<properties>
			<property name="prefixes" type="array">
				<element value="block_core_"/>
				<element value="render_block_core_"/>
				<element value="register_block_core_"/>
			</property>
			<!--
				The following list of functions is final and must not be extended.
				It includes functions that cannot be renamed due to backward compatibility concerns.
			-->
			<property name="allowed_functions" type="array">
				<element value="_delete_custom_logo_on_remove_site_logo"/>
				<element value="_delete_site_logo_on_remove_custom_logo"/>
				<element value="_delete_site_logo_on_remove_custom_logo_on_setup_theme"/>
				<element value="_delete_site_logo_on_remove_theme_mods"/>
				<element value="_override_custom_logo_theme_mod"/>
				<element value="_sync_custom_logo_to_site_logo"/>
				<element value="_wp_rest_api_autosave_meta"/>
				<element value="_wp_rest_api_force_autosave_difference"/>
				<element value="apply_block_core_search_border_style"/>
				<element value="apply_block_core_search_border_styles"/>
				<element value="build_dropdown_script_block_core_categories"/>
				<element value="build_template_part_block_area_variations"/>
				<element value="build_template_part_block_instance_variations"/>
				<element value="build_template_part_block_variations"/>
				<element value="build_variation_for_navigation_link"/>
				<element value="classnames_for_block_core_search"/>
				<element value="comments_block_form_defaults"/>
				<element value="enqueue_legacy_post_comments_block_styles"/>
				<element value="get_block_core_avatar_border_attributes"/>
				<element value="get_block_core_post_featured_image_border_attributes"/>
				<element value="get_block_core_post_featured_image_overlay_element_markup"/>
				<element value="get_border_color_classes_for_block_core_search"/>
				<element value="get_color_classes_for_block_core_search"/>
				<element value="get_typography_classes_for_block_core_search"/>
				<element value="get_typography_styles_for_block_core_search"/>
				<element value="gutenberg_block_core_file_update_interactive_view_script"/>
				<element value="gutenberg_block_core_navigation_update_interactive_view_script"/>
				<element value="post_comments_form_block_form_defaults"/>
				<element value="register_block_core_site_icon_setting"/>
				<element value="register_legacy_post_comments_block"/>
				<element value="styles_for_block_core_search"/>
				<element value="wp_add_footnotes_revisions_to_post_meta"/>
				<element value="wp_add_footnotes_to_revision"/>
				<element value="wp_get_footnotes_from_revision"/>
				<element value="wp_keep_footnotes_revision_id"/>
				<element value="wp_latest_comments_draft_or_post_title"/>
				<element value="wp_restore_footnotes_from_revision"/>
				<element value="wp_save_footnotes_meta"/>
			</property>
		</properties>
	</rule>
</ruleset>