<!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>[56594] trunk/phpcs.xml.dist: Coding Standards: Remove the custom property for the `FileName` sniff.</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/56594">56594</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/56594","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 10:45:18 +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: Remove the custom property for the `FileName` sniff.
Test files should comply with the naming conventions accepted by PHPUnit, not with the WP naming conventions.
While the `WordPress.File.FileName` sniff makes a best effort to prevent throwing errors for files containing test classes, the recommended manner to deal with test files is to exclude the complete test directory from being subject to this sniff.
This updates the ruleset to follow the recommendation.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/42346">[42346]</a>, <a href="https://core.trac.wordpress.org/changeset/45607">[45607]</a>.
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 09:06:23 UTC (rev 56593)
+++ trunk/phpcs.xml.dist 2023-09-15 10:45:18 UTC (rev 56594)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -152,47 +152,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <type>warning</type>
</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">- <!-- Allow test classes for select sniffs. -->
- <rule ref="WordPress.Files.FileName">
- <properties>
- <property name="custom_test_class_whitelist" type="array">
- <!-- Test case parent classes in the "includes" folder, not yet accounted for in WPCS. -->
- <element value="PHPUnit_Adapter_TestCase"/>
- <element value="WP_Test_XML_TestCase"/>
-
- <!-- Test case parent classes outside of the "includes" folder. -->
- <element value="Tests_Query_Conditionals"/>
- <element value="WP_Block_Templates_UnitTestCase"/>
- <element value="WP_Filesystem_UnitTestCase"/>
- <element value="WP_HTTP_UnitTestCase"/>
- <element value="WP_Image_UnitTestCase"/>
- <element value="WP_Import_UnitTestCase"/>
- <element value="WP_Test_Adjacent_Image_Link_TestCase"/>
- <element value="WP_Tests_Image_Resize_UnitTestCase"/>
- <element value="WP_Theme_UnitTestCase"/>
- <element value="WP_Font_Face_UnitTestCase"/>
-
- <!-- Mock classes. -->
- <element value="Spy_REST_Server"/>
- <element value="WP_REST_Test_Controller"/>
- <element value="WP_Image_Editor_Mock"/>
- <element value="WP_Filesystem_MockFS"/>
- <element value="Mock_Invokable"/>
- <element value="MockPHPMailer"/>
- <element value="MockAction"/>
- <element value="WP_Object_Cache"/>
-
- <!-- PHPUnit helpers. -->
- <element value="TracTickets"/>
- <element value="WP_PHPUnit_Util_Getopt"/>
- <element value="PHPUnit_Util_Test"/>
- <element value="WPProfiler"/>
- <element value="PHPUnit_Framework_Exception"/>
- <element value="Polyfill_TestCase"/>
- </property>
- </properties>
- </rule>
-
</del><span class="cx" style="display: block; padding: 0 10px"> <rule ref="WordPress.NamingConventions.ValidVariableName">
</span><span class="cx" style="display: block; padding: 0 10px"> <properties>
</span><span class="cx" style="display: block; padding: 0 10px"> <property name="customPropertiesWhitelist" type="array">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -343,16 +302,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/tests/phpunit/tests/multisite/site\.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">+ <!-- Exclude the unit tests from the file name rules. -->
+ <rule ref="WordPress.Files.FileName">
+ <exclude-pattern>/tests/phpunit/*</exclude-pattern>
+ </rule>
+
</ins><span class="cx" style="display: block; padding: 0 10px"> <!-- WPCS1620: template.php isn't a template tag file. -->
</span><span class="cx" style="display: block; padding: 0 10px"> <rule ref="WordPress.Files.FileName.InvalidTemplateTagFileName">
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/src/wp-includes/template\.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><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"> <!-- 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></pre>
</div>
</div>
</body>
</html>