<?xml version="1.0"?> <ruleset name="WordPress Coding Standards based custom ruleset for your plugin"> <description>Generally-applicable sniffs for WordPress plugins.</description> <!-- What to scan --> <file>.</file> <exclude-pattern>/vendor/</exclude-pattern> <exclude-pattern>/node_modules/</exclude-pattern> <!-- How to scan --> <!-- Usage instructions: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage --> <!-- Annotated ruleset: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml --> <arg value="sp"/> <!-- Show sniff and progress --> <arg name="basepath" value="./"/><!-- Strip the file paths down to the relevant bit --> <arg name="colors"/> <arg name="extensions" value="php"/> <arg name="parallel" value="8"/><!-- Enables parallel processing when available for faster results. --> <!-- Rules: Check PHP version compatibility --> <!-- https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions --> <config name="testVersion" value="5.6-"/> <!-- https://github.com/PHPCompatibility/PHPCompatibilityWP --> <rule ref="PHPCompatibilityWP"/> <!-- Rules: WordPress Coding Standards --> <!-- https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards --> <!-- https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties --> <config name="minimum_supported_wp_version" value="4.6"/> <rule ref="WordPress"/> <rule ref="WordPress.NamingConventions.PrefixAllGlobals"> <properties> <!-- Value: replace the function, class, and variable prefixes used. Separate multiple prefixes with a comma. --> <property name="prefixes" type="array" value="lingotek"/> </properties> </rule> <rule ref="WordPress.WP.I18n"> <properties> <!-- Value: replace the text domain used. --> <property name="text_domain" type="array" value="lingotek-translation"/> </properties> </rule> <rule ref="WordPress.WhiteSpace.ControlStructureSpacing"> <properties> <property name="blank_line_check" value="true"/> </properties> </rule> <!-- ltk: Starting Lingotek customizations. We should include these rules, but let's go step by step. --> <rule ref="Generic.Commenting"> <exclude name="Generic.Commenting.DocComment.ShortNotCapital"/> </rule> <rule ref="Squiz.Commenting"> <exclude name="Squiz.Commenting.FunctionComment.Missing" /> <exclude name="Squiz.Commenting.InlineComment" /> <exclude name="Squiz.Commenting.FunctionComment.MissingParamComment" /> <exclude name="Squiz.Commenting.FileComment.Missing"/> <exclude name="Squiz.Commenting.FunctionComment.MissingParamTag"/> </rule> <rule ref="WordPress.Files.FileName"> <exclude name="WordPress.Files.FileName.InvalidClassFileName" /> </rule> <rule ref="WordPress.NamingConventions.PrefixAllGlobals"> <exclude name="WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedVariableFound" /> <exclude name="WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedConstantFound" /> </rule> <!-- ltk: These are dangerous to change, as involve method renaming.' --> <rule ref="PSR2.Methods.MethodDeclaration"> <exclude name="PSR2.Methods.MethodDeclaration.Underscore"/> </rule> <rule ref="WordPress.NamingConventions.ValidFunctionName"> <exclude name="WordPress.NamingConventions.ValidFunctionName" /> </rule> <rule ref="WordPress.PHP.DisallowShortTernary.Found"> <type>warning</type> </rule> <rule ref="WordPress.PHP.StrictComparisons.LooseComparison"> <type>warning</type> </rule> </ruleset>