phpcs.xml.dist

<?xml version="1.0"?>
<ruleset name="WordPress Coding Standards for GlotPress">

	<!-- Check all PHP files in directory tree by default. -->
	<arg name="extensions" value="php"/>

	<!-- Allow invoking just `phpcs` on command line without assuming STDIN for file input. -->
	<file>.</file>

	<!-- Show progress and sniff codes in all reports -->
	<arg value="ps"/>

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

	<!-- Whenever possible, cache the scan results and re-use those for unchanged files on the next scan. -->
	<arg name="cache"/>

	<rule ref="WordPress-Core">
		<exclude name="WordPress.Files.FileName.InvalidClassFileName" />
		<exclude name="WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents" />
		<exclude name="WordPress.WP.AlternativeFunctions.file_system_read_file_get_contents" />
	</rule>
	<rule ref="WordPress-Docs" />
	<rule ref="WordPress-Extra">
		<!-- _e() and _ex() are considered safe for translations. -->
		<exclude name="WordPress.Security.EscapeOutput.UnsafePrintingFunction" />
	</rule>

	<rule ref="WordPress.Security.EscapeOutput">
		<properties>
			<property name="customEscapingFunctions" type="array">
				<element value="esc_translation"/>
				<element value="gp_esc_attr_with_entities"/>
			</property>
			<property name="customAutoEscapedFunctions" type="array">
				<element value="gp_radio_buttons"/>
				<element value="gp_select"/>
				<element value="gp_projects_dropdown"/>
				<element value="gp_locales_dropdown"/>
				<element value="gp_locales_by_project_dropdown"/>
				<element value="gp_link"/>
				<element value="gp_link_get"/>
				<element value="gp_link_glossary_edit_get"/>
				<element value="gp_link_glossary_delete_get"/>
				<element value="gp_link_set_edit_get"/>
				<element value="gp_link_set_delete_get"/>
				<element value="gp_link_project_get"/>
				<element value="gp_link_project_edit_get"/>
				<element value="gp_link_project_delete_get"/>
				<element value="gp_link_home_get"/>
				<element value="gp_link_with_ays_get"/>
				<element value="gp_link_user"/>
				<element value="gp_js_focus_on"/>
				<element value="gp_translation_row_classes"/>
				<element value="gp_pagination"/>
				<element value="gp_array_of_things_to_json"/>
				<element value="gp_array_of_array_of_things_to_json"/>
				<element value="gp_project_options_form"/>
				<element value="prepare_original"/>
				<element value="gp_prepare_translation_textarea"/>
				<element value="display_status"/>
				<element value="gp_nav_menu"/>
				<element value="gp_breadcrumb"/>
				<element value="gp_notice"/>
				<element value="gp_title"/>

				<!-- i18n functions are considered safe for translations. -->
				<element value="__"/>
				<element value="_x"/>
				<element value="_n"/>
				<element value="_nx"/>
				<element value="number_format_i18n"/>
				<element value="date_i18n"/>
				<element value="human_time_diff"/>
			</property>
		</properties>
	</rule>

	<rule ref="Generic.WhiteSpace.ScopeIndent">
		<exclude-pattern>/gp-templates/*</exclude-pattern>
		<exclude-pattern>/locales/*</exclude-pattern>
	</rule>

	<rule ref="WordPress.WP.I18n">
		<properties>
			<property name="text_domain" value="glotpress" />
		</properties>
	</rule>

	<rule ref="WordPress.Arrays.MultipleStatementAlignment">
		<properties>
			<property name="maxColumn" value="80"/>
		</properties>
	</rule>

	<rule ref="Generic.Commenting.DocComment.MissingShort">
		<!-- Temporarily disabled until https://github.com/WordPress/WordPress-Coding-Standards/issues/403 is fixed. -->
		<severity>0</severity>
	</rule>

	<!-- Set minimum supported WordPress version. -->
	<config name="minimum_supported_wp_version" value="4.6"/>

	<!-- Run against the PHPCompatibilityWP ruleset -->
	<rule ref="PHPCompatibilityWP"/>

	<!-- GlotPress currently supports PHP 7.2+. -->
	<config name="testVersion" value="7.2-"/>

	<exclude-pattern>/tests/*</exclude-pattern>
	<exclude-pattern>/node_modules/*</exclude-pattern>
	<exclude-pattern>/vendor/*</exclude-pattern>
	<exclude-pattern>/locales/*</exclude-pattern>
	<exclude-pattern>/bin/*</exclude-pattern>
</ruleset>