<!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][13324] trunk: Testing BuddyPress against its own/new PHP Code Sniffer (PHPCS).</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/13324">13324</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/13324","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>2022-09-11 18:22:23 +0000 (Sun, 11 Sep 2022)</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'>Testing BuddyPress against its own/new PHP Code Sniffer (PHPCS).
The plugin is using its own custom PHP Code Sniffer (https://github.com/buddypress/bp-coding-standards)
A non-blocking Github Action was introduced to test against this new code sniffer. Actual PHPCS fixes will be introduced in future commits.
Closes https://github.com/buddypress/buddypress/pull/21
See <a href="http://buddypress.trac.wordpress.org/ticket/7228">#7228</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkgithubworkflowsunittestsyml">trunk/.github/workflows/unit-tests.yml</a></li>
<li><a href="#trunkgitignore">trunk/.gitignore</a></li>
<li><a href="#trunkcomposerjson">trunk/composer.json</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkgithubworkflowscodingstandardsyml">trunk/.github/workflows/coding-standards.yml</a></li>
<li>trunk/.phpcs/</li>
<li><a href="#trunkphpcsgitkeep">trunk/.phpcs/.gitkeep</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="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: 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 (rev 0)
+++ trunk/.github/workflows/coding-standards.yml 2022-09-11 18:22:23 UTC (rev 13324)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,37 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+name: Coding Standards
+
+on: pull_request
+
+jobs:
+ phpcs:
+ name: PHPCS
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: true
+ matrix:
+ php: ['8.0']
+
+ steps:
+ - name: Cancel previous runs of this workflow (pull requests only)
+ if: ${{ github.event_name == 'pull_request' }}
+ uses: styfle/cancel-workflow-action@0.5.0
+ with:
+ access_token: ${{ github.token }}
+
+ - name: Checkout code
+ uses: actions/checkout@v3
+
+ - name: Setup PHP
+ uses: shivammathur/setup-php@v2
+ with:
+ php-version: ${{ matrix.php }}
+ tools: composer:v2
+ coverage: none
+
+ - name: Install dependencies
+ uses: ramsey/composer-install@v2
+ with:
+ composer-options: "--ignore-platform-reqs"
+
+ - name: Run PHPCS
+ run: composer phpcs
</ins></span></pre></div>
<a id="trunkgithubworkflowsunittestsyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.github/workflows/unit-tests.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/unit-tests.yml 2022-09-08 16:17:00 UTC (rev 13323)
+++ trunk/.github/workflows/unit-tests.yml 2022-09-11 18:22:23 UTC (rev 13324)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,7 +32,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> access_token: ${{ github.token }}
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Checkout repository
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- uses: actions/checkout@v2
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ uses: actions/checkout@v3
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Setup PHP
</span><span class="cx" style="display: block; padding: 0 10px"> uses: shivammathur/setup-php@v2
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -51,11 +51,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> php --version
</span><span class="cx" style="display: block; padding: 0 10px"> composer --version
</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: Validate Composer
- run: composer validate --strict
-
</del><span class="cx" style="display: block; padding: 0 10px"> - name: Install Composer dependencies
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- uses: ramsey/composer-install@v1
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ uses: ramsey/composer-install@v2
</ins><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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -87,13 +84,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> npm run wp-env start -- --update
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Running single site unit tests
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if: ${{ success() || failure() }}
</ins><span class="cx" style="display: block; padding: 0 10px"> run: npm run test-php
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if: ${{ success() || failure() }}
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Running multi site unit tests
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if: ${{ success() || failure() }}
</ins><span class="cx" style="display: block; padding: 0 10px"> run: npm run test-php-multisite
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if: ${{ success() || failure() }}
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> - name: Stop Docker environment
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if: ${{ success() || failure() }}
</ins><span class="cx" style="display: block; padding: 0 10px"> run: npm run wp-env stop
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if: ${{ success() || failure() }}
</del></span></pre></div>
<a id="trunkgitignore"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.gitignore</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.gitignore 2022-09-08 16:17:00 UTC (rev 13323)
+++ trunk/.gitignore 2022-09-11 18:22:23 UTC (rev 13324)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,6 +23,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> node_modules
</span><span class="cx" style="display: block; padding: 0 10px"> npm-debug.log
</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/*.json
+
</ins><span class="cx" style="display: block; padding: 0 10px"> # The build directory.
</span><span class="cx" style="display: block; padding: 0 10px"> build
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunkphpcsgitkeep"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/.phpcs/.gitkeep</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.phpcs/.gitkeep (rev 0)
+++ trunk/.phpcs/.gitkeep 2022-09-11 18:22:23 UTC (rev 13324)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+# This directory can't be empty.
</ins></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 2022-09-08 16:17:00 UTC (rev 13323)
+++ trunk/composer.json 2022-09-11 18:22:23 UTC (rev 13324)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,19 +32,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "dealerdirect/phpcodesniffer-composer-installer": true
</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">+ "repositories": [
+ {
+ "url": "https://github.com/buddypress/bp-coding-standards.git",
+ "type": "git"
+ }
+ ],
</ins><span class="cx" style="display: block; padding: 0 10px"> "require": {
</span><span class="cx" style="display: block; padding: 0 10px"> "composer/installers": "^1.10.0",
</span><span class="cx" style="display: block; padding: 0 10px"> "php": ">=5.6.0"
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> "require-dev": {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "phpcompatibility/phpcompatibility-wp": "^2.1.3",
- "dealerdirect/phpcodesniffer-composer-installer": "^0.7.1",
- "squizlabs/php_codesniffer" : "^3.6.0",
- "wp-coding-standards/wpcs": "~2.3.0",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "buddypress/bp-coding-standards": "dev-trunk",
</ins><span class="cx" style="display: block; padding: 0 10px"> "wp-phpunit/wp-phpunit": "^6.0",
</span><span class="cx" style="display: block; padding: 0 10px"> "yoast/phpunit-polyfills": "^1.0.1"
</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">- "test": "@php ./vendor/phpunit/phpunit/phpunit"
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "test": "@php ./vendor/phpunit/phpunit/phpunit",
+ "phpcs" : "@php ./vendor/bin/phpcs"
</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="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/phpcs.xml.dist</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/phpcs.xml.dist (rev 0)
+++ trunk/phpcs.xml.dist 2022-09-11 18:22:23 UTC (rev 13324)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,19 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?xml version="1.0"?>
+<ruleset>
+ <description>PHP_CodeSniffer standard for the BuddyPress plugin.</description>
+
+ <!-- Load BuddyPress Coding standards -->
+ <rule ref="BuddyPress" />
+
+ <file>./bp-loader.php</file>
+ <file>./src/bp-xprofile</file>
+
+ <!-- We are starting with severity of 6. -->
+ <arg name="severity" value="6"/>
+
+ <!-- What to exclude -->
+ <exclude-pattern>*/**/tests/</exclude-pattern>
+
+ <!-- Whenever possible, cache the scan results and re-use those for unchanged files on the next scan. -->
+ <arg name="cache" value=".phpcs/cache.json" />
+</ruleset>
</ins></span></pre>
</div>
</div>
</body>
</html>