<!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>[6733] sites/trunk/wordcamp.org/phpcs.xml.dist: WordCamp PHPCS: Add more exclusions.</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 { 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://meta.trac.wordpress.org/changeset/6733">6733</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/6733","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-02-24 22:33:18 +0000 (Sat, 24 Feb 2018)</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'>WordCamp PHPCS: Add more exclusions.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgphpcsxmldist">sites/trunk/wordcamp.org/phpcs.xml.dist</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporgphpcsxmldist"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordcamp.org/phpcs.xml.dist</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordcamp.org/phpcs.xml.dist 2018-02-24 01:26:54 UTC (rev 6732)
+++ sites/trunk/wordcamp.org/phpcs.xml.dist 2018-02-24 22:33:18 UTC (rev 6733)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,6 +22,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> See these links for useful information:
</span><span class="cx" style="display: block; padding: 0 10px"> - https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ - https://github.com/squizlabs/PHP_CodeSniffer/wiki/Customisable-Sniff-Properties
</ins><span class="cx" style="display: block; padding: 0 10px"> - https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties
</span><span class="cx" style="display: block; padding: 0 10px"> -->
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -29,10 +30,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> Exclude 3rd party plugins/themes so this can be run from the project root without a ton of extraneous stuff
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude-pattern>/build/*</exclude-pattern>
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ disable WordPress.VIP.PostsPerPage.posts_per_page_posts_per_page for bin folder only
+
</ins><span class="cx" style="display: block; padding: 0 10px"> Look through `General` and `Squiz` sniffs for anything you might want to add.
</span><span class="cx" style="display: block; padding: 0 10px"> Is there one that detects `\Foo` instead of `use Foo`?
</span><span class="cx" style="display: block; padding: 0 10px"> maximum nesting level?
</span><span class="cx" style="display: block; padding: 0 10px"> function length?
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unnecessary order-of-operations params, e.g., $foo = ( $bar || $qax ) ? 'bax' : 'quix';
+ echoing html instead of breaking php or using an external view. e.g., echo '<div>foo</div>'; should be `?> <div>foo</div> <?php` (but on multiple lines of course)
+ var assignment immediately followed by if/while/for statement, without a blank space inbetween. maybe not in all cases, though?
+ closing divs with a comment after them. it adds clutter. when viewing source, this is an artifact from the days before browser dev tools. view in IDEs, this isn't necessary if the code is properly formatted.
+ return statement at end of function w/out blank line above it
+ no space between last @param and the @return in docblock. i know diff than core, but whitespace makes it easier to scan/read. should also have space above first @param. sometimes want no space between different types of tags, though.
+ opening/closing <?php ?> tags without a blank line after/before them, except when doing single-line like <?php foo(); ?>
+ align ? and : in multiple ternary operator statements
+ don't un-align params in function calls - e.g., multiple add_meta_box( $a, $b, $c, $d, $e, $f, $g ) calls should have the params aligned.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> Maybe add WordCamp\Remote_CSS\output_cached_css to customEscapingFunctions or whichever param is most appropriate
</span><span class="cx" style="display: block; padding: 0 10px"> Maybe do something similar for set_cache_headers and nonce verification
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -40,10 +52,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> Setup WordPress.WP.I18n text_domain property and test that it works, see https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties#internationalization-setting-your-text-domain
</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">+
</ins><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="cx" style="display: block; padding: 0 10px"> <!-- Show sniff codes in all reports -->
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <arg value="ps" />
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <arg value="ps" />
</ins><span class="cx" style="display: block; padding: 0 10px"> <arg name="colors" />
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <!-- Scan all (php) files in the current folder and subfolders -->
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -72,8 +85,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude name="WordPress.WhiteSpace.PrecisionAlignment.Found" />
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude name="Generic.Functions.FunctionCallArgumentSpacing.TooMuchSpaceAfterComma" />
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude name="WordPress.WhiteSpace.OperatorSpacing.SpacingBefore" />
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <exclude name="WordPress.Arrays.ArrayDeclarationSpacing.SpaceBeforeArrayCloser" />
</ins><span class="cx" style="display: block; padding: 0 10px"> <exclude name="PEAR.Functions.FunctionCallSignature.SpaceBeforeCloseBracket" />
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude name="Squiz.Strings.ConcatenationSpacing.PaddingFound" />
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ <!-- Warn about mis-aligned array items, but don't automatically "fix" them, because arrays in function calls get extra lines added.
+ See https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/issues/1305 -->
+ <exclude phpcbf-only="true" name="WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned" />
+ <exclude phpcbf-only="true" name="PEAR.Functions.FunctionCallSignature.ContentAfterOpenBracket" />
+ <exclude phpcbf-only="true" name="PEAR.Functions.FunctionCallSignature.CloseBracketLine" />
</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"> <rule ref="WordPress-Docs">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -81,10 +101,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude name="Squiz.Commenting.FunctionComment.MissingParamComment" />
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude name="Squiz.Commenting.FileComment.Missing" />
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude name="Squiz.Commenting.ClassComment.Missing" />
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <exclude name="Squiz.Commenting.FunctionComment.MissingParamTag" />
</ins><span class="cx" style="display: block; padding: 0 10px"> <exclude name="Generic.Commenting.DocComment.MissingShort" />
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <!-- I don't see how these are useful. -->
+ <exclude name="Squiz.Commenting.FileComment.MissingPackageTag" />
+
</ins><span class="cx" style="display: block; padding: 0 10px"> <!-- We really only use basic exceptions, so this is kind of overkill and tedious. -->
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude name="Squiz.Commenting.FunctionComment.EmptyThrows" />
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ <!-- Whitespace makes things more readable. -->
+ <exclude name="Squiz.Commenting.FileComment.SpacingAfterOpen" />
+
+ <!-- It's not wrong for WordPress plugin file headers. -->
+ <exclude name="Squiz.Commenting.FileComment.WrongStyle" />
</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"> <rule ref="WordPress-VIP">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -94,6 +124,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude name="WordPress.VIP.RestrictedFunctions.wp_remote_get_wp_remote_get" />
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude name="WordPress.VIP.RestrictedFunctions.file_get_contents_file_get_contents" />
</span><span class="cx" style="display: block; padding: 0 10px"> <exclude name="WordPress.VIP.RestrictedFunctions.get_posts_get_posts" />
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ <!-- This is too strict. -->
+ <exclude name="WordPress.VIP.SlowDBQuery.slow_db_query_meta_query" />
</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"> <rule ref="WordPress-Extra">
</span></span></pre>
</div>
</div>
</body>
</html>