<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[56593] trunk/phpcs.xml.dist: Coding Standards: Improve organization of the WPCS-based PHPCS ruleset.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/56593">56593</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/56593","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-09-15 09:06:23 +0000 (Fri, 15 Sep 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Coding Standards: Improve organization of the WPCS-based PHPCS ruleset.
This commit:
* Adds section headers to the ruleset file.
* Organizes all directives in their respective sections.
No functional changes.
Props jrf.
See <a href="https://core.trac.wordpress.org/ticket/59161">#59161</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkphpcsxmldist">trunk/phpcs.xml.dist</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkphpcsxmldist"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/phpcs.xml.dist</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/phpcs.xml.dist 2023-09-15 07:49:27 UTC (rev 56592)
+++ trunk/phpcs.xml.dist 2023-09-15 09:06:23 UTC (rev 56593)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2,6 +2,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <ruleset name="WordPress Coding Standards">
</span><span class="cx" style="display: block; padding: 0 10px"> <description>Apply WordPress Coding Standards to all Core files</description>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <!--
+ #############################################################################
+ COMMAND LINE ARGUMENTS
+ https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-Ruleset
+ #############################################################################
+ -->
+
</ins><span class="cx" style="display: block; padding: 0 10px"> <!-- Only scan PHP files. -->
</span><span class="cx" style="display: block; padding: 0 10px"> <arg name="extensions" value="php"/>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,81 +30,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <!-- Show sniff codes in all reports. -->
</span><span class="cx" style="display: block; padding: 0 10px"> <arg value="ps"/>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <!--
+ #############################################################################
+ FILE SELECTION
+ Set which files will be subject to the scans executed using this ruleset.
+ #############################################################################
+ -->
+
</ins><span class="cx" style="display: block; padding: 0 10px"> <file>.</file>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <rule ref="WordPress-Core"/>
- <rule ref="WordPress.CodeAnalysis.EmptyStatement"/>
-
- <!-- These rules are being set as warnings instead of errors, so we can error check the entire codebase. -->
- <rule ref="WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase">
- <type>warning</type>
- </rule>
- <rule ref="WordPress.DB.PreparedSQL.InterpolatedNotPrepared">
- <type>warning</type>
- </rule>
- <rule ref="WordPress.DB.PreparedSQL.NotPrepared">
- <type>warning</type>
- </rule>
- <rule ref="WordPress.Files.FileName.InvalidClassFileName">
- <type>warning</type>
- </rule>
-
- <rule ref="WordPress.NamingConventions.ValidVariableName">
- <properties>
- <property name="customPropertiesWhitelist" type="array">
- <!-- From database structure queries. -->
- <element value="Collation"/>
- <element value="Column_name"/>
- <element value="Default"/>
- <element value="Extra"/>
- <element value="Field"/>
- <element value="Index_type"/>
- <element value="Key"/>
- <element value="Key_name"/>
- <element value="Msg_text"/>
- <element value="Non_unique"/>
- <element value="Null"/>
- <element value="Sub_part"/>
- <element value="Type"/>
- <!-- From plugin/theme data. -->
- <element value="authorAndUri"/>
- <element value="Name"/>
- <element value="Version"/>
- <!-- From the result of wp_xmlrpc_server::wp_getPageList(). -->
- <element value="dateCreated"/>
-
- <!-- From DOMDocument. -->
- <element value="childNodes"/>
- <element value="firstChild"/>
- <element value="formatOutput"/>
- <element value="lastChild"/>
- <element value="nodeName"/>
- <element value="nodeType"/>
- <element value="parentNode"/>
- <element value="preserveWhiteSpace"/>
- <element value="textContent"/>
- <!-- From PHPMailer. -->
- <element value="AltBody"/>
- <element value="Body"/>
- <element value="CharSet"/>
- <element value="ContentType"/>
- <element value="Encoding"/>
- <element value="Hostname"/>
- <element value="mailHeader"/>
- <element value="MIMEBody"/>
- <element value="MIMEHeader"/>
- <element value="Sender"/>
- <element value="Subject"/>
- <!-- From PHPUnit_Util_Getopt. -->
- <element value="longOptions"/>
- <!-- From POP3. -->
- <element value="ERROR"/>
- <!-- From ZipArchive. -->
- <element value="numFiles"/>
- </property>
- </properties>
- </rule>
-
</del><span class="cx" style="display: block; padding: 0 10px"> <!-- Exclude the build folder in the current directory. -->
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern type="relative">^build/*</exclude-pattern>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -165,80 +106,50 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <!-- Themes except the twenty* themes. -->
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/src/wp-content/themes/(?!twenty)*</exclude-pattern>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <!-- Allow the WP DB Class and related tests for usage of direct database access functions. -->
- <rule ref="WordPress.DB.RestrictedFunctions">
- <exclude-pattern>/src/wp-includes/class-wpdb\.php</exclude-pattern>
- <exclude-pattern>/tests/phpunit/tests/db/charset\.php</exclude-pattern>
- </rule>
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <!-- Allow the WP DB related tests for issues with prepared SQL placeholders
- (as the handling of those are being tested). -->
- <rule ref="WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare">
- <exclude-pattern>/tests/phpunit/tests/db\.php</exclude-pattern>
- </rule>
- <rule ref="WordPress.DB.PreparedSQLPlaceholders.UnsupportedPlaceholder">
- <exclude-pattern>/tests/phpunit/tests/db\.php</exclude-pattern>
- </rule>
- <rule ref="WordPress.DB.PreparedSQLPlaceholders.UnescapedLiteral">
- <exclude-pattern>/tests/phpunit/tests/db\.php</exclude-pattern>
- </rule>
- <rule ref="WordPress.DB.PreparedSQL.NotPrepared">
- <exclude-pattern>/tests/phpunit/tests/admin/includesSchema\.php</exclude-pattern>
- <exclude-pattern>/tests/phpunit/tests/multisite/site\.php</exclude-pattern>
- </rule>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <!--
+ #############################################################################
+ SET UP THE RULESET
+ #############################################################################
+ -->
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <!-- Allow non-snake-case vars & properties for block-related classes. -->
- <rule ref="WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase">
- <exclude-pattern>/src/wp-includes/class-wp-block-parser\.php</exclude-pattern>
- <exclude-pattern>/src/wp-includes/class-wp-block-parser-block\.php</exclude-pattern>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <rule ref="WordPress-Core"/>
+ <rule ref="WordPress.CodeAnalysis.EmptyStatement"/>
+
+ <!-- Enforce no parenthesis for language constructs, and only one space immediately after.
+ Including this rule is temporary until it is moved from the WordPress-Extra ruleset to
+ the WordPress-Core ruleset upstream.
+ -->
+ <rule ref="PEAR.Files.IncludingFile.BracketsNotRequired">
+ <type>warning</type>
</ins><span class="cx" style="display: block; padding: 0 10px"> </rule>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <rule ref="WordPress.NamingConventions.ValidVariableName.PropertyNotSnakeCase">
- <exclude-pattern>/src/wp-includes/class-wp-block-parser-block\.php</exclude-pattern>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <rule ref="PEAR.Files.IncludingFile.UseRequire">
+ <type>warning</type>
</ins><span class="cx" style="display: block; padding: 0 10px"> </rule>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <rule ref="WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase">
- <exclude-pattern>/src/wp-includes/class-wp-block-parser-block\.php</exclude-pattern>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <rule ref="PEAR.Files.IncludingFile.UseRequireOnce">
+ <type>warning</type>
</ins><span class="cx" style="display: block; padding: 0 10px"> </rule>
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <rule ref="Squiz.WhiteSpace.LanguageConstructSpacing"/>
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <!-- Allow the I18n functions file for issues identified by the I18n sniff
- (such as calling the low-level translate() function). -->
- <rule ref="WordPress.WP.I18n">
- <exclude-pattern>/src/wp-includes/l10n\.php</exclude-pattern>
- <exclude-pattern>/tests/phpunit/tests/l10n\.php</exclude-pattern>
- <exclude-pattern>/tests/phpunit/tests/l10n/loadTextdomainJustInTime\.php</exclude-pattern>
- </rule>
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <!-- Translator comments aren't needed in unit tests. -->
- <rule ref="WordPress.WP.I18n.MissingTranslatorsComment">
- <exclude-pattern>/tests/*</exclude-pattern>
- </rule>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <!--
+ #############################################################################
+ SNIFF-SPECIFIC CONFIGURATION
+ #############################################################################
+ -->
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <rule ref="Generic.Functions.FunctionCallArgumentSpacing">
- <exclude-pattern>/wp-config\.php</exclude-pattern>
- <exclude-pattern>/wp-config-sample\.php</exclude-pattern>
- <exclude-pattern>/wp-tests-config\.php</exclude-pattern>
- <exclude-pattern>/wp-tests-config-sample\.php</exclude-pattern>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <!-- These rules are being set as warnings instead of errors, so we can error check the entire codebase. -->
+ <rule ref="WordPress.DB.PreparedSQL.InterpolatedNotPrepared">
+ <type>warning</type>
</ins><span class="cx" style="display: block; padding: 0 10px"> </rule>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- <!-- Exclude checking of line endings when reporting errors, but fix them when running phpcbf.
- Git and SVN manage these pretty well cross-platform as "native".
- Allow configuration files. -->
- <rule ref="Generic.Files.LineEndings">
- <exclude-pattern>/wp-config\.php</exclude-pattern>
- <exclude-pattern>/wp-config-sample\.php</exclude-pattern>
- <exclude phpcs-only="true" name="Generic.Files.LineEndings"/>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <rule ref="WordPress.DB.PreparedSQL.NotPrepared">
+ <type>warning</type>
</ins><span class="cx" style="display: block; padding: 0 10px"> </rule>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- <!-- WPCS1620: template.php isn't a template tag file. -->
- <rule ref="WordPress.Files.FileName.InvalidTemplateTagFileName">
- <exclude-pattern>/src/wp-includes/template\.php</exclude-pattern>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <rule ref="WordPress.Files.FileName.InvalidClassFileName">
+ <type>warning</type>
</ins><span class="cx" style="display: block; padding: 0 10px"> </rule>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- <!-- WPCS1621: These files are expected to use _ instead of -. -->
- <rule ref="WordPress.Files.FileName.NotHyphenatedLowercase">
- <exclude-pattern>/src/_index\.php</exclude-pattern>
- <exclude-pattern>/src/wp-admin/_index\.php</exclude-pattern>
- <exclude-pattern>/src/wp-content/themes/twentythirteen/taxonomy-post_format\.php</exclude-pattern>
- <exclude-pattern>/src/wp-content/themes/twentyfourteen/taxonomy-post_format\.php</exclude-pattern>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <rule ref="WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase">
+ <type>warning</type>
</ins><span class="cx" style="display: block; padding: 0 10px"> </rule>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <!-- Allow test classes for select sniffs. -->
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -282,6 +193,62 @@
</span><span class="cx" style="display: block; padding: 0 10px"> </properties>
</span><span class="cx" style="display: block; padding: 0 10px"> </rule>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <rule ref="WordPress.NamingConventions.ValidVariableName">
+ <properties>
+ <property name="customPropertiesWhitelist" type="array">
+ <!-- From database structure queries. -->
+ <element value="Collation"/>
+ <element value="Column_name"/>
+ <element value="Default"/>
+ <element value="Extra"/>
+ <element value="Field"/>
+ <element value="Index_type"/>
+ <element value="Key"/>
+ <element value="Key_name"/>
+ <element value="Msg_text"/>
+ <element value="Non_unique"/>
+ <element value="Null"/>
+ <element value="Sub_part"/>
+ <element value="Type"/>
+ <!-- From plugin/theme data. -->
+ <element value="authorAndUri"/>
+ <element value="Name"/>
+ <element value="Version"/>
+ <!-- From the result of wp_xmlrpc_server::wp_getPageList(). -->
+ <element value="dateCreated"/>
+
+ <!-- From DOMDocument. -->
+ <element value="childNodes"/>
+ <element value="firstChild"/>
+ <element value="formatOutput"/>
+ <element value="lastChild"/>
+ <element value="nodeName"/>
+ <element value="nodeType"/>
+ <element value="parentNode"/>
+ <element value="preserveWhiteSpace"/>
+ <element value="textContent"/>
+ <!-- From PHPMailer. -->
+ <element value="AltBody"/>
+ <element value="Body"/>
+ <element value="CharSet"/>
+ <element value="ContentType"/>
+ <element value="Encoding"/>
+ <element value="Hostname"/>
+ <element value="mailHeader"/>
+ <element value="MIMEBody"/>
+ <element value="MIMEHeader"/>
+ <element value="Sender"/>
+ <element value="Subject"/>
+ <!-- From PHPUnit_Util_Getopt. -->
+ <element value="longOptions"/>
+ <!-- From POP3. -->
+ <element value="ERROR"/>
+ <!-- From ZipArchive. -->
+ <element value="numFiles"/>
+ </property>
+ </properties>
+ </rule>
+
</ins><span class="cx" style="display: block; padding: 0 10px"> <rule ref="WordPress.PHP.NoSilencedErrors">
</span><span class="cx" style="display: block; padding: 0 10px"> <properties>
</span><span class="cx" style="display: block; padding: 0 10px"> <property name="custom_whitelist" type="array">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -304,36 +271,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> </properties>
</span><span class="cx" style="display: block; padding: 0 10px"> </rule>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <!-- Enforce no parenthesis for language constructs, and only one space immediately after.
- Including this rule is temporary until it is moved from the WordPress-Extra ruleset to
- the WordPress-Core ruleset upstream.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ <!--
+ #############################################################################
+ SELECTIVE EXCLUSIONS
+ Exclude specific files for specific sniffs and/or exclude sub-groups in sniffs.
+
+ These exclusions are listed ordered by alphabetic sniff name.
+ #############################################################################
</ins><span class="cx" style="display: block; padding: 0 10px"> -->
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <rule ref="PEAR.Files.IncludingFile.BracketsNotRequired">
- <type>warning</type>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ <!-- Exclude checking of line endings when reporting errors, but fix them when running phpcbf.
+ Git and SVN manage these pretty well cross-platform as "native".
+ Allow configuration files. -->
+ <rule ref="Generic.Files.LineEndings">
+ <exclude-pattern>/wp-config\.php</exclude-pattern>
+ <exclude-pattern>/wp-config-sample\.php</exclude-pattern>
+ <exclude phpcs-only="true" name="Generic.Files.LineEndings"/>
</ins><span class="cx" style="display: block; padding: 0 10px"> </rule>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <rule ref="PEAR.Files.IncludingFile.UseRequire">
- <type>warning</type>
- </rule>
- <rule ref="PEAR.Files.IncludingFile.UseRequireOnce">
- <type>warning</type>
- </rule>
- <rule ref="Squiz.WhiteSpace.LanguageConstructSpacing"/>
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <!-- Assignments in while conditions are a valid method of looping over iterables. -->
- <rule ref="WordPress.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition">
- <exclude-pattern>*</exclude-pattern>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <rule ref="Generic.Functions.FunctionCallArgumentSpacing">
+ <exclude-pattern>/wp-config\.php</exclude-pattern>
+ <exclude-pattern>/wp-config-sample\.php</exclude-pattern>
+ <exclude-pattern>/wp-tests-config\.php</exclude-pattern>
+ <exclude-pattern>/wp-tests-config-sample\.php</exclude-pattern>
</ins><span class="cx" style="display: block; padding: 0 10px"> </rule>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <!-- Exclude the unit tests from select sniffs. -->
- <rule ref="WordPress.Files.FileName.NotHyphenatedLowercase">
- <exclude-pattern>/tests/phpunit/tests/*</exclude-pattern>
- </rule>
</del><span class="cx" style="display: block; padding: 0 10px"> <rule ref="PEAR.NamingConventions.ValidClassName.Invalid">
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/tests/phpunit/tests/*</exclude-pattern>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- </rule>
-
- <!-- Exclude some old classes that cannot be renamed, as it would break back compat. -->
- <rule ref="PEAR.NamingConventions.ValidClassName.Invalid">
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <!-- Exclude some old classes that cannot be renamed, as it would break back compat. -->
</ins><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/src/wp-admin/includes/class-wp-filesystem-ftpsockets\.php</exclude-pattern>
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/src/wp-includes/class-wp-oembed\.php</exclude-pattern>
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/src/wp-includes/class-wp-oembed-controller\.php</exclude-pattern>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -340,6 +306,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/src/wp-includes/class-wp-xmlrpc-server\.php</exclude-pattern>
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/src/wp-includes/class-wp-text-diff-renderer-inline\.php</exclude-pattern>
</span><span class="cx" style="display: block; padding: 0 10px"> </rule>
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ <!-- Exclude some old classes that cannot be renamed, as it would break back compat. -->
</ins><span class="cx" style="display: block; padding: 0 10px"> <rule ref="PEAR.NamingConventions.ValidClassName.StartWithCapital">
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/src/wp-admin/includes/class-wp-list-table-compat\.php</exclude-pattern>
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/src/wp-includes/class-wp-dependency\.php</exclude-pattern>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -348,6 +316,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/src/wp-includes/class-wpdb\.php</exclude-pattern>
</span><span class="cx" style="display: block; padding: 0 10px"> </rule>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <!-- Assignments in while conditions are a valid method of looping over iterables. -->
+ <rule ref="WordPress.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition">
+ <exclude-pattern>*</exclude-pattern>
+ </rule>
+
+ <!-- Allow the WP DB Class and related tests for usage of direct database access functions. -->
+ <rule ref="WordPress.DB.RestrictedFunctions">
+ <exclude-pattern>/src/wp-includes/class-wpdb\.php</exclude-pattern>
+ <exclude-pattern>/tests/phpunit/tests/db/charset\.php</exclude-pattern>
+ </rule>
+
+ <!-- Allow the WP DB related tests for issues with prepared SQL placeholders
+ (as the handling of those are being tested). -->
+ <rule ref="WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare">
+ <exclude-pattern>/tests/phpunit/tests/db\.php</exclude-pattern>
+ </rule>
+ <rule ref="WordPress.DB.PreparedSQLPlaceholders.UnsupportedPlaceholder">
+ <exclude-pattern>/tests/phpunit/tests/db\.php</exclude-pattern>
+ </rule>
+ <rule ref="WordPress.DB.PreparedSQLPlaceholders.UnescapedLiteral">
+ <exclude-pattern>/tests/phpunit/tests/db\.php</exclude-pattern>
+ </rule>
+ <rule ref="WordPress.DB.PreparedSQL.NotPrepared">
+ <exclude-pattern>/tests/phpunit/tests/admin/includesSchema\.php</exclude-pattern>
+ <exclude-pattern>/tests/phpunit/tests/multisite/site\.php</exclude-pattern>
+ </rule>
+
+ <!-- WPCS1620: template.php isn't a template tag file. -->
+ <rule ref="WordPress.Files.FileName.InvalidTemplateTagFileName">
+ <exclude-pattern>/src/wp-includes/template\.php</exclude-pattern>
+ </rule>
+
+ <!-- Exclude the unit tests from select sniffs. -->
+ <rule ref="WordPress.Files.FileName.NotHyphenatedLowercase">
+ <exclude-pattern>/tests/phpunit/tests/*</exclude-pattern>
+ </rule>
+
</ins><span class="cx" style="display: block; padding: 0 10px"> <!-- Exclude some incorrectly named files that won't be renamed. -->
</span><span class="cx" style="display: block; padding: 0 10px"> <rule ref="WordPress.Files.FileName.InvalidClassFileName">
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/src/wp-admin/includes/class-wp-list-table-compat\.php</exclude-pattern>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -357,4 +362,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/src/wp-content/themes/twentyfourteen/inc/widgets\.php</exclude-pattern>
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/src/wp-content/themes/twentyfourteen/inc/featured-content\.php</exclude-pattern>
</span><span class="cx" style="display: block; padding: 0 10px"> </rule>
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ <!-- WPCS1621: These files are expected to use _ instead of -. -->
+ <rule ref="WordPress.Files.FileName.NotHyphenatedLowercase">
+ <exclude-pattern>/src/_index\.php</exclude-pattern>
+ <exclude-pattern>/src/wp-admin/_index\.php</exclude-pattern>
+ <exclude-pattern>/src/wp-content/themes/twentythirteen/taxonomy-post_format\.php</exclude-pattern>
+ <exclude-pattern>/src/wp-content/themes/twentyfourteen/taxonomy-post_format\.php</exclude-pattern>
+ </rule>
+
+ <!-- Allow the I18n functions file for issues identified by the I18n sniff
+ (such as calling the low-level translate() function). -->
+ <rule ref="WordPress.WP.I18n">
+ <exclude-pattern>/src/wp-includes/l10n\.php</exclude-pattern>
+ <exclude-pattern>/tests/phpunit/tests/l10n\.php</exclude-pattern>
+ <exclude-pattern>/tests/phpunit/tests/l10n/loadTextdomainJustInTime\.php</exclude-pattern>
+ </rule>
+
+ <!-- Translator comments aren't needed in unit tests. -->
+ <rule ref="WordPress.WP.I18n.MissingTranslatorsComment">
+ <exclude-pattern>/tests/*</exclude-pattern>
+ </rule>
+
+ <!-- Allow non-snake-case vars & properties for block-related classes. -->
+ <rule ref="WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase">
+ <exclude-pattern>/src/wp-includes/class-wp-block-parser\.php</exclude-pattern>
+ <exclude-pattern>/src/wp-includes/class-wp-block-parser-block\.php</exclude-pattern>
+ </rule>
+ <rule ref="WordPress.NamingConventions.ValidVariableName.PropertyNotSnakeCase">
+ <exclude-pattern>/src/wp-includes/class-wp-block-parser-block\.php</exclude-pattern>
+ </rule>
+ <rule ref="WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase">
+ <exclude-pattern>/src/wp-includes/class-wp-block-parser-block\.php</exclude-pattern>
+ </rule>
+
</ins><span class="cx" style="display: block; padding: 0 10px"> </ruleset>
</span></span></pre>
</div>
</div>
</body>
</html>