Chris@0: <?xml version="1.0"?>
Chris@4: <ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="PHP_CodeSniffer" xsi:noNamespaceSchemaLocation="phpcs.xsd">
Chris@4:     <description>The coding standard for PHP_CodeSniffer itself.</description>
Chris@0: 
Chris@4:     <file>autoload.php</file>
Chris@4:     <file>bin</file>
Chris@4:     <file>scripts</file>
Chris@4:     <file>src</file>
Chris@4:     <file>tests</file>
Chris@0: 
Chris@5:     <exclude-pattern>*/src/Standards/*/Tests/*\.(inc|css|js)$</exclude-pattern>
Chris@5:     <exclude-pattern>*/tests/Core/*/*Test\.(inc|css|js)$</exclude-pattern>
Chris@0: 
Chris@4:     <arg name="basepath" value="."/>
Chris@4:     <arg name="colors"/>
Chris@4:     <arg name="parallel" value="75"/>
Chris@4:     <arg value="np"/>
Chris@0: 
Chris@4:     <!-- Don't hide tokenizer exceptions -->
Chris@4:     <rule ref="Internal.Tokenizer.Exception">
Chris@4:         <type>error</type>
Chris@4:     </rule>
Chris@4: 
Chris@4:     <!-- Include the whole PEAR standard -->
Chris@4:     <rule ref="PEAR">
Chris@4:         <exclude name="PEAR.NamingConventions.ValidFunctionName"/>
Chris@4:         <exclude name="PEAR.NamingConventions.ValidVariableName"/>
Chris@4:         <exclude name="PEAR.Commenting.ClassComment"/>
Chris@4:         <exclude name="PEAR.Commenting.FileComment.MissingCategoryTag"/>
Chris@4:         <exclude name="PEAR.Commenting.FileComment.MissingPackageTag"/>
Chris@4:         <exclude name="PEAR.Commenting.FileComment.MissingLinkTag"/>
Chris@4:         <exclude name="PEAR.Commenting.FileComment.MissingVersion"/>
Chris@4:         <exclude name="PEAR.Commenting.InlineComment"/>
Chris@4:     </rule>
Chris@4: 
Chris@4:     <!-- Include some sniffs from other standards that don't conflict with PEAR -->
Chris@4:     <rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
Chris@4:     <rule ref="Squiz.Arrays.ArrayDeclaration"/>
Chris@4:     <rule ref="Squiz.Commenting.ClosingDeclarationComment"/>
Chris@4:     <rule ref="Squiz.ControlStructures.ControlSignature"/>
Chris@4:     <rule ref="Squiz.ControlStructures.ElseIfDeclaration"/>
Chris@4:     <rule ref="Squiz.Commenting.BlockComment"/>
Chris@4:     <rule ref="Squiz.Commenting.DocCommentAlignment"/>
Chris@4:     <rule ref="Squiz.Commenting.EmptyCatchComment"/>
Chris@4:     <rule ref="Squiz.Commenting.InlineComment"/>
Chris@4:     <rule ref="Squiz.Commenting.LongConditionClosingComment"/>
Chris@4:     <rule ref="Squiz.Commenting.PostStatementComment"/>
Chris@4:     <rule ref="Squiz.Commenting.VariableComment"/>
Chris@4:     <rule ref="Squiz.Formatting.OperatorBracket"/>
Chris@4:     <rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing"/>
Chris@4:     <rule ref="Squiz.Operators.ComparisonOperatorUsage"/>
Chris@4:     <rule ref="Squiz.PHP.DisallowInlineIf"/>
Chris@4:     <rule ref="Squiz.Scope.MethodScope"/>
Chris@4:     <rule ref="Squiz.Strings.ConcatenationSpacing"/>
Chris@4:     <rule ref="Squiz.WhiteSpace.ControlStructureSpacing"/>
Chris@4:     <rule ref="Squiz.WhiteSpace.FunctionClosingBraceSpace"/>
Chris@4:     <rule ref="Squiz.WhiteSpace.FunctionSpacing"/>
Chris@4:     <rule ref="Squiz.WhiteSpace.OperatorSpacing"/>
Chris@4:     <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace"/>
Chris@4:     <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
Chris@4:     <rule ref="Generic.Commenting.Todo"/>
Chris@4:     <rule ref="Generic.ControlStructures.InlineControlStructure"/>
Chris@4:     <rule ref="Generic.Formatting.DisallowMultipleStatements"/>
Chris@4:     <rule ref="Generic.Formatting.SpaceAfterCast"/>
Chris@4:     <rule ref="Generic.NamingConventions.ConstructorName"/>
Chris@4:     <rule ref="Generic.PHP.DeprecatedFunctions"/>
Chris@4:     <rule ref="Generic.PHP.LowerCaseKeyword"/>
Chris@4:     <rule ref="Generic.Strings.UnnecessaryStringConcat"/>
Chris@4:     <rule ref="Generic.WhiteSpace.IncrementDecrementSpacing"/>
Chris@4:     <rule ref="PSR2.Classes.PropertyDeclaration"/>
Chris@4:     <rule ref="PSR2.Methods.MethodDeclaration"/>
Chris@4:     <rule ref="PSR2.Files.EndFileNewline"/>
Chris@4:     <rule ref="Zend.Files.ClosingTag"/>
Chris@4: 
Chris@4:     <!-- PEAR uses warnings for inline control structures, so switch back to errors -->
Chris@4:     <rule ref="Generic.ControlStructures.InlineControlStructure">
Chris@4:         <properties>
Chris@4:             <property name="error" value="true"/>
Chris@4:         </properties>
Chris@4:     </rule>
Chris@4: 
Chris@4:     <!-- We use custom indent rules for arrays -->
Chris@4:     <rule ref="Generic.Arrays.ArrayIndent"/>
Chris@4:     <rule ref="Squiz.Arrays.ArrayDeclaration.KeyNotAligned">
Chris@4:         <severity>0</severity>
Chris@4:     </rule>
Chris@4:     <rule ref="Squiz.Arrays.ArrayDeclaration.ValueNotAligned">
Chris@4:         <severity>0</severity>
Chris@4:     </rule>
Chris@4:     <rule ref="Squiz.Arrays.ArrayDeclaration.CloseBraceNotAligned">
Chris@4:         <severity>0</severity>
Chris@4:     </rule>
Chris@4:     <rule ref="Squiz.Arrays.ArrayDeclaration.CloseBraceNewLine">
Chris@4:         <severity>0</severity>
Chris@4:     </rule>
Chris@4: 
Chris@4:     <!-- Check var names, but we don't want leading underscores for private vars -->
Chris@4:     <rule ref="Squiz.NamingConventions.ValidVariableName"/>
Chris@4:     <rule ref="Squiz.NamingConventions.ValidVariableName.PrivateNoUnderscore">
Chris@4:         <severity>0</severity>
Chris@4:     </rule>
Chris@4: 
Chris@4:     <!-- Only one argument per line in multi-line function calls -->
Chris@4:     <rule ref="PEAR.Functions.FunctionCallSignature">
Chris@4:         <properties>
Chris@4:             <property name="allowMultipleArguments" value="false"/>
Chris@4:         </properties>
Chris@4:     </rule>
Chris@4: 
Chris@4:     <!-- Have 12 chars padding maximum and always show as errors -->
Chris@4:     <rule ref="Generic.Formatting.MultipleStatementAlignment">
Chris@4:         <properties>
Chris@4:             <property name="maxPadding" value="12"/>
Chris@4:             <property name="error" value="true"/>
Chris@4:         </properties>
Chris@4:     </rule>
Chris@4: 
Chris@4:     <!-- Ban some functions -->
Chris@4:     <rule ref="Generic.PHP.ForbiddenFunctions">
Chris@4:         <properties>
Chris@4:             <property name="forbiddenFunctions" type="array">
Chris@4:                 <element key="sizeof" value="count"/>
Chris@4:                 <element key="delete" value="unset"/>
Chris@4:                 <element key="print" value="echo"/>
Chris@4:                 <element key="is_null" value="null"/>
Chris@4:                 <element key="create_function" value="null"/>
Chris@4:             </property>
Chris@4:         </properties>
Chris@4:     </rule>
Chris@4: 
Chris@4:     <!-- Private methods MUST not be prefixed with an underscore -->
Chris@4:     <rule ref="PSR2.Methods.MethodDeclaration.Underscore">
Chris@4:         <type>error</type>
Chris@4:     </rule>
Chris@4: 
Chris@4:     <!-- Private properties MUST not be prefixed with an underscore -->
Chris@4:     <rule ref="PSR2.Classes.PropertyDeclaration.Underscore">
Chris@4:         <type>error</type>
Chris@4:     </rule>
Chris@4: 
Chris@4:     <!-- The testing bootstrap file uses string concats to stop IDEs seeing the class aliases -->
Chris@4:     <rule ref="Generic.Strings.UnnecessaryStringConcat">
Chris@4:         <exclude-pattern>tests/bootstrap.php</exclude-pattern>
Chris@4:     </rule>
Chris@4: 
Chris@0: </ruleset>