.phpcs.xml

   1 <?xml version="1.0"?>
   2 <ruleset name="MediaWiki">
   3         <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
   4                 <exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPrivate" />
   5                 <exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
   6                 <exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
   7                 <exclude name="MediaWiki.Commenting.FunctionComment.WrongStyle" />
   8                 <exclude name="MediaWiki.Commenting.PropertyDocumentation.MissingDocumentationPrivate" />
   9                 <exclude name="MediaWiki.Commenting.PropertyDocumentation.MissingDocumentationProtected" />
  10                 <exclude name="MediaWiki.Commenting.PropertyDocumentation.MissingDocumentationPublic" />
  11                 <exclude name="MediaWiki.Commenting.PropertyDocumentation.MissingVar" />
  12                 <exclude name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName" />
  13                 <exclude name="MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgTitle" />
  14                 <exclude name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />
  15         </rule>
  16         <rule ref="MediaWiki.NamingConventions.ValidGlobalName">
  17                 <properties>
  18                         <property name="ignoreList" type="array" value="$IP" />
  19                 </properties>
  20         </rule>
  21         <rule ref="MediaWiki.NamingConventions.ValidGlobalName.allowedPrefix">
  22                 <exclude-pattern>*/maintenance/doMaintenance\.php</exclude-pattern>
  23                 <exclude-pattern>*/maintenance/CommandLineInc\.php</exclude-pattern>
  24         </rule>
  25         <rule ref="Generic.Files.LineLength">
  26                 <exclude-pattern>*/languages/messages/*</exclude-pattern>
  27                 <exclude-pattern>*/tests/*</exclude-pattern>
  28         </rule>
  29         <rule ref="MediaWiki.Files.ClassMatchesFilename.NotMatch">
  30                 <!--
  31                         Continue to allow existing violations, but enable the sniff to prevent
  32                         any new occurrences.
  33                 -->
  34                 <exclude-pattern>*/maintenance/cleanupTitles\.php</exclude-pattern>
  35                 <exclude-pattern>*/maintenance/edit\.php</exclude-pattern>
  36                 <exclude-pattern>*/maintenance/findDeprecated\.php</exclude-pattern>
  37                 <exclude-pattern>*/maintenance/getText\.php</exclude-pattern>
  38                 <exclude-pattern>*/maintenance/importDump\.php</exclude-pattern>
  39                 <exclude-pattern>*/maintenance/install\.php</exclude-pattern>
  40                 <exclude-pattern>*/maintenance/jsparse\.php</exclude-pattern>
  41                 <exclude-pattern>*/maintenance/lag\.php</exclude-pattern>
  42                 <exclude-pattern>*/maintenance/language/StatOutputs\.php</exclude-pattern>
  43                 <exclude-pattern>*/maintenance/language/date-formats\.php</exclude-pattern>
  44                 <exclude-pattern>*/maintenance/mysql\.php</exclude-pattern>
  45                 <exclude-pattern>*/maintenance/parse\.php</exclude-pattern>
  46                 <exclude-pattern>*/maintenance/rebuildImages\.php</exclude-pattern>
  47                 <exclude-pattern>*/maintenance/renderDump\.php</exclude-pattern>
  48                 <exclude-pattern>*/maintenance/shell\.php</exclude-pattern>
  49                 <exclude-pattern>*/maintenance/sql\.php</exclude-pattern>
  50                 <exclude-pattern>*/maintenance/update\.php</exclude-pattern>
  51                 <exclude-pattern>*/maintenance/userOptions\.php</exclude-pattern>
  52                 <exclude-pattern>*/maintenance/view\.php</exclude-pattern>
  53                 <!-- Skip violations in some tests for now -->
  54                 <exclude-pattern>*/tests/parser/*</exclude-pattern>
  55                 <exclude-pattern>*/tests/phpunit/maintenance/*</exclude-pattern>
  56                 <exclude-pattern>*/tests/phpunit/bootstrap\.php</exclude-pattern>
  57                 <exclude-pattern>*/tests/phpunit/phpunit\.php</exclude-pattern>
  58         </rule>
  59         <rule ref="MediaWiki.Files.ClassMatchesFilename.WrongCase">
  60                 <!--
  61                         Continue to allow existing violations, but enable the sniff to prevent
  62                         any new occurrences.
  63                 -->
  64                 <exclude-pattern>*/maintenance/language/alltrans\.php</exclude-pattern>
  65                 <exclude-pattern>*/maintenance/language/digit2html\.php</exclude-pattern>
  66                 <exclude-pattern>*/maintenance/language/langmemusage\.php</exclude-pattern>
  67                 <exclude-pattern>*/maintenance/mctest\.php</exclude-pattern>
  68                 <exclude-pattern>*/maintenance/mwdocgen\.php</exclude-pattern>
  69                 <exclude-pattern>*/maintenance/rebuildall\.php</exclude-pattern>
  70                 <exclude-pattern>*/maintenance/rebuildmessages\.php</exclude-pattern>
  71                 <exclude-pattern>*/maintenance/rebuildrecentchanges\.php</exclude-pattern>
  72                 <exclude-pattern>*/maintenance/rebuildtextindex\.php</exclude-pattern>
  73                 <exclude-pattern>*/maintenance/storage/checkStorage\.php</exclude-pattern>
  74                 <exclude-pattern>*/maintenance/storage/recompressTracked\.php</exclude-pattern>
  75                 <exclude-pattern>*/maintenance/storage/trackBlobs\.php</exclude-pattern>
  76         </rule>
  77         <rule ref="Generic.PHP.NoSilencedErrors.Discouraged">
  78                 <exclude-pattern>*/tests/*</exclude-pattern>
  79         </rule>
  80         <rule ref="Generic.Files.OneObjectStructurePerFile.MultipleFound">
  81                 <!--
  82                         Continue to allow existing violations, but enable the sniff to prevent
  83                         any new occurrences.
  84                 -->
  85                 <exclude-pattern>*/maintenance/dumpIterator\.php</exclude-pattern>
  86                 <exclude-pattern>*/maintenance/findDeprecated\.php</exclude-pattern>
  87                 <exclude-pattern>*/maintenance/storage/recompressTracked\.php</exclude-pattern>
  88                 <exclude-pattern>*/maintenance/language/StatOutputs\.php</exclude-pattern>
  89                 <exclude-pattern>*/maintenance/language/generateCollationData\.php</exclude-pattern>
  90                 <!-- We don't care that much about violations in tests -->
  91                 <exclude-pattern>*/tests/*</exclude-pattern>
  92         </rule>
  93         <rule ref="MediaWiki.Usage.AssignmentInReturn.AssignmentInReturn">
  94                 <exclude-pattern>*/tests/phpunit/*</exclude-pattern>
  95         </rule>
  96         <rule ref="MediaWiki.Usage.ForbiddenFunctions.popen">
  97                 <!--
  98                         Continue to allow existing violations, but enable the sniff to prevent
  99                         any new occurrences.
 100                 -->
 101                 <exclude-pattern>*/includes/GlobalFunctions\.php</exclude-pattern>
 102                 <exclude-pattern>*/includes/libs/filebackend/FSFileBackend\.php</exclude-pattern>
 103                 <exclude-pattern>*/maintenance/includes/SevenZipStream\.php</exclude-pattern>
 104         </rule>
 105         <rule ref="MediaWiki.Usage.ForbiddenFunctions.proc_open">
 106                 <!--
 107                         Continue to allow existing violations, but enable the sniff to prevent
 108                         any new occurrences.
 109                 -->
 110                 <exclude-pattern>*/includes/export/DumpPipeOutput\.php</exclude-pattern>
 111                 <exclude-pattern>*/includes/ResourceLoader/Image\.php</exclude-pattern>
 112                 <exclude-pattern>*/includes/shell/Command\.php</exclude-pattern>
 113                 <exclude-pattern>*/maintenance/includes/TextPassDumper\.php</exclude-pattern>
 114                 <exclude-pattern>*/maintenance/mysql\.php</exclude-pattern>
 115                 <exclude-pattern>*/maintenance/storage/recompressTracked\.php</exclude-pattern>
 116                 <exclude-pattern>*/tests/parser/editTests\.php</exclude-pattern>
 117         </rule>
 118         <rule ref="MediaWiki.Usage.ForbiddenFunctions.shell_exec">
 119                 <!--
 120                         Continue to allow existing violations, but enable the sniff to prevent
 121                         any new occurrences.
 122                 -->
 123                 <exclude-pattern>*/maintenance/mwdocgen\.php</exclude-pattern>
 124                 <exclude-pattern>*/maintenance/updateCredits\.php</exclude-pattern>
 125         </rule>
 126         <rule ref="MediaWiki.Usage.ForbiddenFunctions.system">
 127                 <!--
 128                         Continue to allow existing violations, but enable the sniff to prevent
 129                         any new occurrences.
 130                 -->
 131                 <exclude-pattern>*/maintenance/mwdocgen\.php</exclude-pattern>
 132         </rule>
 133         <rule ref="Generic.Arrays.DisallowShortArraySyntax">
 134                 <!--
 135                         T273340: Rule not to be enabled on any other file.
 136                         PHPVersionCheck.php requires syntax to be old PHP compatible.
 137                         The rest should therefore use [] rather than array() as per the
 138                         MediaWiki style guide.
 139                 -->
 140                 <include-pattern>includes/PHPVersionCheck\.php</include-pattern>
 141         </rule>
 142         <file>.</file>
 143         <arg name="encoding" value="UTF-8"/>
 144         <arg name="extensions" value="php"/>
 145         <exclude-pattern type="relative">^(extensions|skins)/*</exclude-pattern>
 146         <exclude-pattern type="relative">^docs/(coverage|html|js|latex)/*</exclude-pattern>
 147         <exclude-pattern>LocalSettings(-installer)?\.php</exclude-pattern>
 148 </ruleset>