phpcs.xml

<?xml version="1.0"?>
<ruleset name="Bleech-WordPress-CS">
	<!-- See https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage -->
	<!-- 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 -->

	<description>Ruleset for Bleech WordPress Plugins.</description>

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

	<exclude-pattern>*/build/*</exclude-pattern>
	<exclude-pattern>*/vendor/*</exclude-pattern>
	<exclude-pattern>*/svn/*</exclude-pattern>
	<exclude-pattern>*/node_modules/*</exclude-pattern>
	<exclude-pattern>includes/core/libraries/*</exclude-pattern>
	<exclude-pattern>components/emails/*</exclude-pattern>

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

	<!-- Pass some flags to PHPCS:
		 p flag: Show progress of the run.
		 s flag: Show sniff codes in all reports.
		 v flag: Print verbose output.
		 n flag: Do not print warnings.
		 sp
	-->
	<arg value="sp"/>

	<!-- Enable colors in report. -->
	<arg name="colors"/>

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

	<!-- Only check the PHP files. -->
	<arg name="extensions" value="php"/>

	<!-- Check for PHP cross-version compatibility. -->
	<config name="testVersion" value="7.0-"/>
	<rule ref="PHPCompatibilityWP"/>

	<!-- Check for WordPress cross-version compatibility. -->
	<config name="minimum_supported_wp_version" value="5.0"/>

	<!-- Let's check that everything is properly documented. -->
	<rule ref="WordPress-Docs"/>

	<!-- Include the WordPress-Extra standard. -->
	<rule ref="WordPress-Extra" />

	<!-- Allow theme filename exceptions e.g. archive-{post_type}.php -->
	<rule ref="WordPress.Files.FileName">
		<properties>
			<property name="is_theme" value="true"/>
		</properties>
	</rule>

	<!-- Allow short Ternary -->
	<rule ref="WordPress.PHP.DisallowShortTernary.Found">
		<exclude name="WordPress.PHP.DisallowShortTernary.Found" />
	</rule>

	<!-- Allow short array syntax -->
	<rule ref="Generic.Arrays.DisallowShortArraySyntax.Found">
		<exclude name="Generic.Arrays.DisallowShortArraySyntax.Found" />
	</rule>

	<!-- Disallow long array syntax -->
	<rule ref="Generic.Arrays.DisallowLongArraySyntax" />

	<!-- Don't align equal signs -->
	<rule ref="Generic.Formatting.MultipleStatementAlignment.NotSameWarning">
		<exclude name="Generic.Formatting.MultipleStatementAlignment.NotSameWarning" />
	</rule>

	<!-- Don't aligned array double arrow -->
	<rule ref="WordPress.Arrays.MultipleStatementAlignment">
		<exclude name="WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned" />
	</rule>

	<!-- Class and file comments aren't neccessary -->
	<rule ref="Squiz.Commenting">
		<exclude name="Squiz.Commenting.FileComment.Missing" />
		<exclude name="Squiz.Commenting.FileComment.MissingPackageTag" />
		<exclude name="Squiz.Commenting.ClassComment.Missing" />
	</rule>

	<!-- Useful code analysis sniffs. -->
	<rule ref="WordPress.CodeAnalysis"/>

	<!-- Date Time sniffs. -->
	<rule ref="WordPress.DateTime"/>

	<!-- Database sniffs. -->
	<rule ref="WordPress.DB"/>

	<!-- Security sniffs. -->
	<rule ref="WordPress.Security"/>

	<!-- I18n sniffs. -->
	<rule ref="WordPress.Utils.I18nTextDomainFixer"/>

	<!-- <rule ref="Generic.Commenting.DocComment.NonParamGroup">
		<exclude name="Generic.Commenting.DocComment.NonParamGroup" />
	</rule> -->

	<rule ref="PEAR.Functions.FunctionCallSignature">
		<exclude name="PEAR.Functions.FunctionCallSignature.ContentAfterOpenBracket" />
		<exclude name="PEAR.Functions.FunctionCallSignature.CloseBracketLine" />
		<exclude name="PEAR.Functions.FunctionCallSignature.MultipleArguments" />
	</rule>

	<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
		<exclude-pattern>/includes/core/settings/field-*/</exclude-pattern>
		<exclude-pattern>/components/</exclude-pattern>
		<properties>
			<property name="prefixes" type="array">
				<element value="vrts"/>
			</property>
		</properties>
	</rule>

</ruleset>