322 lines
14 KiB
XML
322 lines
14 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!-- This file contains coding standards directives for the Drupal Examples for
|
|
Developers project. It uses the PHP Code Sniffer and Drupal Coder projects
|
|
to enforce standard Drupal coding standards on this project. See
|
|
https://www.drupal.org/node/2176147 for instructions on how to add a sniff
|
|
here.-->
|
|
<ruleset name="drupal_examples">
|
|
<description>Default PHP CodeSniffer configuration for Drupal core.</description>
|
|
<file>.</file>
|
|
<!-- Only include specific sniffs that pass. This ensures that, if new sniffs are added, HEAD does not fail.-->
|
|
<!-- Drupal sniffs -->
|
|
<rule ref="Drupal.Arrays.Array">
|
|
<!-- Sniff for these errors: CommaLastItem -->
|
|
<exclude name="Drupal.Arrays.Array.ArrayClosingIndentation"/>
|
|
<exclude name="Drupal.Arrays.Array.ArrayIndentation"/>
|
|
<exclude name="Drupal.Arrays.Array.LongLineDeclaration"/>
|
|
</rule>
|
|
<rule ref="Drupal.Classes.ClassCreateInstance"/>
|
|
<rule ref="Drupal.Classes.ClassDeclaration"/>
|
|
<rule ref="Drupal.Classes.FullyQualifiedNamespace"/>
|
|
<rule ref="Drupal.Classes.InterfaceName"/>
|
|
<rule ref="Drupal.Classes.UnusedUseStatement"/>
|
|
<rule ref="Drupal.Classes.UseLeadingBackslash"/>
|
|
<rule ref="Drupal.CSS.ClassDefinitionNameSpacing"/>
|
|
<rule ref="Drupal.CSS.ColourDefinition"/>
|
|
<rule ref="Drupal.Commenting.ClassComment">
|
|
<exclude name="Drupal.Commenting.ClassComment.Missing"/>
|
|
</rule>
|
|
<rule ref="Drupal.Commenting.DataTypeNamespace"/>
|
|
<rule ref="Drupal.Commenting.DocComment">
|
|
<!-- Sniff for these errors: SpacingAfterTagGroup, WrongEnd, SpacingBetween,
|
|
ContentAfterOpen, SpacingBeforeShort, TagValueIndent, ShortStartSpace,
|
|
SpacingAfter, LongNotCapital -->
|
|
<!-- ParamNotFirst still not decided for PHPUnit-based tests.
|
|
@see https://www.drupal.org/node/2253915 -->
|
|
<exclude name="Drupal.Commenting.DocComment.ParamNotFirst"/>
|
|
<exclude name="Drupal.Commenting.DocComment.SpacingBeforeTags"/>
|
|
<exclude name="Drupal.Commenting.DocComment.LongFullStop"/>
|
|
<exclude name="Drupal.Commenting.DocComment.ShortNotCapital"/>
|
|
<exclude name="Drupal.Commenting.DocComment.ShortFullStop"/>
|
|
<!-- TagsNotGrouped and ParamGroup have false-positives.
|
|
@see https://www.drupal.org/node/2060925 -->
|
|
<exclude name="Drupal.Commenting.DocComment.TagsNotGrouped"/>
|
|
<exclude name="Drupal.Commenting.DocComment.ParamGroup"/>
|
|
<exclude name="Drupal.Commenting.DocComment.ShortSingleLine"/>
|
|
<exclude name="Drupal.Commenting.DocComment.TagGroupSpacing"/>
|
|
<exclude name="Drupal.Commenting.DocComment.MissingShort"/>
|
|
</rule>
|
|
<rule ref="Drupal.Commenting.DocCommentStar"/>
|
|
<rule ref="Drupal.Commenting.FileComment"/>
|
|
<rule ref="Drupal.Commenting.FunctionComment">
|
|
<exclude name="Drupal.Commenting.FunctionComment.IncorrectTypeHint"/>
|
|
<exclude name="Drupal.Commenting.FunctionComment.InvalidNoReturn"/>
|
|
<exclude name="Drupal.Commenting.FunctionComment.InvalidTypeHint"/>
|
|
<exclude name="Drupal.Commenting.FunctionComment.Missing"/>
|
|
<exclude name="Drupal.Commenting.FunctionComment.MissingParamComment"/>
|
|
<exclude name="Drupal.Commenting.FunctionComment.MissingParamType"/>
|
|
<exclude name="Drupal.Commenting.FunctionComment.MissingReturnComment"/>
|
|
<exclude name="Drupal.Commenting.FunctionComment.MissingReturnType"/>
|
|
<exclude name="Drupal.Commenting.FunctionComment.ParamCommentFullStop"/>
|
|
<exclude name="Drupal.Commenting.FunctionComment.ParamMissingDefinition"/>
|
|
<exclude name="Drupal.Commenting.FunctionComment.TypeHintMissing"/>
|
|
</rule>
|
|
<rule ref="Drupal.Commenting.VariableComment">
|
|
<!-- Sniff for: DuplicateVar, EmptyVar, InlineVariableName -->
|
|
<exclude name="Drupal.Commenting.VariableComment.IncorrectVarType"/>
|
|
<exclude name="Drupal.Commenting.VariableComment.MissingVar"/>
|
|
<exclude name="Drupal.Commenting.VariableComment.VarOrder"/>
|
|
<exclude name="Drupal.Commenting.VariableComment.WrongStyle"/>
|
|
</rule>
|
|
<rule ref="Drupal.Commenting.InlineComment">
|
|
<!-- Sniff for: NoSpaceBefore, WrongStyle -->
|
|
<exclude name="Drupal.Commenting.InlineComment.DocBlock"/>
|
|
<exclude name="Drupal.Commenting.InlineComment.InvalidEndChar"/>
|
|
<exclude name="Drupal.Commenting.InlineComment.NotCapital"/>
|
|
<exclude name="Drupal.Commenting.InlineComment.SpacingAfter"/>
|
|
<exclude name="Drupal.Commenting.InlineComment.SpacingBefore"/>
|
|
</rule>
|
|
<rule ref="Drupal.Commenting.PostStatementComment"/>
|
|
<rule ref="Drupal.ControlStructures.ElseIf"/>
|
|
<rule ref="Drupal.ControlStructures.ControlSignature"/>
|
|
<rule ref="Drupal.ControlStructures.InlineControlStructure"/>
|
|
<rule ref="Drupal.Files.EndFileNewline"/>
|
|
<rule ref="Drupal.Files.FileEncoding"/>
|
|
<rule ref="Drupal.Files.TxtFileLineLength"/>
|
|
<rule ref="Drupal.Formatting.MultiLineAssignment"/>
|
|
<rule ref="Drupal.Formatting.MultipleStatementAlignment"/>
|
|
<rule ref="Drupal.Formatting.SpaceInlineIf"/>
|
|
<rule ref="Drupal.Formatting.SpaceUnaryOperator"/>
|
|
<rule ref="Drupal.Functions.DiscouragedFunctions"/>
|
|
<rule ref="Drupal.Functions.FunctionDeclaration"/>
|
|
<rule ref="Drupal.InfoFiles.AutoAddedKeys"/>
|
|
<rule ref="Drupal.InfoFiles.ClassFiles"/>
|
|
<rule ref="Drupal.InfoFiles.DuplicateEntry"/>
|
|
<rule ref="Drupal.InfoFiles.Required"/>
|
|
<rule ref="Drupal.Methods.MethodDeclaration">
|
|
<!-- Silence method name underscore warning which is covered already in
|
|
Drupal.NamingConventions.ValidFunctionName.ScopeNotCamelCaps. -->
|
|
<exclude name="Drupal.Methods.MethodDeclaration.Underscore"/>
|
|
</rule>
|
|
<rule ref="Drupal.NamingConventions.ValidVariableName">
|
|
<!-- Sniff for: LowerStart -->
|
|
<exclude name="Drupal.NamingConventions.ValidVariableName.LowerCamelName"/>
|
|
</rule>
|
|
<rule ref="Drupal.Scope.MethodScope"/>
|
|
<rule ref="Drupal.Semantics.EmptyInstall"/>
|
|
<rule ref="Drupal.Semantics.FunctionAlias"/>
|
|
<rule ref="Drupal.Semantics.FunctionT">
|
|
<exclude name="Drupal.Semantics.FunctionT.NotLiteralString"/>
|
|
<exclude name="Drupal.Semantics.FunctionT.ConcatString"/>
|
|
</rule>
|
|
<rule ref="Drupal.Semantics.FunctionWatchdog"/>
|
|
<rule ref="Drupal.Semantics.InstallHooks"/>
|
|
<rule ref="Drupal.Semantics.LStringTranslatable"/>
|
|
<rule ref="Drupal.Semantics.PregSecurity"/>
|
|
<rule ref="Drupal.Semantics.TInHookMenu"/>
|
|
<rule ref="Drupal.Semantics.TInHookSchema"/>
|
|
<rule ref="Drupal.Strings.UnnecessaryStringConcat"/>
|
|
<rule ref="Drupal.WhiteSpace.CloseBracketSpacing"/>
|
|
<rule ref="Drupal.WhiteSpace.Comma"/>
|
|
<rule ref="Drupal.WhiteSpace.EmptyLines"/>
|
|
<rule ref="Drupal.WhiteSpace.Namespace"/>
|
|
<rule ref="Drupal.WhiteSpace.ObjectOperatorIndent"/>
|
|
<rule ref="Drupal.WhiteSpace.ObjectOperatorSpacing"/>
|
|
<rule ref="Drupal.WhiteSpace.OpenBracketSpacing"/>
|
|
<rule ref="Drupal.WhiteSpace.OpenTagNewline"/>
|
|
<rule ref="Drupal.WhiteSpace.OperatorSpacing"/>
|
|
<rule ref="Drupal.WhiteSpace.ScopeClosingBrace"/>
|
|
<rule ref="Drupal.WhiteSpace.ScopeIndent"/>
|
|
|
|
<!-- Drupal Practice sniffs -->
|
|
<rule ref="DrupalPractice.Commenting.ExpectedException"/>
|
|
|
|
<!-- Generic sniffs -->
|
|
<rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
|
|
<rule ref="Generic.CodeAnalysis.EmptyPHPStatement" />
|
|
<rule ref="Generic.Files.ByteOrderMark"/>
|
|
<rule ref="Generic.Files.LineEndings"/>
|
|
<rule ref="Generic.Formatting.SpaceAfterCast"/>
|
|
<rule ref="Generic.Functions.FunctionCallArgumentSpacing"/>
|
|
<rule ref="Generic.Functions.OpeningFunctionBraceKernighanRitchie">
|
|
<properties>
|
|
<property name="checkClosures" value="true"/>
|
|
</properties>
|
|
</rule>
|
|
<rule ref="Generic.NamingConventions.ConstructorName"/>
|
|
<rule ref="Generic.NamingConventions.UpperCaseConstantName"/>
|
|
<rule ref="Generic.PHP.DeprecatedFunctions"/>
|
|
<rule ref="Generic.PHP.DisallowShortOpenTag"/>
|
|
<rule ref="Generic.PHP.LowerCaseKeyword"/>
|
|
<rule ref="Generic.PHP.UpperCaseConstant"/>
|
|
<rule ref="Generic.WhiteSpace.DisallowTabIndent"/>
|
|
|
|
<!-- Internal sniffs -->
|
|
<rule ref="Internal.NoCodeFound">
|
|
<!-- No PHP code in *.yml -->
|
|
<exclude-pattern>*.yml</exclude-pattern>
|
|
</rule>
|
|
|
|
<!-- MySource sniffs -->
|
|
<rule ref="MySource.Debug.DebugCode"/>
|
|
|
|
<!-- PEAR sniffs -->
|
|
<rule ref="PEAR.Files.IncludingFile"/>
|
|
<!-- Disable some error messages that we do not want. -->
|
|
<rule ref="PEAR.Files.IncludingFile.UseIncludeOnce">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="PEAR.Files.IncludingFile.UseInclude">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="PEAR.Files.IncludingFile.UseRequireOnce">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="PEAR.Files.IncludingFile.UseRequire">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="PEAR.Functions.ValidDefaultValue"/>
|
|
|
|
<!-- PEAR sniffs -->
|
|
<rule ref="PEAR.Functions.FunctionCallSignature"/>
|
|
<!-- The sniffs inside PEAR.Functions.FunctionCallSignature silenced below are
|
|
also silenced in Drupal CS' ruleset.xml. The code below is a 1-on-1 copy
|
|
from that file. -->
|
|
<!-- Disable some error messages that we already cover. -->
|
|
<rule ref="PEAR.Functions.FunctionCallSignature.SpaceAfterOpenBracket">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="PEAR.Functions.FunctionCallSignature.SpaceBeforeCloseBracket">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<!-- Disable some error messages that we do not want. -->
|
|
<rule ref="PEAR.Functions.FunctionCallSignature.Indent">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="PEAR.Functions.FunctionCallSignature.OpeningIndent">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="PEAR.Functions.FunctionCallSignature.ContentAfterOpenBracket">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="PEAR.Functions.FunctionCallSignature.CloseBracketLine">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="PEAR.Functions.FunctionCallSignature.EmptyLine">
|
|
<severity>0</severity>
|
|
</rule>
|
|
|
|
<!-- PSR-2 sniffs -->
|
|
<rule ref="PSR2.Classes.PropertyDeclaration">
|
|
<exclude name="PSR2.Classes.PropertyDeclaration.Underscore"/>
|
|
</rule>
|
|
<rule ref="PSR2.Namespaces.NamespaceDeclaration"/>
|
|
<rule ref="PSR2.Namespaces.UseDeclaration">
|
|
<exclude name="PSR2.Namespaces.UseDeclaration.UseAfterNamespace"/>
|
|
</rule>
|
|
|
|
<!-- Squiz sniffs -->
|
|
<rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration">
|
|
<exclude name="Squiz.Arrays.ArrayDeclaration.NoKeySpecified"/>
|
|
<exclude name="Squiz.Arrays.ArrayDeclaration.KeySpecified"/>
|
|
</rule>
|
|
<!-- Disable some error messages that we do not want. -->
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration.CloseBraceNotAligned">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration.DoubleArrowNotAligned">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration.FirstValueNoNewline">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration.KeyNotAligned">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration.MultiLineNotAllowed">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration.NoComma">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration.NoCommaAfterLast">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration.NotLowerCase">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration.ValueNotAligned">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration.ValueNoNewline">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.ControlStructures.ForEachLoopDeclaration"/>
|
|
<!-- Disable some error messages that we already cover. -->
|
|
<rule ref="Squiz.ControlStructures.ForEachLoopDeclaration.AsNotLower">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.ControlStructures.ForEachLoopDeclaration.SpaceAfterOpen">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.ControlStructures.ForEachLoopDeclaration.SpaceBeforeClose">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.ControlStructures.ForLoopDeclaration"/>
|
|
<!-- Disable some error messages that we already cover. -->
|
|
<rule ref="Squiz.ControlStructures.ForLoopDeclaration.SpacingAfterOpen">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.ControlStructures.ForLoopDeclaration.SpacingBeforeClose">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Functions.MultiLineFunctionDeclaration"/>
|
|
<rule ref="Squiz.Functions.MultiLineFunctionDeclaration.BraceOnSameLine">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Functions.MultiLineFunctionDeclaration.ContentAfterBrace">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<!-- Standard yet to be finalized on this (https://www.drupal.org/node/1539712). -->
|
|
<rule ref="Squiz.Functions.MultiLineFunctionDeclaration.FirstParamSpacing">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Functions.MultiLineFunctionDeclaration.Indent">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Functions.MultiLineFunctionDeclaration.CloseBracketLine">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing">
|
|
<properties>
|
|
<property name="equalsSpacing" value="1"/>
|
|
</properties>
|
|
</rule>
|
|
<rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing.NoSpaceBeforeArg">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.PHP.LowercasePHPFunctions"/>
|
|
<rule ref="Squiz.Strings.ConcatenationSpacing">
|
|
<properties>
|
|
<property name="spacing" value="1"/>
|
|
<property name="ignoreNewlines" value="true"/>
|
|
</properties>
|
|
</rule>
|
|
<rule ref="Squiz.WhiteSpace.FunctionSpacing">
|
|
<properties>
|
|
<property name="spacing" value="1"/>
|
|
</properties>
|
|
</rule>
|
|
<rule ref="Squiz.WhiteSpace.LanguageConstructSpacing" />
|
|
<rule ref="Squiz.WhiteSpace.SemicolonSpacing"/>
|
|
<rule ref="Squiz.WhiteSpace.SuperfluousWhitespace"/>
|
|
|
|
<!-- Zend sniffs -->
|
|
<rule ref="Zend.Files.ClosingTag"/>
|
|
|
|
</ruleset>
|