diff options
| author | Andreas Fischer <bantu@phpbb.com> | 2013-10-27 17:50:58 +0100 |
|---|---|---|
| committer | Andreas Fischer <bantu@phpbb.com> | 2013-10-27 17:50:58 +0100 |
| commit | 8c83acb28bb450adf978a0a6eff6bb9819dec1f7 (patch) | |
| tree | e08bb442f52f1bae800a655e28788b545d575f83 /build | |
| parent | c230701e48e393641957fe46fde521f713c203e9 (diff) | |
| download | forums-8c83acb28bb450adf978a0a6eff6bb9819dec1f7.tar forums-8c83acb28bb450adf978a0a6eff6bb9819dec1f7.tar.gz forums-8c83acb28bb450adf978a0a6eff6bb9819dec1f7.tar.bz2 forums-8c83acb28bb450adf978a0a6eff6bb9819dec1f7.tar.xz forums-8c83acb28bb450adf978a0a6eff6bb9819dec1f7.zip | |
[task/code-sniffer] Add code sniffer rulesets.
PHPBB3-11980
Diffstat (limited to 'build')
| -rw-r--r-- | build/code_sniffer/ruleset-minimum.xml | 12 | ||||
| -rw-r--r-- | build/code_sniffer/ruleset-php-legacy.xml | 25 | ||||
| -rw-r--r-- | build/code_sniffer/ruleset-php-strict.xml | 42 |
3 files changed, 79 insertions, 0 deletions
diff --git a/build/code_sniffer/ruleset-minimum.xml b/build/code_sniffer/ruleset-minimum.xml new file mode 100644 index 0000000000..2de1fb4be4 --- /dev/null +++ b/build/code_sniffer/ruleset-minimum.xml @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<ruleset name="phpBB Minimum Standard"> + + <description>phpBB minimum coding standard</description> + + <!-- All code files MUST use only UTF-8 without BOM. --> + <rule ref="Generic.Files.ByteOrderMark" /> + + <!-- All code files MUST use the Unix LF (linefeed) line ending. --> + <rule ref="Generic.Files.LineEndings" /> + +</ruleset> diff --git a/build/code_sniffer/ruleset-php-legacy.xml b/build/code_sniffer/ruleset-php-legacy.xml new file mode 100644 index 0000000000..ebc85c4fef --- /dev/null +++ b/build/code_sniffer/ruleset-php-legacy.xml @@ -0,0 +1,25 @@ +<?xml version="1.0"?> +<ruleset name="phpBB PHP Legacy Standard"> + + <description>phpBB legacy coding standard for PHP files</description> + + <rule ref="./ruleset-minimum.xml" /> + + <!-- The body of each structure MUST be enclosed by braces. --> + <rule ref="Generic.ControlStructures.InlineControlStructure" /> + + <!-- All PHP files MUST end with a single blank line. --> + + <!-- Class constants MUST be declared in all upper case with underscore separators. --> + <rule ref="Generic.NamingConventions.UpperCaseConstantName" /> + + <!-- Only <?php, no short tags. --> + <rule ref="Generic.PHP.DisallowShortOpenTag.EchoFound" /> + + <!-- Method arguments with default values MUST go at the end of the argument list. --> + <rule ref="PEAR.Functions.ValidDefaultValue" /> + + <!-- The ?> closing tag MUST be omitted from files containing only PHP. --> + <rule ref="Zend.Files.ClosingTag" /> + +</ruleset> diff --git a/build/code_sniffer/ruleset-php-strict.xml b/build/code_sniffer/ruleset-php-strict.xml new file mode 100644 index 0000000000..8580090c69 --- /dev/null +++ b/build/code_sniffer/ruleset-php-strict.xml @@ -0,0 +1,42 @@ +<?xml version="1.0"?> +<ruleset name="phpBB PHP Strict Standard"> + + <description>phpBB coding standard for PHP files</description> + + <rule ref="./ruleset-php-legacy.xml" /> + + <!-- There SHOULD NOT be more than 80 characters per line + There MUST NOT be more than 120 characters per line --> + <!-- + <rule ref="Generic.Files.LineLength"> + <properties> + <property name="lineLimit" value="80"/> + <property name="absoluteLineLimit" value="120"/> + </properties> + </rule> + --> + + <!-- The PHP constants true, false, and null MUST be in lower case. --> + <rule ref="Generic.PHP.LowerCaseConstant" /> + + <!-- PHP keywords MUST be in lower case. --> + <rule ref="Generic.PHP.LowerCaseKeyword" /> + + <!-- There MUST NOT be trailing whitespace at the end of lines. --> + <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace" /> + + <!-- There MUST NOT be whitespace before the first content of a file --> + <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace.StartFile" /> + + <!-- There MUST NOT be whitespace after the last content of a file --> + <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace.EndFile" /> + + <!-- Functions MUST NOT contain multiple empty lines in a row --> + <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace.EmptyLines" /> + + <!-- When present, all use declarations MUST go after the namespace declaration. + There MUST be one use keyword per declaration. + There MUST be one blank line after the use block. --> + <rule ref="PSR2.Namespaces.UseDeclaration" /> + +</ruleset> |