<!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>[6703] sites/trunk/wordcamp.org/phpcs.xml.dist: WordCamp: Add initial PHP Code Sniffer ruleset.</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/6703">6703</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/6703","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-20 23:55:27 +0000 (Tue, 20 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: Add initial PHP Code Sniffer ruleset.</pre>
<h3>Added 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="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: 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 (rev 0)
+++ sites/trunk/wordcamp.org/phpcs.xml.dist 2018-02-20 23:55:27 UTC (rev 6703)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,100 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?xml version="1.0" ?>
+<ruleset name="WordCamp.org Coding Standards">
+ <description>Apply customized version of WordPress Coding Standards to WordCamp.org PHP scripts</description>
+
+ <!--
+ Setup instructions:
+
+ 1) Install PHPCS (e.g., `brew install homebrew/php/php-code-sniffer`)
+ 2) Install the WP Coding Standards (https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards)
+ 3) Edit CodeSniffer.conf and update `installed_paths` to point to where you installed the WP Coding Standards,
+ and any other tweaks you want to make.
+ See https://github.com/iandunn/dotfiles/blob/master/phpcs/CodeSniffer.conf for an example.
+ 4) Make sure this file is at the project root. You can symlink it there if your `meta.(git|svn).wordpress.org`
+ checkout is elsewhere.
+ 5) `cd` to a folder inside the project and run `phpcs`. You can use the `-a` flag to run it interactively.
+ 6) Run it before you generate a patch or create a commit. Setting up a git pre-commit or pre-push hook can
+ make that automatic.
+
+ Note: It's possible to create a `phpcs.xml` file if you want to override anything here, but please make sure
+ any code you contribute conforms to this file. If you think any of the rules here should change, start a
+ discussion in #meta-wordcamp.
+
+ See these links for useful information:
+ - https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml
+ - https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties
+ -->
+
+ <!-- TODO
+ Exclude 3rd party plugins/themes so this can be run from the project root without a ton of extraneous stuff
+ <exclude-pattern>/build/*</exclude-pattern>
+
+ Look through `General` and `Squiz` sniffs for anything you might want to add.
+
+ Maybe add WordCamp\Remote_CSS\output_cached_css to customEscapingFunctions or whichever param is most appropriate
+ Maybe do something similar for set_cache_headers and nonce verification
+
+ 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
+ -->
+
+ <arg name="extensions" value="php" />
+
+ <!-- Show sniff codes in all reports -->
+ <arg value="ps" />
+ <arg name="colors" />
+
+ <!-- Scan all (php) files in the current folder and subfolders -->
+ <file>.</file>
+
+ <rule ref="WordPress-Core">
+ <!-- I don't see anything wrong with this :) -->
+ <exclude name="Squiz.PHP.EmbeddedPhp.ContentAfterOpen" />
+ <exclude name="Squiz.PHP.EmbeddedPhp.ContentBeforeEnd" />
+
+ <!-- I've never heard a compelling argument for this, and it clutters the directory listing with irrelevant noise. -->
+ <exclude name="WordPress.Files.FileName.InvalidClassFileName" />
+
+ <!-- It's often obvious what the placeholder is, so whether or not to include a comment is a judgement call. -->
+ <exclude name="WordPress.WP.I18n.MissingTranslatorsComment" />
+
+ <!-- I know it's a language construct, but it just looks better using the function call syntax. -->
+ <exclude name="PEAR.Files.IncludingFile.BracketsNotRequired" />
+
+ <!-- This requires passing a whitelist of prefixes in order to work, which is not practical for a large and varied codebase. It's also fixes a problem that we're unlikely to cause. -->
+ <exclude name="WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedConstantFound" />
+ <exclude name="WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedVariableFound" />
+ <exclude name="WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound" />
+
+ <!-- Aligning things make the code more readable. `Generic.WhiteSpace.DisallowSpaceIndent` will catch accidental uses of all spaces. -->
+ <exclude name="WordPress.WhiteSpace.PrecisionAlignment.Found" />
+ <exclude name="Generic.Functions.FunctionCallArgumentSpacing.TooMuchSpaceAfterComma" />
+ <exclude name="WordPress.WhiteSpace.OperatorSpacing.SpacingBefore" />
+ <exclude name="PEAR.Functions.FunctionCallSignature.SpaceBeforeCloseBracket" />
+ <exclude name="Squiz.Strings.ConcatenationSpacing.PaddingFound" />
+ </rule>
+
+ <rule ref="WordPress-Docs">
+ <!-- If files/variables are given descriptive names like they should be, then an explicit description is usually unnecessary, so leave this as a judgement call. -->
+ <exclude name="Squiz.Commenting.FunctionComment.MissingParamComment" />
+ <exclude name="Squiz.Commenting.FileComment.Missing" />
+ <exclude name="Squiz.Commenting.ClassComment.Missing" />
+ <exclude name="Generic.Commenting.DocComment.MissingShort" />
+
+ <!-- We really only use basic exceptions, so this is kind of overkill and tedious. -->
+ <exclude name="Squiz.Commenting.FunctionComment.EmptyThrows" />
+ </rule>
+
+ <rule ref="WordPress-VIP">
+ <exclude name="WordPress.VIP.SuperGlobalInputUsage.AccessDetected" />
+
+ <!-- We want these for the best practices, but anything specific to VIP's hosting environment is irrelevant. -->
+ <exclude name="WordPress.VIP.RestrictedFunctions.wp_remote_get_wp_remote_get" />
+ <exclude name="WordPress.VIP.RestrictedFunctions.file_get_contents_file_get_contents" />
+ <exclude name="WordPress.VIP.RestrictedFunctions.get_posts_get_posts" />
+ </rule>
+
+ <rule ref="WordPress-Extra">
+ <!-- I think it's better to have all the `use` statements come right after the namespace line. -->
+ <exclude name="PSR2.Namespaces.NamespaceDeclaration.BlankLineAfter" />
+ </rule>
+</ruleset>
</ins></span></pre>
</div>
</div>
</body>
</html>