<!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>[BuddyPress][13850] trunk: Improve handing of PHP code standards using WPCS</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="http://buddypress.trac.wordpress.org/changeset/13850">13850</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/13850","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>espellcaste</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-05-04 12:56:31 +0000 (Sat, 04 May 2024)</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'>Improve handing of PHP code standards using WPCS
Until we have all WPCS warnings and errors fixed, we block pull requests, and releases, with code with escaping or/and PHP Compatibility issues.
For local development only, we set WPCS severity to 1 to see everything that is not effectively turned off.
Run `composer run phpcs` for showing all WPCS issues.
Run `composer run phpcs-escape` for showing escaping issues.
Run `composer run phpcompat` for showing PHP Compatibility issues.
See <a href="http://buddypress.trac.wordpress.org/ticket/7228">#7228</a>
Closes https://github.com/buddypress/buddypress/pull/282/</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkgithubworkflowscodingstandardsyml">trunk/.github/workflows/coding-standards.yml</a></li>
<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="trunkgithubworkflowscodingstandardsyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.github/workflows/coding-standards.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/coding-standards.yml 2024-05-03 08:28:31 UTC (rev 13849)
+++ trunk/.github/workflows/coding-standards.yml 2024-05-04 12:56:31 UTC (rev 13850)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,5 +33,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> with:
</span><span class="cx" style="display: block; padding: 0 10px"> composer-options: "--ignore-platform-reqs"
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- - name: Run PHPCS
- run: composer phpcs
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ - name: Run PHPCS Escape
+ run: composer phpcs-escape
+
+ - name: Run PHP Compatibility
+ run: composer phpcompat
</ins></span></pre></div>
<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 2024-05-03 08:28:31 UTC (rev 13849)
+++ trunk/Gruntfile.js 2024-05-04 12:56:31 UTC (rev 13850)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -160,6 +160,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> src: BP_CSS.concat( BP_EXCLUDED_CSS, BP_EXCLUDED_MISC )
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Remove this when all WPCS issues are resolved.
</ins><span class="cx" style="display: block; padding: 0 10px"> checktextdomain: {
</span><span class="cx" style="display: block; padding: 0 10px"> options: {
</span><span class="cx" style="display: block; padding: 0 10px"> correct_domain: false,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -342,8 +343,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> cwd: BUILD_DIR,
</span><span class="cx" style="display: block; padding: 0 10px"> stdout: false
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ phpcs_escape: {
+ command: 'composer run phpcs-escape',
+ stdout: true
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> phpcompat: {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- command: './vendor/bin/phpcs -p --standard=PHPCompatibilityWP --extensions=php --runtime-set testVersion 5.6- src tests',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ command: 'composer run phpcompat',
</ins><span class="cx" style="display: block; padding: 0 10px"> stdout: true
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> rest_api: {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -401,7 +406,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> grunt.registerTask( 'src', ['checkDependencies', 'jsvalidate:src', 'jshint', 'stylelint', 'sass', 'postcss', 'rtlcss'] );
</span><span class="cx" style="display: block; padding: 0 10px"> grunt.registerTask( 'style', ['stylelint', 'sass', 'postcss', 'rtlcss'] );
</span><span class="cx" style="display: block; padding: 0 10px"> grunt.registerTask( 'makepot', ['exec:makepot'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- grunt.registerTask( 'commit', ['src', 'checktextdomain', 'imagemin', 'phplint', 'exec:phpcompat'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ grunt.registerTask( 'commit', ['src', 'checktextdomain', 'imagemin', 'phplint', 'exec:phpcs_escape', 'exec:phpcompat'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> grunt.registerTask( 'commit:blocks', ['commit', 'exec:blocks_src', 'exec:modernJS_src'] );
</span><span class="cx" style="display: block; padding: 0 10px"> grunt.registerTask( 'bp_rest', [ 'exec:rest_api', 'copy:bp_rest_components', 'copy:bp_rest_core', 'clean:bp_rest' ] );
</span><span class="cx" style="display: block; padding: 0 10px"> grunt.registerTask( 'build', ['commit:blocks', 'clean:all', 'copy:files', 'uglify:core', 'jsvalidate:build', 'cssmin', 'bp_rest', 'makepot', 'exec:cli', 'clean:cli'] );
</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 2024-05-03 08:28:31 UTC (rev 13849)
+++ trunk/composer.json 2024-05-04 12:56:31 UTC (rev 13850)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -48,6 +48,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "phpunit": "@test",
</span><span class="cx" style="display: block; padding: 0 10px"> "phpcs": "@php ./vendor/bin/phpcs . --basepath=.",
</span><span class="cx" style="display: block; padding: 0 10px"> "phpcbf": "@php ./vendor/bin/phpcbf . --basepath=.",
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "phpcs-escape": "@php ./vendor/bin/phpcs src --extensions=php -sp --standard=BuddyPress --sniffs=WordPress.Security.EscapeOutput",
+ "phpcompat": "@php ./vendor/bin/phpcs --standard=PHPCompatibilityWP --extensions=php -sp --runtime-set testVersion 5.6- src tests",
</ins><span class="cx" style="display: block; padding: 0 10px"> "test:watch": [
</span><span class="cx" style="display: block; padding: 0 10px"> "Composer\\Config::disableProcessTimeout",
</span><span class="cx" style="display: block; padding: 0 10px"> "phpunit-watcher watch"
</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 2024-05-03 08:28:31 UTC (rev 13849)
+++ trunk/phpcs.xml.dist 2024-05-04 12:56:31 UTC (rev 13850)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -11,8 +11,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> s flag: Show sniff codes in all reports.
</span><span class="cx" style="display: block; padding: 0 10px"> v flag: Print processed files.
</span><span class="cx" style="display: block; padding: 0 10px"> -->
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <arg value="psv" />
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <arg value="sp" />
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <!-- Make it pretty. -->
+ <arg name="colors"/>
+
</ins><span class="cx" style="display: block; padding: 0 10px"> <!-- Whenever possible, cache the scan results and re-use those for unchanged files on the next scan. -->
</span><span class="cx" style="display: block; padding: 0 10px"> <arg name="cache" value=".phpcs/cache.json" />
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -19,8 +22,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <!-- Check 20 files in parallel. -->
</span><span class="cx" style="display: block; padding: 0 10px"> <arg name="parallel" value="20"/>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <!-- Set severity to 6 to see everything that isn't effectively turned off. -->
- <arg name="severity" value="6"/>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <!-- Set severity to 1 to see everything that isn't effectively turned off. -->
+ <arg name="severity" value="1"/>
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <!-- What to exclude -->
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>*/**/tests/</exclude-pattern>
</span></span></pre>
</div>
</div>
</body>
</html>