c453749f7a
The `-n` flag will ignore warnings completely, while often it is useful to see them and to fix them. Using `--runtime-set ignore_warnings_on_exit 1` in the Travis script instead, warnings will be shown, both when a developer runs PHPCS on their own machine, as well as in Travis, but warnings will not cause a failed Travis build. The `-v` flag will list each file being scanned. This is intended for debugging purposes and not needed for normal use.
85 lines
2.9 KiB
XML
85 lines
2.9 KiB
XML
<?xml version="1.0"?>
|
|
<ruleset name="WordPress Theme Coding Standards">
|
|
<!-- 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 -->
|
|
|
|
<!-- Set a description for this ruleset. -->
|
|
<description>A custom set of code standard rules to check for WordPress themes.</description>
|
|
|
|
|
|
<!--
|
|
#############################################################################
|
|
COMMAND LINE ARGUMENTS
|
|
https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml
|
|
#############################################################################
|
|
-->
|
|
|
|
<!-- Pass some flags to PHPCS:
|
|
p flag: Show progress of the run.
|
|
s flag: Show sniff codes in all reports.
|
|
-->
|
|
<arg value="ps"/>
|
|
|
|
<!-- Only check the PHP, CSS and SCSS files. JS files are checked separately with JSCS and JSHint. -->
|
|
<arg name="extensions" value="php,css,scss/css"/>
|
|
|
|
<!-- Check all files in this directory and the directories below it. -->
|
|
<file>.</file>
|
|
|
|
|
|
<!--
|
|
#############################################################################
|
|
USE THE WordPress RULESET
|
|
#############################################################################
|
|
-->
|
|
|
|
<rule ref="WordPress">
|
|
<exclude name="Generic.WhiteSpace.ScopeIndent.IncorrectExact"/>
|
|
<exclude name="Generic.WhiteSpace.ScopeIndent.Incorrect"/>
|
|
<exclude name="PEAR.Functions.FunctionCallSignature.Indent"/>
|
|
</rule>
|
|
|
|
|
|
<!--
|
|
#############################################################################
|
|
SNIFF SPECIFIC CONFIGURATION
|
|
#############################################################################
|
|
-->
|
|
|
|
<!-- Verify that the text_domain is set to the desired text-domain.
|
|
Multiple valid text domains can be provided as a comma-delimited list. -->
|
|
<rule ref="WordPress.WP.I18n">
|
|
<properties>
|
|
<property name="text_domain" type="array" value="_s"/>
|
|
</properties>
|
|
</rule>
|
|
|
|
<!-- Allow for theme specific exceptions to the file name rules based
|
|
on the theme hierarchy. -->
|
|
<rule ref="WordPress.Files.FileName">
|
|
<properties>
|
|
<property name="is_theme" value="true"/>
|
|
</properties>
|
|
</rule>
|
|
|
|
<!-- Verify that no WP functions are used which are deprecated or have been removed.
|
|
The minimum version set here should be in line with the minimum WP version
|
|
as set in the "Requires at least" tag in the readme.txt file. -->
|
|
<rule ref="WordPress.WP.DeprecatedFunctions">
|
|
<properties>
|
|
<property name="minimum_supported_version" value="4.0"/>
|
|
</properties>
|
|
</rule>
|
|
|
|
|
|
<!--
|
|
#############################################################################
|
|
USE THE PHPCompatibility RULESET
|
|
#############################################################################
|
|
-->
|
|
|
|
<config name="testVersion" value="5.2-99.0"/>
|
|
<rule ref="PHPCompatibility"/>
|
|
</ruleset>
|