Mercurial > hg > isophonics-drupal-site

annotate vendor/drupal/coder/coder_sniffer/Drupal/ruleset.xml @ 7:848c88cfe644

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
More layout
author Chris Cannam
date Fri, 05 Jan 2018 13:59:44 +0000
parents 4c8ae668cc8c
children 129ea1e6d783
rev   line source
Chris@0 1 <?xml version="1.0"?>
Chris@0 2 <!-- See http://pear.php.net/manual/en/package.php.php-codesniffer.annotated-ruleset.php -->
Chris@0 3 <ruleset name="Drupal">
Chris@0 4 <description>Drupal coding standard</description>
Chris@0 5 <!-- All Drupal code files must be UTF-8 encoded and we treat them as such. -->
Chris@0 6 <arg name="encoding" value="utf-8"/>
Chris@0 7
Chris@0 8 <arg name="extensions" value="php,module,inc,install,test,profile,theme,css,info,txt,md,yml"/>
Chris@0 9
Chris@0 10 <rule ref="Internal.NoCodeFound">
Chris@0 11 <!-- Empty files are fine, might be used for testing. -->
Chris@0 12 <exclude-pattern>*</exclude-pattern>
Chris@0 13 </rule>
Chris@0 14
Chris@0 15 <rule ref="Drupal.Commenting.FileComment">
Chris@0 16 <!-- Do not run this sniff on txt files. -->
Chris@0 17 <exclude-pattern>*.txt</exclude-pattern>
Chris@0 18 </rule>
Chris@0 19 <rule ref="Drupal.Commenting.FileComment.SpacingAfterComment">
Chris@0 20 <!-- Do not run this sniff on template files. -->
Chris@0 21 <exclude-pattern>*.tpl.php</exclude-pattern>
Chris@0 22 </rule>
Chris@0 23 <rule ref="Drupal.ControlStructures.ControlSignature">
Chris@0 24 <!-- Do not run this sniff on template files. -->
Chris@0 25 <exclude-pattern>*.tpl.php</exclude-pattern>
Chris@0 26 </rule>
Chris@0 27
Chris@0 28 <!-- Silence deprecated sniff that will be removed in Coder 9.x. -->
Chris@0 29 <rule ref="Drupal.Functions.FunctionDeclaration.SpaceAfter">
Chris@0 30 <severity>0</severity>
Chris@0 31 </rule>
Chris@0 32 <rule ref="Drupal.Functions.FunctionDeclaration.SpaceBeforeParenthesis">
Chris@0 33 <severity>0</severity>
Chris@0 34 </rule>
Chris@0 35 <!-- Silence mmethod name underscore warning which is coverd already in
Chris@0 36 Drupal.NamingConventions.ValidFunctionName.ScopeNotCamelCaps. -->
Chris@0 37 <rule ref="Drupal.Methods.MethodDeclaration.Underscore">
Chris@0 38 <severity>0</severity>
Chris@0 39 </rule>
Chris@0 40
Chris@0 41 <rule ref="Drupal.WhiteSpace.ScopeIndent">
Chris@0 42 <!-- Do not run this sniff on template files, as the indentation might follow
Chris@0 43 the HTML -->
Chris@0 44 <exclude-pattern>*.tpl.php</exclude-pattern>
Chris@0 45 </rule>
Chris@0 46
Chris@0 47 <rule ref="Generic.CodeAnalysis.UselessOverridingMethod" />
Chris@0 48 <rule ref="Generic.Files.ByteOrderMark" />
Chris@0 49 <rule ref="Generic.Formatting.SpaceAfterCast" />
Chris@0 50
Chris@0 51 <rule ref="Generic.Functions.FunctionCallArgumentSpacing" />
Chris@0 52 <rule ref="Generic.Functions.FunctionCallArgumentSpacing.NoSpaceAfterComma">
Chris@0 53 <severity>0</severity>
Chris@0 54 </rule>
Chris@0 55 <rule ref="Generic.Functions.OpeningFunctionBraceKernighanRitchie">
Chris@0 56 <properties>
Chris@0 57 <property name="checkClosures" value="true"/>
Chris@0 58 </properties>
Chris@0 59 </rule>
Chris@0 60
Chris@0 61 <rule ref="Generic.NamingConventions.ConstructorName" />
Chris@0 62 <rule ref="Generic.NamingConventions.UpperCaseConstantName" />
Chris@0 63 <rule ref="Generic.PHP.DeprecatedFunctions" />
Chris@0 64 <rule ref="Generic.PHP.DisallowShortOpenTag" />
Chris@0 65 <rule ref="Generic.PHP.LowerCaseKeyword" />
Chris@0 66 <rule ref="Generic.PHP.UpperCaseConstant" />
Chris@0 67 <rule ref="Generic.WhiteSpace.DisallowTabIndent" />
Chris@0 68
Chris@0 69 <!-- Use Unix newlines -->
Chris@0 70 <rule ref="Generic.Files.LineEndings">
Chris@0 71 <properties>
Chris@0 72 <property name="eolChar" value="\n"/>
Chris@0 73 </properties>
Chris@0 74 </rule>
Chris@0 75
Chris@0 76 <rule ref="MySource.Debug.DebugCode" />
Chris@0 77 <rule ref="PEAR.Files.IncludingFile" />
Chris@0 78 <!-- Disable some error messages that we do not want. -->
Chris@0 79 <rule ref="PEAR.Files.IncludingFile.UseIncludeOnce">
Chris@0 80 <severity>0</severity>
Chris@0 81 </rule>
Chris@0 82 <rule ref="PEAR.Files.IncludingFile.UseInclude">
Chris@0 83 <severity>0</severity>
Chris@0 84 </rule>
Chris@0 85 <rule ref="PEAR.Files.IncludingFile.UseRequireOnce">
Chris@0 86 <severity>0</severity>
Chris@0 87 </rule>
Chris@0 88 <rule ref="PEAR.Files.IncludingFile.UseRequire">
Chris@0 89 <severity>0</severity>
Chris@0 90 </rule>
Chris@0 91
Chris@0 92 <rule ref="PEAR.Functions.FunctionCallSignature"/>
Chris@0 93 <!-- Disable some error messages that we already cover. -->
Chris@0 94 <rule ref="PEAR.Functions.FunctionCallSignature.SpaceAfterOpenBracket">
Chris@0 95 <severity>0</severity>
Chris@0 96 </rule>
Chris@0 97 <rule ref="PEAR.Functions.FunctionCallSignature.SpaceBeforeCloseBracket">
Chris@0 98 <severity>0</severity>
Chris@0 99 </rule>
Chris@0 100 <!-- Disable some error messages that we do not want. -->
Chris@0 101 <rule ref="PEAR.Functions.FunctionCallSignature.Indent">
Chris@0 102 <severity>0</severity>
Chris@0 103 </rule>
Chris@0 104 <rule ref="PEAR.Functions.FunctionCallSignature.ContentAfterOpenBracket">
Chris@0 105 <severity>0</severity>
Chris@0 106 </rule>
Chris@0 107 <rule ref="PEAR.Functions.FunctionCallSignature.CloseBracketLine">
Chris@0 108 <severity>0</severity>
Chris@0 109 </rule>
Chris@0 110 <rule ref="PEAR.Functions.FunctionCallSignature.EmptyLine">
Chris@0 111 <severity>0</severity>
Chris@0 112 </rule>
Chris@0 113
Chris@0 114 <rule ref="PEAR.Functions.ValidDefaultValue" />
Chris@0 115
Chris@0 116 <rule ref="PSR2.Namespaces.NamespaceDeclaration" />
Chris@0 117 <rule ref="PSR2.Namespaces.UseDeclaration" />
Chris@0 118
Chris@0 119 <rule ref="Squiz.Arrays.ArrayDeclaration" />
Chris@0 120 <!-- Disable some error messages that we do not want. -->
Chris@0 121 <rule ref="Squiz.Arrays.ArrayDeclaration.CloseBraceNotAligned">
Chris@0 122 <severity>0</severity>
Chris@0 123 </rule>
Chris@0 124 <rule ref="Squiz.Arrays.ArrayDeclaration.DoubleArrowNotAligned">
Chris@0 125 <severity>0</severity>
Chris@0 126 </rule>
Chris@0 127 <rule ref="Squiz.Arrays.ArrayDeclaration.FirstValueNoNewline">
Chris@0 128 <severity>0</severity>
Chris@0 129 </rule>
Chris@0 130 <rule ref="Squiz.Arrays.ArrayDeclaration.KeyNotAligned">
Chris@0 131 <severity>0</severity>
Chris@0 132 </rule>
Chris@0 133 <rule ref="Squiz.Arrays.ArrayDeclaration.MultiLineNotAllowed">
Chris@0 134 <severity>0</severity>
Chris@0 135 </rule>
Chris@0 136 <rule ref="Squiz.Arrays.ArrayDeclaration.NoComma">
Chris@0 137 <severity>0</severity>
Chris@0 138 </rule>
Chris@0 139 <rule ref="Squiz.Arrays.ArrayDeclaration.NoCommaAfterLast">
Chris@0 140 <severity>0</severity>
Chris@0 141 </rule>
Chris@0 142 <rule ref="Squiz.Arrays.ArrayDeclaration.NotLowerCase">
Chris@0 143 <severity>0</severity>
Chris@0 144 </rule>
Chris@0 145 <rule ref="Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed">
Chris@0 146 <severity>0</severity>
Chris@0 147 </rule>
Chris@0 148 <rule ref="Squiz.Arrays.ArrayDeclaration.ValueNotAligned">
Chris@0 149 <severity>0</severity>
Chris@0 150 </rule>
Chris@0 151 <rule ref="Squiz.Arrays.ArrayDeclaration.ValueNoNewline">
Chris@0 152 <severity>0</severity>
Chris@0 153 </rule>
Chris@0 154
Chris@0 155 <rule ref="Squiz.Arrays.ArrayBracketSpacing" />
Chris@0 156
Chris@0 157 <rule ref="Squiz.ControlStructures.ForEachLoopDeclaration" />
Chris@0 158 <!-- Disable some error messages that we already cover. -->
Chris@0 159 <rule ref="Squiz.ControlStructures.ForEachLoopDeclaration.AsNotLower">
Chris@0 160 <severity>0</severity>
Chris@0 161 </rule>
Chris@0 162 <rule ref="Squiz.ControlStructures.ForEachLoopDeclaration.SpaceAfterOpen">
Chris@0 163 <severity>0</severity>
Chris@0 164 </rule>
Chris@0 165 <rule ref="Squiz.ControlStructures.ForEachLoopDeclaration.SpaceBeforeClose">
Chris@0 166 <severity>0</severity>
Chris@0 167 </rule>
Chris@0 168 <rule ref="Squiz.ControlStructures.ForLoopDeclaration" />
Chris@0 169 <!-- Disable some error messages that we already cover. -->
Chris@0 170 <rule ref="Squiz.ControlStructures.ForLoopDeclaration.SpacingAfterOpen">
Chris@0 171 <severity>0</severity>
Chris@0 172 </rule>
Chris@0 173 <rule ref="Squiz.ControlStructures.ForLoopDeclaration.SpacingBeforeClose">
Chris@0 174 <severity>0</severity>
Chris@0 175 </rule>
Chris@0 176
Chris@0 177 <rule ref="Squiz.ControlStructures.SwitchDeclaration" />
Chris@0 178 <!-- Disable some error messages that we do not want. -->
Chris@0 179 <rule ref="Squiz.ControlStructures.SwitchDeclaration.BreakIndent">
Chris@0 180 <severity>0</severity>
Chris@0 181 </rule>
Chris@0 182 <rule ref="Squiz.ControlStructures.SwitchDeclaration.CaseIndent">
Chris@0 183 <severity>0</severity>
Chris@0 184 </rule>
Chris@0 185 <rule ref="Squiz.ControlStructures.SwitchDeclaration.CloseBraceAlign">
Chris@0 186 <severity>0</severity>
Chris@0 187 </rule>
Chris@0 188 <rule ref="Squiz.ControlStructures.SwitchDeclaration.DefaultIndent">
Chris@0 189 <severity>0</severity>
Chris@0 190 </rule>
Chris@0 191 <rule ref="Squiz.ControlStructures.SwitchDeclaration.DefaultNoBreak">
Chris@0 192 <severity>0</severity>
Chris@0 193 </rule>
Chris@0 194 <rule ref="Squiz.ControlStructures.SwitchDeclaration.EmptyCase">
Chris@0 195 <severity>0</severity>
Chris@0 196 </rule>
Chris@0 197 <rule ref="Squiz.ControlStructures.SwitchDeclaration.EmptyDefault">
Chris@0 198 <severity>0</severity>
Chris@0 199 </rule>
Chris@0 200 <rule ref="Squiz.ControlStructures.SwitchDeclaration.MissingDefault">
Chris@0 201 <severity>0</severity>
Chris@0 202 </rule>
Chris@0 203 <rule ref="Squiz.ControlStructures.SwitchDeclaration.SpacingAfterCase">
Chris@0 204 <severity>0</severity>
Chris@0 205 </rule>
Chris@0 206 <rule ref="Squiz.ControlStructures.SwitchDeclaration.SpacingAfterDefaultBreak">
Chris@0 207 <severity>0</severity>
Chris@0 208 </rule>
Chris@0 209 <rule ref="Squiz.ControlStructures.SwitchDeclaration.SpacingBeforeBreak">
Chris@0 210 <severity>0</severity>
Chris@0 211 </rule>
Chris@0 212
Chris@0 213 <rule ref="Squiz.CSS.ClassDefinitionClosingBraceSpace" />
Chris@0 214 <rule ref="Squiz.CSS.ClassDefinitionClosingBraceSpace.SpacingAfterClose">
Chris@0 215 <severity>0</severity>
Chris@0 216 </rule>
Chris@0 217 <rule ref="Squiz.CSS.ClassDefinitionOpeningBraceSpace" />
Chris@0 218 <rule ref="Squiz.CSS.ClassDefinitionOpeningBraceSpace.AfterNesting">
Chris@0 219 <severity>0</severity>
Chris@0 220 </rule>
Chris@0 221 <rule ref="Squiz.CSS.ColonSpacing" />
Chris@0 222 <rule ref="Squiz.CSS.DisallowMultipleStyleDefinitions" />
Chris@0 223 <rule ref="Squiz.CSS.EmptyClassDefinition" />
Chris@0 224 <rule ref="Squiz.CSS.EmptyStyleDefinition" />
Chris@0 225 <rule ref="Squiz.CSS.Indentation">
Chris@0 226 <properties>
Chris@0 227 <property name="indent" value="2"/>
Chris@0 228 </properties>
Chris@0 229 </rule>
Chris@0 230 <rule ref="Squiz.CSS.MissingColon" />
Chris@0 231 <rule ref="Squiz.CSS.SemicolonSpacing" />
Chris@0 232
Chris@0 233 <rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing">
Chris@0 234 <properties>
Chris@0 235 <property name="equalsSpacing" value="1"/>
Chris@0 236 </properties>
Chris@0 237 </rule>
Chris@0 238 <rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing.NoSpaceBeforeArg">
Chris@0 239 <severity>0</severity>
Chris@0 240 </rule>
Chris@0 241
Chris@0 242 <rule ref="Squiz.Functions.MultiLineFunctionDeclaration" />
Chris@0 243 <rule ref="Squiz.Functions.MultiLineFunctionDeclaration.BraceOnSameLine">
Chris@0 244 <severity>0</severity>
Chris@0 245 </rule>
Chris@0 246 <rule ref="Squiz.Functions.MultiLineFunctionDeclaration.ContentAfterBrace">
Chris@0 247 <severity>0</severity>
Chris@0 248 </rule>
Chris@0 249 <!-- Standard yet to be finalized on this (https://www.drupal.org/node/1539712). -->
Chris@0 250 <rule ref="Squiz.Functions.MultiLineFunctionDeclaration.FirstParamSpacing">
Chris@0 251 <severity>0</severity>
Chris@0 252 </rule>
Chris@0 253 <rule ref="Squiz.Functions.MultiLineFunctionDeclaration.Indent">
Chris@0 254 <severity>0</severity>
Chris@0 255 </rule>
Chris@0 256 <rule ref="Squiz.Functions.MultiLineFunctionDeclaration.CloseBracketLine">
Chris@0 257 <severity>0</severity>
Chris@0 258 </rule>
Chris@0 259
Chris@0 260 <rule ref="Squiz.PHP.LowercasePHPFunctions" />
Chris@0 261 <rule ref="Squiz.PHP.NonExecutableCode" />
Chris@0 262 <rule ref="Squiz.Strings.ConcatenationSpacing">
Chris@0 263 <properties>
Chris@0 264 <property name="spacing" value="1"/>
Chris@0 265 <property name="ignoreNewlines" value="true"/>
Chris@0 266 </properties>
Chris@0 267 </rule>
Chris@0 268 <rule ref="Squiz.WhiteSpace.FunctionSpacing">
Chris@0 269 <properties>
Chris@0 270 <property name="spacing" value="1"/>
Chris@0 271 </properties>
Chris@0 272 </rule>
Chris@0 273 <rule ref="Squiz.WhiteSpace.LanguageConstructSpacing" />
Chris@0 274 <rule ref="Squiz.WhiteSpace.SemicolonSpacing" />
Chris@0 275 <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace" />
Chris@0 276
Chris@0 277 <rule ref="Zend.Files.ClosingTag">
Chris@0 278 <!-- Do not run this sniff on template files. -->
Chris@0 279 <exclude-pattern>*.tpl.php</exclude-pattern>
Chris@0 280 </rule>
Chris@0 281
Chris@0 282 <!-- Ignore various version control directories. -->
Chris@0 283 <exclude-pattern>*/\.git/*</exclude-pattern>
Chris@0 284 <exclude-pattern>*/\.svn/*</exclude-pattern>
Chris@0 285 <exclude-pattern>*/\.hg/*</exclude-pattern>
Chris@0 286 <exclude-pattern>*/\.bzr/*</exclude-pattern>
Chris@0 287 </ruleset>