.phpcs.xml

   1 <?xml version="1.0"?>
   2 <ruleset name="MediaWiki">
   3         <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
   4                 <exclude name="Generic.ControlStructures.InlineControlStructure" />
   5                 <exclude name="MediaWiki.Commenting.FunctionComment.ExtraParamComment" />
   6                 <exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
   7                 <exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
   8                 <exclude name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
   9                 <exclude name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
  10                 <exclude name="MediaWiki.Commenting.FunctionComment.MissingSplatVariadicArg" />
  11                 <exclude name="MediaWiki.Commenting.FunctionComment.SuperfluousVariadicArgComment" />
  12                 <exclude name="MediaWiki.Commenting.FunctionComment.WrongStyle" />
  13                 <exclude name="MediaWiki.Commenting.IllegalSingleLineComment.IllegalSingleLineCommentEnd" />
  14                 <exclude name="MediaWiki.Commenting.IllegalSingleLineComment.IllegalSingleLineCommentStart" />
  15                 <exclude name="MediaWiki.Commenting.PhpunitAnnotations.ForbiddenExpectedException" />
  16                 <exclude name="MediaWiki.Commenting.PhpunitAnnotations.ForbiddenExpectedExceptionMessage" />
  17                 <exclude name="MediaWiki.Commenting.PhpunitAnnotations.ForbiddenExpectedExceptionMessageRegExp" />
  18                 <exclude name="MediaWiki.ControlStructures.AssignmentInControlStructures.AssignmentInControlStructures" />
  19                 <exclude name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName" />
  20                 <exclude name="MediaWiki.PHP71Features.NullableType.NotAllowed" />
  21                 <exclude name="MediaWiki.Usage.DbrQueryUsage.DbrQueryFound" />
  22                 <exclude name="MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgContLang" />
  23                 <exclude name="MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgTitle" />
  24                 <exclude name="MediaWiki.Usage.ForbiddenFunctions.passthru" />
  25                 <exclude name="MediaWiki.Usage.NullableType.PHP71NullableStyle" />
  26                 <exclude name="MediaWiki.Usage.PHPUnitTypeHints.MissingTypehint" />
  27                 <exclude name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />
  28                 <exclude name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.SingleSpaceBeforeSingleLineComment" />
  29                 <exclude name="PSR12.Files.ImportStatement.LeadingSlash" />
  30                 <exclude name="PSR12.Properties.ConstantVisibility.NotFound" />
  31                 <exclude name="Squiz.Scope.MethodScope.Missing" />
  32         </rule>
  33         <rule ref="MediaWiki.NamingConventions.PrefixedGlobalFunctions">
  34                 <properties>
  35                         <!--
  36                         includes/GlobalFunctions.php
  37                         * mimeTypeMatch
  38                         maintenance/cdb.php
  39                         * cdbShowHelp
  40                         maintenance/language/transstat.php
  41                         * showUsage
  42                         maintenance/mcc.php
  43                         * mccGetHelp
  44                         * mccShowUsage
  45                         maintenance/storage/moveToExternal.php
  46                         * moveToExternal
  47                         maintenance/storage/resolveStubs.php
  48                         * resolveStub
  49                         * resolveStubs
  50                         profileinfo.php
  51                         * compare_point
  52                         * getEscapedProfileUrl
  53                         tests/phpunit/includes/HooksTest.php
  54                         * NothingFunction
  55                         * NothingFunctionData
  56                         tests/qunit/data/styleTest.css.php
  57                         * cssfilter
  58                         -->
  59                         <property name="ignoreList" type="array" value="cdbShowHelp,compare_point,cssfilter,getEscapedProfileUrl,mccGetHelp,mccShowUsage,mimeTypeMatch,moveToExternal,NothingFunction,NothingFunctionData,resolveStub,resolveStubs,showUsage" />
  60                 </properties>
  61         </rule>
  62         <rule ref="MediaWiki.NamingConventions.ValidGlobalName">
  63                 <properties>
  64                         <property name="ignoreList" type="array" value="$IP,$messageMemc" />
  65                 </properties>
  66         </rule>
  67         <rule ref="MediaWiki.NamingConventions.ValidGlobalName.allowedPrefix">
  68                 <exclude-pattern>profileinfo\.php</exclude-pattern>
  69                 <exclude-pattern>maintenance/language/checkLanguage\.inc</exclude-pattern>
  70                 <exclude-pattern>maintenance/doMaintenance\.php</exclude-pattern>
  71                 <exclude-pattern>maintenance/mergeMessageFileList\.php</exclude-pattern>
  72                 <exclude-pattern>maintenance/commandLine\.inc</exclude-pattern>
  73                 <exclude-pattern>tests/phpunit/MediaWikiIntegrationTestCase\.php</exclude-pattern>
  74         </rule>
  75         <rule ref="Generic.Files.LineLength">
  76                 <exclude-pattern>*/languages/messages/Messages*\.php</exclude-pattern>
  77         </rule>
  78         <rule ref="MediaWiki.Files.ClassMatchesFilename.NotMatch">
  79                 <!--
  80                         Whitelist existing violations, but enable the sniff to prevent
  81                         any new occurrences.
  82                 -->
  83                 <exclude-pattern>*/includes/specials/SpecialMostimages\.php</exclude-pattern>
  84                 <exclude-pattern>*/includes/specials/SpecialMovepage\.php</exclude-pattern>
  85                 <exclude-pattern>*/includes/specials/SpecialRandompage\.php</exclude-pattern>
  86                 <exclude-pattern>*/includes/specials/SpecialUserrights\.php</exclude-pattern>
  87                 <exclude-pattern>*/includes/specials/SpecialWantedfiles\.php</exclude-pattern>
  88                 <exclude-pattern>*/includes/specials/SpecialWantedpages\.php</exclude-pattern>
  89                 <exclude-pattern>*/maintenance/CodeCleanerGlobalsPass.inc</exclude-pattern>
  90                 <exclude-pattern>*/maintenance/archives/upgradeLogging\.php</exclude-pattern>
  91                 <exclude-pattern>*/maintenance/benchmarks/bench_HTTP_HTTPS\.php</exclude-pattern>
  92                 <exclude-pattern>*/maintenance/benchmarks/bench_Wikimedia_base_convert\.php</exclude-pattern>
  93                 <exclude-pattern>*/maintenance/benchmarks/bench_delete_truncate\.php</exclude-pattern>
  94                 <exclude-pattern>*/maintenance/benchmarks/bench_if_switch\.php</exclude-pattern>
  95                 <exclude-pattern>*/maintenance/benchmarks/bench_utf8_title_check\.php</exclude-pattern>
  96                 <exclude-pattern>*/maintenance/benchmarks/bench_wfIsWindows\.php</exclude-pattern>
  97                 <exclude-pattern>*/maintenance/cleanupTable.inc</exclude-pattern>
  98                 <exclude-pattern>*/maintenance/cleanupTitles\.php</exclude-pattern>
  99                 <exclude-pattern>*/maintenance/commandLine.inc</exclude-pattern>
 100                 <exclude-pattern>*/maintenance/edit\.php</exclude-pattern>
 101                 <exclude-pattern>*/maintenance/findDeprecated\.php</exclude-pattern>
 102                 <exclude-pattern>*/maintenance/getText\.php</exclude-pattern>
 103                 <exclude-pattern>*/maintenance/hhvm/makeRepo\.php</exclude-pattern>
 104                 <exclude-pattern>*/maintenance/importDump\.php</exclude-pattern>
 105                 <exclude-pattern>*/maintenance/install\.php</exclude-pattern>
 106                 <exclude-pattern>*/maintenance/invalidateUserSessions\.php</exclude-pattern>
 107                 <exclude-pattern>*/maintenance/jsparse\.php</exclude-pattern>
 108                 <exclude-pattern>*/maintenance/lag\.php</exclude-pattern>
 109                 <exclude-pattern>*/maintenance/language/StatOutputs\.php</exclude-pattern>
 110                 <exclude-pattern>*/maintenance/language/checkLanguage.inc</exclude-pattern>
 111                 <exclude-pattern>*/maintenance/language/date-formats\.php</exclude-pattern>
 112                 <exclude-pattern>*/maintenance/language/languages.inc</exclude-pattern>
 113                 <exclude-pattern>*/maintenance/minify\.php</exclude-pattern>
 114                 <exclude-pattern>*/maintenance/mysql\.php</exclude-pattern>
 115                 <exclude-pattern>*/maintenance/parse\.php</exclude-pattern>
 116                 <exclude-pattern>*/maintenance/preprocessorFuzzTest\.php</exclude-pattern>
 117                 <exclude-pattern>*/maintenance/rebuildImages\.php</exclude-pattern>
 118                 <exclude-pattern>*/maintenance/renderDump\.php</exclude-pattern>
 119                 <exclude-pattern>*/maintenance/shell\.php</exclude-pattern>
 120                 <exclude-pattern>*/maintenance/sql\.php</exclude-pattern>
 121                 <exclude-pattern>*/maintenance/sqlite.inc</exclude-pattern>
 122                 <exclude-pattern>*/maintenance/sqlite\.php</exclude-pattern>
 123                 <exclude-pattern>*/maintenance/term/MWTerm\.php</exclude-pattern>
 124                 <exclude-pattern>*/maintenance/update\.php</exclude-pattern>
 125                 <exclude-pattern>*/maintenance/userDupes.inc</exclude-pattern>
 126                 <exclude-pattern>*/maintenance/userOptions\.php</exclude-pattern>
 127                 <exclude-pattern>*/maintenance/view\.php</exclude-pattern>
 128                 <exclude-pattern>*/profileinfo\.php</exclude-pattern>
 129                 <!-- Language converters use the pattern of 2 classes in one file -->
 130                 <exclude-pattern>*/languages/*\.php</exclude-pattern>
 131                 <!-- Skip violations in some tests for now -->
 132                 <exclude-pattern>*/tests/parser/*\.php</exclude-pattern>
 133                 <exclude-pattern>*/tests/phan/*\.php</exclude-pattern>
 134                 <exclude-pattern>*/tests/phpunit/maintenance/*\.php</exclude-pattern>
 135                 <exclude-pattern>*/tests/phpunit/bootstrap\.php</exclude-pattern>
 136                 <exclude-pattern>*/tests/phpunit/phpunit\.php</exclude-pattern>
 137         </rule>
 138         <rule ref="MediaWiki.Files.ClassMatchesFilename.WrongCase">
 139                 <!--
 140                         Whitelist existing violations, but enable the sniff to prevent
 141                         any new occurrences.
 142                 -->
 143                 <exclude-pattern>*/maintenance/language/alltrans\.php</exclude-pattern>
 144                 <exclude-pattern>*/maintenance/language/digit2html\.php</exclude-pattern>
 145                 <exclude-pattern>*/maintenance/language/langmemusage\.php</exclude-pattern>
 146                 <exclude-pattern>*/maintenance/mctest\.php</exclude-pattern>
 147                 <exclude-pattern>*/maintenance/mergeMessageFileList\.php</exclude-pattern>
 148                 <exclude-pattern>*/maintenance/mwdocgen\.php</exclude-pattern>
 149                 <exclude-pattern>*/maintenance/rebuildall\.php</exclude-pattern>
 150                 <exclude-pattern>*/maintenance/rebuildmessages\.php</exclude-pattern>
 151                 <exclude-pattern>*/maintenance/rebuildrecentchanges\.php</exclude-pattern>
 152                 <exclude-pattern>*/maintenance/rebuildtextindex\.php</exclude-pattern>
 153                 <exclude-pattern>*/maintenance/storage/checkStorage\.php</exclude-pattern>
 154                 <exclude-pattern>*/maintenance/storage/recompressTracked\.php</exclude-pattern>
 155                 <exclude-pattern>*/maintenance/storage/trackBlobs\.php</exclude-pattern>
 156                 <!-- Skip violations in some tests for now -->
 157                 <exclude-pattern>*/tests/phpunit/unit/includes/GlobalFunctions/*\.php</exclude-pattern>
 158                 <exclude-pattern>*/tests/phpunit/includes/GlobalFunctions/*\.php</exclude-pattern>
 159                 <exclude-pattern>*/tests/phpunit/maintenance/*\.php</exclude-pattern>
 160                 <exclude-pattern>*/tests/phpunit/integration/includes/GlobalFunctions/*\.php</exclude-pattern>
 161         </rule>
 162
 163         <rule ref="Generic.Files.OneObjectStructurePerFile.MultipleFound">
 164                 <!--
 165                         Whitelist existing violations, but enable the sniff to prevent
 166                         any new occurrences.
 167                 -->
 168                 <exclude-pattern>*/maintenance/dumpIterator\.php</exclude-pattern>
 169                 <exclude-pattern>*/maintenance/Maintenance\.php</exclude-pattern>
 170                 <exclude-pattern>*/maintenance/findDeprecated\.php</exclude-pattern>
 171                 <exclude-pattern>*/maintenance/storage/recompressTracked\.php</exclude-pattern>
 172                 <exclude-pattern>*/maintenance/preprocessorFuzzTest\.php</exclude-pattern>
 173                 <exclude-pattern>*/maintenance/language/languages.inc</exclude-pattern>
 174                 <exclude-pattern>*/maintenance/language/StatOutputs\.php</exclude-pattern>
 175                 <exclude-pattern>*/maintenance/language/checkLanguage.inc</exclude-pattern>
 176                 <exclude-pattern>*/maintenance/language/generateCollationData\.php</exclude-pattern>
 177                 <exclude-pattern>*/maintenance/term/MWTerm\.php</exclude-pattern>
 178                 <!-- Language converters use the pattern of 2 classes in one file -->
 179                 <exclude-pattern>*/languages/*\.php</exclude-pattern>
 180                 <!-- We don't care that much about violations in tests -->
 181                 <exclude-pattern>*/tests/*\.php</exclude-pattern>
 182         </rule>
 183         <rule ref="PSR2.Methods.MethodDeclaration.Underscore">
 184                 <exclude-pattern>*/includes/StubObject\.php</exclude-pattern>
 185                 <exclude-pattern>*/includes/StubUserLang\.php</exclude-pattern>
 186         </rule>
 187         <rule ref="MediaWiki.Usage.AssignmentInReturn.AssignmentInReturn">
 188                 <exclude-pattern>*/tests/phpunit/*\.php</exclude-pattern>
 189         </rule>
 190         <rule ref="MediaWiki.Usage.ForbiddenFunctions.escapeshellarg">
 191                 <!--
 192                         Whitelist existing violations, but enable the sniff to prevent
 193                         any new occurrences.
 194                 -->
 195                 <exclude-pattern>*/includes/libs/filebackend/FSFileBackend\.php</exclude-pattern>
 196                 <exclude-pattern>*/includes/shell/Command\.php</exclude-pattern>
 197                 <exclude-pattern>*/includes/shell/Shell\.php</exclude-pattern>
 198         </rule>
 199         <rule ref="MediaWiki.Usage.ForbiddenFunctions.popen">
 200                 <!--
 201                         Whitelist existing violations, but enable the sniff to prevent
 202                         any new occurrences.
 203                 -->
 204                 <exclude-pattern>*/includes/GlobalFunctions\.php</exclude-pattern>
 205                 <exclude-pattern>*/includes/libs/filebackend/FSFileBackend\.php</exclude-pattern>
 206                 <exclude-pattern>*/maintenance/includes/SevenZipStream\.php</exclude-pattern>
 207                 <exclude-pattern>*/maintenance/populateImageSha1\.php</exclude-pattern>
 208         </rule>
 209         <rule ref="MediaWiki.Usage.ForbiddenFunctions.proc_open">
 210                 <!--
 211                         Whitelist existing violations, but enable the sniff to prevent
 212                         any new occurrences.
 213                 -->
 214                 <exclude-pattern>includes/export/DumpPipeOutput\.php</exclude-pattern>
 215                 <exclude-pattern>includes/resourceloader/ResourceLoaderImage\.php</exclude-pattern>
 216                 <exclude-pattern>includes/shell/Command\.php</exclude-pattern>
 217                 <exclude-pattern>maintenance/includes/TextPassDumper\.php</exclude-pattern>
 218                 <exclude-pattern>maintenance/mysql\.php</exclude-pattern>
 219                 <exclude-pattern>maintenance/storage/recompressTracked\.php</exclude-pattern>
 220                 <exclude-pattern>tests/parser/editTests\.php</exclude-pattern>
 221         </rule>
 222         <rule ref="MediaWiki.Usage.ForbiddenFunctions.shell_exec">
 223                 <!--
 224                         Whitelist existing violations, but enable the sniff to prevent
 225                         any new occurrences.
 226                 -->
 227                 <exclude-pattern>*/maintenance/mwdocgen\.php</exclude-pattern>
 228                 <exclude-pattern>*/maintenance/updateCredits\.php</exclude-pattern>
 229         </rule>
 230         <rule ref="MediaWiki.Usage.ForbiddenFunctions.system">
 231                 <!--
 232                         Whitelist existing violations, but enable the sniff to prevent
 233                         any new occurrences.
 234                 -->
 235                 <exclude-pattern>*/maintenance/mwdocgen\.php</exclude-pattern>
 236         </rule>
 237         <rule ref="MediaWiki.Commenting.MissingCovers.MissingCovers">
 238                 <exclude-pattern>tests/phpunit/structure/*</exclude-pattern>
 239         </rule>
 240         <file>.</file>
 241         <arg name="encoding" value="UTF-8"/>
 242         <arg name="extensions" value="php,php5,inc,sample"/>
 243         <exclude-pattern type="relative">^extensions/</exclude-pattern>
 244         <exclude-pattern type="relative">^skins/</exclude-pattern>
 245         <exclude-pattern>AdminSettings\.php</exclude-pattern>
 246         <exclude-pattern>LocalSettings\.php</exclude-pattern>
 247 </ruleset>