phpcs.xml

<?xml version="1.0" ?>
<!--
	WPPOOL Coding Standard

	@package WPPOOL_CS
	@version 1.0.0
-->
<ruleset name="WPPOOLCS">

    <description>WPPOOL Coding Standard</description>

	<!-- Excludes  -->
	<exclude-pattern>*/node_modules/*</exclude-pattern>
	<exclude-pattern>*/vendor/*</exclude-pattern>

	<!-- 
		####                   ####
		#### No Need to Modify ####
		####                   ####
	-->

    <!-- Scan all files in directory -->
    <file>.</file>

    <!-- Scan only PHP files -->
    <arg name="extensions" value="php" />

	<!-- Show progress -->
    <arg value="ps" />

	<!-- Show colors in console -->
	<arg name="colors" />

	<!-- Paraller file checking -->
	<arg name="parallel" value="20" />

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

	<!-- 
		####              ####
		#### PHP Rulesets ####
		####              ####
	-->

	<!-- Minimum version of PHP required to run the plugin.  -->
	<config name="testVersion" value="5.6-" />

	<!-- Check PHP version compatibility. -->
	<!-- <rule ref="PHPCompatibility" /> -->

	<!-- Allow tab indent  -->
	<rule ref="Generic.WhiteSpace.DisallowTabIndent">
		<exclude name="Generic.WhiteSpace.DisallowTabIndent.TabsUsed" />
	</rule>

	
	<!-- Generic.Arrays.DisallowLongArraySyntax  -->
	<rule ref="Generic.Arrays.DisallowLongArraySyntax" />

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

	<!-- Generic.Commenting -->
	<rule ref="Generic.Commenting" />

	<!-- Generic.CodeAnalysis -->
	<rule ref="Generic.CodeAnalysis" />

	<!-- spacing and indentation -->
	<rule ref="Generic.WhiteSpace" />

	<!-- whitespace in function arguements  -->
	<rule ref="Generic.Functions.FunctionCallArgumentSpacing">
		<exclude
      name="Generic.Functions.FunctionCallArgumentSpacing.NoSpaceAfterComma"
    />
	</rule>

	<!-- ignore Generic.Files.EndFileNewline.NotFound  -->
	<rule ref="Generic.Files.EndFileNewline">
		<exclude name="Generic.Files.EndFileNewline.NotFound" />
	</rule>
	

	<!-- Nested level of condition is 3 ro reduce code complexity -->
	<rule ref="Generic.CodeAnalysis.ForLoopWithTestFunctionCall">
		<properties>
			<property name="maxNestedLevel" value="3" />
		</properties>
	</rule>

	<rule ref="PEAR.Functions.FunctionCallSignature.EmptyLine" />

	<!-- Check class exists  -->
	<rule ref="Generic.Classes.DuplicateClassName">
		<type>warning</type>
	</rule>

	<!-- Missing Package Tag  -->
	<rule ref="Squiz.Commenting.FileComment.MissingPackageTag" />
	<rule ref="Squiz.Commenting.FileComment.Missing" />

	<!-- Squize  -->
	<rule
    ref="Squiz.Classes.ClassFileName"
  /> <!-- Class name doesn't match filename -->
	<rule ref="Squiz.Classes.ValidClassName" /> <!-- Valid class name -->
	<rule
    ref="Squiz.Commenting.FunctionCommentThrowTag.Missing"
  /> <!-- Missing @throws tag in function comment -->
	<rule
    ref="Squiz.Commenting.FileComment.Missing"
  /> <!-- Missing file doc comment -->

	<!-- Ignore class name validation  -->
	<rule ref="Squiz.Classes.ValidClassName">
		<exclude name="Squiz.Classes.ValidClassName.NotCamelCaps" />
	</rule>

	<!-- Squiz.Classes.ClassFileName -->
	<rule ref="Squiz.Classes.ClassFileName">
		<exclude name="Squiz.Classes.ClassFileName.NoMatch" />
	</rule>
	
	<!-- 
		####                    ####
		#### WordPress Rulesets ####
		####                    ####
	-->

    <config name="minimum_supported_wp_version" value="5.2" />

    <!-- WordPress; WordPress Standard, Security, Files, Docs, Extra Everything -->
    <rule ref="WordPress" /> 
    <rule ref="WordPress-Core" /> 
    <rule ref="WordPress-Docs" /> 
    <rule ref="WordPress-Extra" /> 

	<!-- Allow short ternary (codition ? true : false) -->
	<rule ref="WordPress.PHP.DisallowShortTernary.Found" />

	<!-- exclude WordPress InvalidClassFileName  -->
	<rule ref="WordPress.Files.FileName">
		<exclude name="WordPress.Files.FileName.InvalidClassFileName" />
		<exclude name="WordPress.NamingConventions.ValidFunctionName.MethodDoubleUnderscore" />
		<exclude name="WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid" />
		<exclude name="WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase" />
		<exclude name="WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase" />
		<exclude name="WordPress.NamingConventions.ValidVariableName.PropertyNotSnakeCase" />
	</rule>
	<!-- exclude WordPress InvalidClassFileName  -->
	<rule ref="WordPress.Files.FileName.NotHyphenatedLowercase">
		<exclude name="WordPress.Files.FileName.NotHyphenatedLowercase" />
	</rule>

	<!-- exclude WordPress.PHP.StrictInArray.FoundNonStrictFalse -->
	<rule ref="WordPress.PHP.StrictInArray">
		<exclude name="WordPress.PHP.StrictInArray.FoundNonStrictFalse" />
		<exclude name="WordPress.PHP.StrictInArray.MissingTrueStrict" />	
	</rule>

	<!-- 
		####                     		   ####
		#### End of WPPOOL Coding Standard ####
		####                    		   ####
	-->

</ruleset>