<!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>[45665] trunk: Coding Standards: Move the remaining PHPCS errors to report as warnings, and add Travis tests.</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/45665">45665</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/45665","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>pento</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-07-19 07:47:16 +0000 (Fri, 19 Jul 2019)</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: Move the remaining PHPCS errors to report as warnings, and add Travis tests.
The remaining error-level coding standards issues (specifically, associated with the sniffs `WordPress.PHP.YodaConditions.NotYoda`, `WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase`, `WordPress.DB.PreparedSQL.InterpolatedNotPrepared`, `WordPress.DB.PreparedSQL.NotPrepared`, and `WordPress.Files.FileName.InvalidClassFileName`) are marked as warnings, until they're all addressed.
This change allows us to run linting on Travis across the entire codebase, ensuring no other error-level violations can be introduced.
Additionally, PHPCS will now cache results locally, drastically improving performance for subsequent checks: scanning the entire codebase takes 1-2 minutes the first time, and less than one second for subsequent checks.
See <a href="https://core.trac.wordpress.org/ticket/47632">#47632</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkGruntfilejs">trunk/Gruntfile.js</a></li>
<li><a href="#trunkcomposerjson">trunk/composer.json</a></li>
<li><a href="#trunkphpcsxmldist">trunk/phpcs.xml.dist</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkGruntfilejs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/Gruntfile.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/Gruntfile.js 2019-07-19 04:42:00 UTC (rev 45664)
+++ trunk/Gruntfile.js 2019-07-19 07:47:16 UTC (rev 45665)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1442,10 +1442,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> var done = this.async();
</span><span class="cx" style="display: block; padding: 0 10px"> var flags = this.flags;
</span><span class="cx" style="display: block; padding: 0 10px"> var args = changedFiles.php;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( flags.travis ) {
- args = [ 'tests' ];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( flags.travisErrors ) {
+ // We can check the entire codebase for coding standards errors.
+ args = [ 'lint:errors' ];
+ } else if ( flags.travisWarnings ) {
+ // We can check the tests directory for errors and warnings.
+ args = [ 'lint', 'tests' ];
+ } else {
+ args.unshift( 'lint' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- args.unshift( 'lint' );
</del><span class="cx" style="display: block; padding: 0 10px"> grunt.util.spawn( {
</span><span class="cx" style="display: block; padding: 0 10px"> cmd: 'composer',
</span><span class="cx" style="display: block; padding: 0 10px"> args: args,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1462,7 +1467,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Travis CI tasks.
</span><span class="cx" style="display: block; padding: 0 10px"> grunt.registerTask('travis:js', 'Runs Javascript Travis CI tasks.', [ 'jshint:corejs', 'qunit:compiled' ]);
</span><span class="cx" style="display: block; padding: 0 10px"> grunt.registerTask('travis:phpunit', 'Runs PHPUnit Travis CI tasks.', [ 'build', 'phpunit' ]);
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- grunt.registerTask('travis:phpcs', 'Runs PHP Coding Standards Travis CI tasks.', [ 'format:php:error', 'lint:php:travis:error' ]);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ grunt.registerTask('travis:phpcs', 'Runs PHP Coding Standards Travis CI tasks.', [ 'format:php:error', 'lint:php:travisErrors:error', 'lint:php:travisWarnings:error' ]);
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Patch task.
</span><span class="cx" style="display: block; padding: 0 10px"> grunt.renameTask('patch_wordpress', 'patch');
</span></span></pre></div>
<a id="trunkcomposerjson"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/composer.json</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/composer.json 2019-07-19 04:42:00 UTC (rev 45664)
+++ trunk/composer.json 2019-07-19 07:47:16 UTC (rev 45665)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -14,7 +14,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "wp-coding-standards/wpcs": "~2.1.0"
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> "scripts": {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "format": "phpcbf --standard=phpcs.xml.dist --report-summary --report-source",
- "lint": "phpcs --standard=phpcs.xml.dist --report-summary --report-source"
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "format": "phpcbf --standard=phpcs.xml.dist --report-summary --report-source --cache -d memory_limit=256M",
+ "lint": "phpcs --standard=phpcs.xml.dist --report-summary --report-source --cache -d memory_limit=256M",
+ "lint:errors": "phpcs --standard=phpcs.xml.dist --report-summary --report-source --cache -d memory_limit=256M -n"
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<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 2019-07-19 04:42:00 UTC (rev 45664)
+++ trunk/phpcs.xml.dist 2019-07-19 07:47:16 UTC (rev 45665)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5,6 +5,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <rule ref="WordPress-Core"/>
</span><span class="cx" style="display: block; padding: 0 10px"> <rule ref="WordPress.CodeAnalysis.EmptyStatement"/>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><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.PHP.YodaConditions.NotYoda">
+ <type>warning</type>
+ </rule>
+ <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>
+
</ins><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></pre>
</div>
</div>
</body>
</html>