Chris@0: <?xml version="1.0" encoding="UTF-8"?>
Chris@0: <ruleset name="drupal_core">
Chris@0:   <description>Default PHP CodeSniffer configuration for Drupal core.</description>
Chris@0:   <file>.</file>
Chris@14:   <file>scripts/drupal.sh</file>
Chris@14:   <file>scripts/password-hash.sh</file>
Chris@14:   <file>scripts/rebuild_token_calculator.sh</file>
Chris@14:   <file>scripts/run-tests.sh</file>
Chris@14:   <file>scripts/update-countries.sh</file>
Chris@17:   <arg name="extensions" value="inc,install,module,php,profile,test,theme,yml"/>
Chris@0: 
Chris@0:   <!--Exclude third party code.-->
Chris@0:   <exclude-pattern>./assets/vendor/*</exclude-pattern>
Chris@17:   <!--Exclude folders used by common frontend tools. These folders match the file_scan_ignore_directories setting in default.settings.php-->
Chris@17:   <exclude-pattern>*/node_modules/*</exclude-pattern>
Chris@17:   <exclude-pattern>*/bower_components/*</exclude-pattern>
Chris@0: 
Chris@0:   <!--Exclude test files that are intentionally empty, or intentionally violate coding standards.-->
Chris@0:   <exclude-pattern>./modules/system/tests/fixtures/HtaccessTest</exclude-pattern>
Chris@0: 
Chris@0:   <!-- Exclude third-party code maintained within core that does not follow our standards. -->
Chris@0:   <!-- @todo This rule may be removed when https://www.drupal.org/node/1848264 is resolved. -->
Chris@0:   <exclude-pattern>./core/lib/Drupal/Component/Diff/</exclude-pattern>
Chris@0: 
Chris@0:   <!-- Only include specific sniffs that pass. This ensures that, if new sniffs are added, HEAD does not fail.-->
Chris@0:   <!-- Drupal sniffs -->
Chris@18:   <rule ref="Drupal.Arrays.Array">
Chris@17:     <!-- Sniff for these errors: CommaLastItem -->
Chris@18:     <exclude name="Drupal.Arrays.Array.ArrayClosingIndentation"/>
Chris@18:     <exclude name="Drupal.Arrays.Array.ArrayIndentation"/>
Chris@18:     <exclude name="Drupal.Arrays.Array.LongLineDeclaration"/>
Chris@17:   </rule>
Chris@14:   <rule ref="Drupal.Classes.ClassCreateInstance"/>
Chris@14:   <rule ref="Drupal.Classes.ClassDeclaration"/>
Chris@14:   <rule ref="Drupal.Classes.FullyQualifiedNamespace"/>
Chris@14:   <rule ref="Drupal.Classes.InterfaceName"/>
Chris@14:   <rule ref="Drupal.Classes.UnusedUseStatement"/>
Chris@14:   <rule ref="Drupal.Classes.UseLeadingBackslash"/>
Chris@14:   <rule ref="Drupal.CSS.ClassDefinitionNameSpacing"/>
Chris@14:   <rule ref="Drupal.CSS.ColourDefinition"/>
Chris@14:   <rule ref="Drupal.Commenting.ClassComment">
Chris@0:     <exclude name="Drupal.Commenting.ClassComment.Missing"/>
Chris@0:   </rule>
Chris@14:   <rule ref="Drupal.Commenting.DataTypeNamespace"/>
Chris@14:   <rule ref="Drupal.Commenting.DocComment">
Chris@0:     <!-- Sniff for these errors: SpacingAfterTagGroup, WrongEnd, SpacingBetween,
Chris@0:       ContentAfterOpen, SpacingBeforeShort, TagValueIndent, ShortStartSpace,
Chris@17:       SpacingAfter, LongNotCapital -->
Chris@0:     <!-- ParamNotFirst still not decided for PHPUnit-based tests.
Chris@0:       @see https://www.drupal.org/node/2253915 -->
Chris@0:     <exclude name="Drupal.Commenting.DocComment.ParamNotFirst"/>
Chris@0:     <exclude name="Drupal.Commenting.DocComment.SpacingBeforeTags"/>
Chris@0:     <exclude name="Drupal.Commenting.DocComment.LongFullStop"/>
Chris@0:     <exclude name="Drupal.Commenting.DocComment.ShortNotCapital"/>
Chris@0:     <exclude name="Drupal.Commenting.DocComment.ShortFullStop"/>
Chris@0:     <!-- TagsNotGrouped and ParamGroup have false-positives.
Chris@0:       @see https://www.drupal.org/node/2060925 -->
Chris@0:     <exclude name="Drupal.Commenting.DocComment.TagsNotGrouped"/>
Chris@0:     <exclude name="Drupal.Commenting.DocComment.ParamGroup"/>
Chris@0:     <exclude name="Drupal.Commenting.DocComment.ShortSingleLine"/>
Chris@0:     <exclude name="Drupal.Commenting.DocComment.TagGroupSpacing"/>
Chris@0:     <exclude name="Drupal.Commenting.DocComment.MissingShort"/>
Chris@0:   </rule>
Chris@14:   <rule ref="Drupal.Commenting.DocCommentStar"/>
Chris@14:   <rule ref="Drupal.Commenting.FileComment"/>
Chris@14:   <rule ref="Drupal.Commenting.FunctionComment">
Chris@0:     <exclude name="Drupal.Commenting.FunctionComment.IncorrectTypeHint"/>
Chris@0:     <exclude name="Drupal.Commenting.FunctionComment.InvalidNoReturn"/>
Chris@0:     <exclude name="Drupal.Commenting.FunctionComment.InvalidTypeHint"/>
Chris@0:     <exclude name="Drupal.Commenting.FunctionComment.Missing"/>
Chris@0:     <exclude name="Drupal.Commenting.FunctionComment.MissingParamComment"/>
Chris@0:     <exclude name="Drupal.Commenting.FunctionComment.MissingParamType"/>
Chris@0:     <exclude name="Drupal.Commenting.FunctionComment.MissingReturnComment"/>
Chris@0:     <exclude name="Drupal.Commenting.FunctionComment.MissingReturnType"/>
Chris@0:     <exclude name="Drupal.Commenting.FunctionComment.ParamCommentFullStop"/>
Chris@0:     <exclude name="Drupal.Commenting.FunctionComment.ParamMissingDefinition"/>
Chris@0:     <exclude name="Drupal.Commenting.FunctionComment.TypeHintMissing"/>
Chris@0:   </rule>
Chris@14:   <rule ref="Drupal.Commenting.VariableComment">
Chris@14:     <!-- Sniff for: DuplicateVar, EmptyVar, InlineVariableName -->
Chris@14:     <exclude name="Drupal.Commenting.VariableComment.IncorrectVarType"/>
Chris@14:     <exclude name="Drupal.Commenting.VariableComment.MissingVar"/>
Chris@14:     <exclude name="Drupal.Commenting.VariableComment.VarOrder"/>
Chris@14:     <exclude name="Drupal.Commenting.VariableComment.WrongStyle"/>
Chris@14:   </rule>
Chris@14:   <rule ref="Drupal.Commenting.InlineComment">
Chris@14:     <!-- Sniff for: NoSpaceBefore, WrongStyle -->
Chris@0:     <exclude name="Drupal.Commenting.InlineComment.DocBlock"/>
Chris@0:     <exclude name="Drupal.Commenting.InlineComment.InvalidEndChar"/>
Chris@0:     <exclude name="Drupal.Commenting.InlineComment.NotCapital"/>
Chris@0:     <exclude name="Drupal.Commenting.InlineComment.SpacingAfter"/>
Chris@0:     <exclude name="Drupal.Commenting.InlineComment.SpacingBefore"/>
Chris@0:   </rule>
Chris@14:   <rule ref="Drupal.Commenting.PostStatementComment"/>
Chris@14:   <rule ref="Drupal.ControlStructures.ElseIf"/>
Chris@14:   <rule ref="Drupal.ControlStructures.ControlSignature"/>
Chris@14:   <rule ref="Drupal.ControlStructures.InlineControlStructure"/>
Chris@14:   <rule ref="Drupal.Files.EndFileNewline"/>
Chris@14:   <rule ref="Drupal.Files.FileEncoding"/>
Chris@14:   <rule ref="Drupal.Files.TxtFileLineLength"/>
Chris@14:   <rule ref="Drupal.Formatting.MultiLineAssignment"/>
Chris@17:   <rule ref="Drupal.Formatting.MultipleStatementAlignment"/>
Chris@14:   <rule ref="Drupal.Formatting.SpaceInlineIf"/>
Chris@14:   <rule ref="Drupal.Formatting.SpaceUnaryOperator"/>
Chris@14:   <rule ref="Drupal.Functions.DiscouragedFunctions"/>
Chris@14:   <rule ref="Drupal.Functions.FunctionDeclaration"/>
Chris@14:   <rule ref="Drupal.InfoFiles.AutoAddedKeys"/>
Chris@14:   <rule ref="Drupal.InfoFiles.ClassFiles"/>
Chris@14:   <rule ref="Drupal.InfoFiles.DuplicateEntry"/>
Chris@14:   <rule ref="Drupal.InfoFiles.Required"/>
Chris@14:   <rule ref="Drupal.Methods.MethodDeclaration">
Chris@0:     <!-- Silence method name underscore warning which is covered already in
Chris@0:       Drupal.NamingConventions.ValidFunctionName.ScopeNotCamelCaps. -->
Chris@0:     <exclude name="Drupal.Methods.MethodDeclaration.Underscore"/>
Chris@0:   </rule>
Chris@14:   <rule ref="Drupal.NamingConventions.ValidVariableName">
Chris@0:     <!-- Sniff for: LowerStart -->
Chris@0:     <exclude name="Drupal.NamingConventions.ValidVariableName.LowerCamelName"/>
Chris@0:   </rule>
Chris@14:   <rule ref="Drupal.Scope.MethodScope"/>
Chris@14:   <rule ref="Drupal.Semantics.EmptyInstall"/>
Chris@14:   <rule ref="Drupal.Semantics.FunctionAlias"/>
Chris@14:   <rule ref="Drupal.Semantics.FunctionT">
Chris@0:     <exclude name="Drupal.Semantics.FunctionT.NotLiteralString"/>
Chris@0:     <exclude name="Drupal.Semantics.FunctionT.ConcatString"/>
Chris@0:   </rule>
Chris@14:   <rule ref="Drupal.Semantics.FunctionWatchdog"/>
Chris@14:   <rule ref="Drupal.Semantics.InstallHooks"/>
Chris@14:   <rule ref="Drupal.Semantics.LStringTranslatable"/>
Chris@14:   <rule ref="Drupal.Semantics.PregSecurity"/>
Chris@14:   <rule ref="Drupal.Semantics.TInHookMenu"/>
Chris@14:   <rule ref="Drupal.Semantics.TInHookSchema"/>
Chris@18:   <rule ref="Drupal.Strings.UnnecessaryStringConcat"/>
Chris@14:   <rule ref="Drupal.WhiteSpace.CloseBracketSpacing"/>
Chris@14:   <rule ref="Drupal.WhiteSpace.Comma"/>
Chris@14:   <rule ref="Drupal.WhiteSpace.EmptyLines"/>
Chris@14:   <rule ref="Drupal.WhiteSpace.Namespace"/>
Chris@14:   <rule ref="Drupal.WhiteSpace.ObjectOperatorIndent"/>
Chris@14:   <rule ref="Drupal.WhiteSpace.ObjectOperatorSpacing"/>
Chris@14:   <rule ref="Drupal.WhiteSpace.OpenBracketSpacing"/>
Chris@14:   <rule ref="Drupal.WhiteSpace.OpenTagNewline"/>
Chris@14:   <rule ref="Drupal.WhiteSpace.OperatorSpacing"/>
Chris@14:   <rule ref="Drupal.WhiteSpace.ScopeClosingBrace"/>
Chris@14:   <rule ref="Drupal.WhiteSpace.ScopeIndent"/>
Chris@0: 
Chris@0:   <!-- Drupal Practice sniffs -->
Chris@14:   <rule ref="DrupalPractice.Commenting.ExpectedException"/>
Chris@0: 
Chris@0:   <!-- Generic sniffs -->
Chris@14:   <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
Chris@18:   <rule ref="Generic.CodeAnalysis.EmptyPHPStatement" />
Chris@0:   <rule ref="Generic.Files.ByteOrderMark"/>
Chris@0:   <rule ref="Generic.Files.LineEndings"/>
Chris@0:   <rule ref="Generic.Formatting.SpaceAfterCast"/>
Chris@0:   <rule ref="Generic.Functions.FunctionCallArgumentSpacing"/>
Chris@14:   <rule ref="Generic.Functions.OpeningFunctionBraceKernighanRitchie">
Chris@14:     <properties>
Chris@14:       <property name="checkClosures" value="true"/>
Chris@14:     </properties>
Chris@14:   </rule>
Chris@0:   <rule ref="Generic.NamingConventions.ConstructorName"/>
Chris@0:   <rule ref="Generic.NamingConventions.UpperCaseConstantName"/>
Chris@0:   <rule ref="Generic.PHP.DeprecatedFunctions"/>
Chris@0:   <rule ref="Generic.PHP.DisallowShortOpenTag"/>
Chris@14:   <rule ref="Generic.PHP.LowerCaseKeyword"/>
Chris@0:   <rule ref="Generic.PHP.UpperCaseConstant"/>
Chris@0:   <rule ref="Generic.WhiteSpace.DisallowTabIndent"/>
Chris@0: 
Chris@17:   <!-- Internal sniffs -->
Chris@17:   <rule ref="Internal.NoCodeFound">
Chris@17:     <!-- No PHP code in *.yml -->
Chris@17:     <exclude-pattern>*.yml</exclude-pattern>
Chris@17:   </rule>
Chris@17: 
Chris@0:   <!-- MySource sniffs -->
Chris@0:   <rule ref="MySource.Debug.DebugCode"/>
Chris@0: 
Chris@0:   <!-- PEAR sniffs -->
Chris@0:   <rule ref="PEAR.Files.IncludingFile"/>
Chris@0:   <!-- Disable some error messages that we do not want. -->
Chris@0:   <rule ref="PEAR.Files.IncludingFile.UseIncludeOnce">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="PEAR.Files.IncludingFile.UseInclude">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="PEAR.Files.IncludingFile.UseRequireOnce">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="PEAR.Files.IncludingFile.UseRequire">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="PEAR.Functions.ValidDefaultValue"/>
Chris@0: 
Chris@14:   <!-- PEAR sniffs -->
Chris@14:   <rule ref="PEAR.Functions.FunctionCallSignature"/>
Chris@14:   <!-- The sniffs inside PEAR.Functions.FunctionCallSignature silenced below are
Chris@14:     also silenced in Drupal CS' ruleset.xml. The code below is a 1-on-1 copy
Chris@14:     from that file. -->
Chris@14:   <!-- Disable some error messages that we already cover. -->
Chris@14:   <rule ref="PEAR.Functions.FunctionCallSignature.SpaceAfterOpenBracket">
Chris@14:     <severity>0</severity>
Chris@14:   </rule>
Chris@14:   <rule ref="PEAR.Functions.FunctionCallSignature.SpaceBeforeCloseBracket">
Chris@14:     <severity>0</severity>
Chris@14:   </rule>
Chris@14:   <!-- Disable some error messages that we do not want. -->
Chris@14:   <rule ref="PEAR.Functions.FunctionCallSignature.Indent">
Chris@14:     <severity>0</severity>
Chris@14:   </rule>
Chris@18:   <rule ref="PEAR.Functions.FunctionCallSignature.OpeningIndent">
Chris@18:     <severity>0</severity>
Chris@18:   </rule>
Chris@14:   <rule ref="PEAR.Functions.FunctionCallSignature.ContentAfterOpenBracket">
Chris@14:     <severity>0</severity>
Chris@14:   </rule>
Chris@14:   <rule ref="PEAR.Functions.FunctionCallSignature.CloseBracketLine">
Chris@14:     <severity>0</severity>
Chris@14:   </rule>
Chris@14:   <rule ref="PEAR.Functions.FunctionCallSignature.EmptyLine">
Chris@14:     <severity>0</severity>
Chris@14:   </rule>
Chris@14: 
Chris@0:   <!-- PSR-2 sniffs -->
Chris@0:   <rule ref="PSR2.Classes.PropertyDeclaration">
Chris@0:     <exclude name="PSR2.Classes.PropertyDeclaration.Underscore"/>
Chris@0:   </rule>
Chris@14:   <rule ref="PSR2.Namespaces.NamespaceDeclaration"/>
Chris@14:   <rule ref="PSR2.Namespaces.UseDeclaration">
Chris@14:     <exclude name="PSR2.Namespaces.UseDeclaration.UseAfterNamespace"/>
Chris@14:   </rule>
Chris@0: 
Chris@0:   <!-- Squiz sniffs -->
Chris@0:   <rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
Chris@0:   <rule ref="Squiz.Arrays.ArrayDeclaration">
Chris@0:     <exclude name="Squiz.Arrays.ArrayDeclaration.NoKeySpecified"/>
Chris@0:     <exclude name="Squiz.Arrays.ArrayDeclaration.KeySpecified"/>
Chris@0:   </rule>
Chris@0:   <!-- Disable some error messages that we do not want. -->
Chris@0:   <rule ref="Squiz.Arrays.ArrayDeclaration.CloseBraceNotAligned">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="Squiz.Arrays.ArrayDeclaration.DoubleArrowNotAligned">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="Squiz.Arrays.ArrayDeclaration.FirstValueNoNewline">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="Squiz.Arrays.ArrayDeclaration.KeyNotAligned">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="Squiz.Arrays.ArrayDeclaration.MultiLineNotAllowed">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="Squiz.Arrays.ArrayDeclaration.NoComma">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="Squiz.Arrays.ArrayDeclaration.NoCommaAfterLast">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="Squiz.Arrays.ArrayDeclaration.NotLowerCase">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="Squiz.Arrays.ArrayDeclaration.ValueNotAligned">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="Squiz.Arrays.ArrayDeclaration.ValueNoNewline">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@14:   <rule ref="Squiz.ControlStructures.ForEachLoopDeclaration"/>
Chris@0:   <!-- Disable some error messages that we already cover. -->
Chris@0:   <rule ref="Squiz.ControlStructures.ForEachLoopDeclaration.AsNotLower">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="Squiz.ControlStructures.ForEachLoopDeclaration.SpaceAfterOpen">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="Squiz.ControlStructures.ForEachLoopDeclaration.SpaceBeforeClose">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="Squiz.ControlStructures.ForLoopDeclaration"/>
Chris@0:   <!-- Disable some error messages that we already cover. -->
Chris@0:   <rule ref="Squiz.ControlStructures.ForLoopDeclaration.SpacingAfterOpen">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@0:   <rule ref="Squiz.ControlStructures.ForLoopDeclaration.SpacingBeforeClose">
Chris@0:     <severity>0</severity>
Chris@0:   </rule>
Chris@14:   <rule ref="Squiz.Functions.MultiLineFunctionDeclaration"/>
Chris@14:   <rule ref="Squiz.Functions.MultiLineFunctionDeclaration.BraceOnSameLine">
Chris@14:     <severity>0</severity>
Chris@14:   </rule>
Chris@14:   <rule ref="Squiz.Functions.MultiLineFunctionDeclaration.ContentAfterBrace">
Chris@14:     <severity>0</severity>
Chris@14:   </rule>
Chris@14:   <!-- Standard yet to be finalized on this (https://www.drupal.org/node/1539712). -->
Chris@14:   <rule ref="Squiz.Functions.MultiLineFunctionDeclaration.FirstParamSpacing">
Chris@14:     <severity>0</severity>
Chris@14:   </rule>
Chris@14:   <rule ref="Squiz.Functions.MultiLineFunctionDeclaration.Indent">
Chris@14:     <severity>0</severity>
Chris@14:   </rule>
Chris@14:   <rule ref="Squiz.Functions.MultiLineFunctionDeclaration.CloseBracketLine">
Chris@14:     <severity>0</severity>
Chris@14:   </rule>
Chris@14:   <rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing">
Chris@14:     <properties>
Chris@14:       <property name="equalsSpacing" value="1"/>
Chris@14:     </properties>
Chris@14:   </rule>
Chris@14:   <rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing.NoSpaceBeforeArg">
Chris@14:     <severity>0</severity>
Chris@14:   </rule>
Chris@0:   <rule ref="Squiz.PHP.LowercasePHPFunctions"/>
Chris@0:   <rule ref="Squiz.Strings.ConcatenationSpacing">
Chris@0:     <properties>
Chris@0:       <property name="spacing" value="1"/>
Chris@0:       <property name="ignoreNewlines" value="true"/>
Chris@0:     </properties>
Chris@0:   </rule>
Chris@17:   <rule ref="Squiz.WhiteSpace.FunctionSpacing">
Chris@17:     <properties>
Chris@17:       <property name="spacing" value="1"/>
Chris@17:     </properties>
Chris@17:   </rule>
Chris@14:   <rule ref="Squiz.WhiteSpace.LanguageConstructSpacing" />
Chris@14:   <rule ref="Squiz.WhiteSpace.SemicolonSpacing"/>
Chris@14:   <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace"/>
Chris@0: 
Chris@0:   <!-- Zend sniffs -->
Chris@0:   <rule ref="Zend.Files.ClosingTag"/>
Chris@0: 
Chris@0: </ruleset>