PHP: PHPCS for a WordPress plugin.
<?xml version="1.0"?> | |
<ruleset name="WPS"> | |
<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="spvvv"/> <!-- 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.3-"/> | |
<!-- Rules: WooCommerce --> | |
<!-- https://github.com/woocommerce/woocommerce-sniffs/ --> | |
<rule ref="WooCommerce-Core" /> | |
<!-- https://github.com/PHPCompatibility/PHPCompatibilityWP --> | |
<rule ref="PHPCompatibility"> | |
<exclude-pattern>tests/</exclude-pattern> | |
</rule> | |
<!-- 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"/> | |
<!-- Rules: WordPress VIP --> | |
<!-- <rule ref="WordPress">--> | |
<!-- <exclude name="WordPress.VIP"/>--> | |
<!-- </rule>--> | |
<!-- Rules: WordPress Internationalization --> | |
<rule ref="WordPress.WP.I18n"> | |
<properties> | |
<!-- Value: replace the text domain used. --> | |
<property name="text_domain" type="array" value="storefront,setantabooks"/> | |
</properties> | |
</rule> | |
<!-- WordPress Coding Standards Modifications --> | |
<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="WPS\WP\Plugins,wps_"/> | |
</properties> | |
</rule> | |
<!-- Rules: Ignore Filename WordPress Coding Standards Rules in favor of PSR-4 --> | |
<rule ref="WordPress.WhiteSpace.ControlStructureSpacing"> | |
<properties> | |
<property name="blank_line_check" value="true"/> | |
</properties> | |
</rule> | |
<!-- Rules: Ignore Filename WordPress Coding Standards Rules in favor of PSR-4 --> | |
<rule ref="WordPress.Files.FileName.NotHyphenatedLowercase"> | |
<type>warning</type> | |
<exclude-pattern>/includes/</exclude-pattern> | |
</rule> | |
<rule ref="WordPress.Files.FileName.InvalidClassFileName"> | |
<type>warning</type> | |
<exclude-pattern>/includes/</exclude-pattern> | |
</rule> | |
<!-- Excluding Rules --> | |
<exclude name="WordPress.WhiteSpace.ControlStructureSpacing.BlankLineAfterEnd" /> | |
</ruleset> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment