2 <ruleset name=
"MediaWiki">
3 <rule ref=
"./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
4 <exclude name=
"Generic.ControlStructures.InlineControlStructure" />
5 <exclude name=
"MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
6 <exclude name=
"MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
7 <exclude name=
"MediaWiki.Commenting.FunctionComment.MissingParamTag" />
8 <exclude name=
"MediaWiki.Commenting.FunctionComment.MissingReturn" />
9 <exclude name=
"MediaWiki.Commenting.FunctionComment.ExtraParamComment" />
10 <exclude name=
"MediaWiki.Commenting.FunctionComment.WrongStyle" />
11 <exclude name=
"MediaWiki.Commenting.IllegalSingleLineComment.IllegalSingleLineCommentStart" />
12 <exclude name=
"MediaWiki.Commenting.IllegalSingleLineComment.IllegalSingleLineCommentEnd" />
13 <exclude name=
"MediaWiki.ControlStructures.AssignmentInControlStructures.AssignmentInControlStructures" />
14 <exclude name=
"MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName" />
15 <exclude name=
"MediaWiki.Usage.DbrQueryUsage.DbrQueryFound" />
16 <exclude name=
"MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgContLang" />
17 <exclude name=
"MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgTitle" />
18 <exclude name=
"MediaWiki.Usage.ForbiddenFunctions.passthru" />
19 <exclude name=
"MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />
20 <exclude name=
"MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.SingleSpaceBeforeSingleLineComment" />
21 <exclude name=
"Squiz.Scope.MethodScope.Missing" />
23 <rule ref=
"MediaWiki.NamingConventions.PrefixedGlobalFunctions">
26 includes/GlobalFunctions.php
30 maintenance/language/transstat.php
35 maintenance/storage/moveToExternal.php
37 maintenance/storage/resolveStubs.php
42 * getEscapedProfileUrl
43 tests/phpunit/includes/HooksTest.php
46 tests/qunit/data/styleTest.css.php
49 <property name=
"ignoreList" type=
"array" value=
"cdbShowHelp,compare_point,cssfilter,getEscapedProfileUrl,mccGetHelp,mccShowUsage,mimeTypeMatch,moveToExternal,NothingFunction,NothingFunctionData,resolveStub,resolveStubs,showUsage" />
52 <rule ref=
"MediaWiki.NamingConventions.ValidGlobalName">
54 <property name=
"ignoreList" type=
"array" value=
"$IP,$messageMemc" />
57 <rule ref=
"MediaWiki.NamingConventions.ValidGlobalName.allowedPrefix">
58 <exclude-pattern>profileinfo\.php
</exclude-pattern>
59 <exclude-pattern>maintenance/language/checkLanguage\.inc
</exclude-pattern>
60 <exclude-pattern>maintenance/doMaintenance\.php
</exclude-pattern>
61 <exclude-pattern>maintenance/mergeMessageFileList\.php
</exclude-pattern>
62 <exclude-pattern>maintenance/commandLine\.inc
</exclude-pattern>
64 <rule ref=
"Generic.Files.LineLength">
65 <exclude-pattern>*/languages/messages/Messages*\.php
</exclude-pattern>
67 <rule ref=
"MediaWiki.Files.ClassMatchesFilename.NotMatch">
69 Whitelist existing violations, but enable the sniff to prevent
72 <exclude-pattern>*/includes/specials/SpecialMostinterwikis\.php
</exclude-pattern>
73 <exclude-pattern>*/includes/specials/SpecialAncientpages\.php
</exclude-pattern>
74 <exclude-pattern>*/includes/specials/SpecialBrokenRedirects\.php
</exclude-pattern>
75 <exclude-pattern>*/includes/specials/SpecialConfirmemail\.php
</exclude-pattern>
76 <exclude-pattern>*/includes/specials/SpecialDeadendpages\.php
</exclude-pattern>
77 <exclude-pattern>*/includes/specials/SpecialDeletedContributions\.php
</exclude-pattern>
78 <exclude-pattern>*/includes/specials/SpecialDoubleRedirects\.php
</exclude-pattern>
79 <exclude-pattern>*/includes/specials/SpecialEmailInvalidate\.php
</exclude-pattern>
80 <exclude-pattern>*/includes/specials/SpecialFewestrevisions\.php
</exclude-pattern>
81 <exclude-pattern>*/includes/specials/SpecialFileDuplicateSearch\.php
</exclude-pattern>
82 <exclude-pattern>*/includes/specials/SpecialLinkSearch\.php
</exclude-pattern>
83 <exclude-pattern>*/includes/specials/SpecialListDuplicatedFiles\.php
</exclude-pattern>
84 <exclude-pattern>*/includes/specials/SpecialListredirects\.php
</exclude-pattern>
85 <exclude-pattern>*/includes/specials/SpecialLonelypages\.php
</exclude-pattern>
86 <exclude-pattern>*/includes/specials/SpecialLongpages\.php
</exclude-pattern>
87 <exclude-pattern>*/includes/specials/SpecialMIMEsearch\.php
</exclude-pattern>
88 <exclude-pattern>*/includes/specials/SpecialMediaStatistics\.php
</exclude-pattern>
89 <exclude-pattern>*/includes/specials/SpecialMostcategories\.php
</exclude-pattern>
90 <exclude-pattern>*/includes/specials/SpecialMostimages\.php
</exclude-pattern>
91 <exclude-pattern>*/includes/specials/SpecialMostlinked\.php
</exclude-pattern>
92 <exclude-pattern>*/includes/specials/SpecialMostlinkedcategories\.php
</exclude-pattern>
93 <exclude-pattern>*/includes/specials/SpecialMostlinkedtemplates\.php
</exclude-pattern>
94 <exclude-pattern>*/includes/specials/SpecialMostrevisions\.php
</exclude-pattern>
95 <exclude-pattern>*/includes/specials/SpecialMovepage\.php
</exclude-pattern>
96 <exclude-pattern>*/includes/specials/SpecialNewimages\.php
</exclude-pattern>
97 <exclude-pattern>*/includes/specials/SpecialRandompage\.php
</exclude-pattern>
98 <exclude-pattern>*/includes/specials/SpecialShortpages\.php
</exclude-pattern>
99 <exclude-pattern>*/includes/specials/SpecialUncategorizedcategories\.php
</exclude-pattern>
100 <exclude-pattern>*/includes/specials/SpecialUncategorizedimages\.php
</exclude-pattern>
101 <exclude-pattern>*/includes/specials/SpecialUncategorizedpages\.php
</exclude-pattern>
102 <exclude-pattern>*/includes/specials/SpecialUncategorizedtemplates\.php
</exclude-pattern>
103 <exclude-pattern>*/includes/specials/SpecialUnusedcategories\.php
</exclude-pattern>
104 <exclude-pattern>*/includes/specials/SpecialUnusedimages\.php
</exclude-pattern>
105 <exclude-pattern>*/includes/specials/SpecialUnusedtemplates\.php
</exclude-pattern>
106 <exclude-pattern>*/includes/specials/SpecialUnwatchedpages\.php
</exclude-pattern>
107 <exclude-pattern>*/includes/specials/SpecialUserrights\.php
</exclude-pattern>
108 <exclude-pattern>*/includes/specials/SpecialWantedcategories\.php
</exclude-pattern>
109 <exclude-pattern>*/includes/specials/SpecialWantedfiles\.php
</exclude-pattern>
110 <exclude-pattern>*/includes/specials/SpecialWantedpages\.php
</exclude-pattern>
111 <exclude-pattern>*/includes/specials/SpecialWantedtemplates\.php
</exclude-pattern>
112 <exclude-pattern>*/includes/specials/SpecialWithoutinterwiki\.php
</exclude-pattern>
113 <exclude-pattern>*/maintenance/CodeCleanerGlobalsPass.inc
</exclude-pattern>
114 <exclude-pattern>*/maintenance/archives/upgradeLogging\.php
</exclude-pattern>
115 <exclude-pattern>*/maintenance/benchmarks/bench_HTTP_HTTPS\.php
</exclude-pattern>
116 <exclude-pattern>*/maintenance/benchmarks/bench_Wikimedia_base_convert\.php
</exclude-pattern>
117 <exclude-pattern>*/maintenance/benchmarks/bench_delete_truncate\.php
</exclude-pattern>
118 <exclude-pattern>*/maintenance/benchmarks/bench_if_switch\.php
</exclude-pattern>
119 <exclude-pattern>*/maintenance/benchmarks/bench_utf8_title_check\.php
</exclude-pattern>
120 <exclude-pattern>*/maintenance/benchmarks/bench_wfIsWindows\.php
</exclude-pattern>
121 <exclude-pattern>*/maintenance/cleanupTable.inc
</exclude-pattern>
122 <exclude-pattern>*/maintenance/cleanupTitles\.php
</exclude-pattern>
123 <exclude-pattern>*/maintenance/commandLine.inc
</exclude-pattern>
124 <exclude-pattern>*/maintenance/edit\.php
</exclude-pattern>
125 <exclude-pattern>*/maintenance/findDeprecated\.php
</exclude-pattern>
126 <exclude-pattern>*/maintenance/getText\.php
</exclude-pattern>
127 <exclude-pattern>*/maintenance/hhvm/makeRepo\.php
</exclude-pattern>
128 <exclude-pattern>*/maintenance/importDump\.php
</exclude-pattern>
129 <exclude-pattern>*/maintenance/install\.php
</exclude-pattern>
130 <exclude-pattern>*/maintenance/invalidateUserSessions\.php
</exclude-pattern>
131 <exclude-pattern>*/maintenance/jsparse\.php
</exclude-pattern>
132 <exclude-pattern>*/maintenance/lag\.php
</exclude-pattern>
133 <exclude-pattern>*/maintenance/language/StatOutputs\.php
</exclude-pattern>
134 <exclude-pattern>*/maintenance/language/checkLanguage.inc
</exclude-pattern>
135 <exclude-pattern>*/maintenance/language/date-formats\.php
</exclude-pattern>
136 <exclude-pattern>*/maintenance/language/languages.inc
</exclude-pattern>
137 <exclude-pattern>*/maintenance/minify\.php
</exclude-pattern>
138 <exclude-pattern>*/maintenance/mysql\.php
</exclude-pattern>
139 <exclude-pattern>*/maintenance/parse\.php
</exclude-pattern>
140 <exclude-pattern>*/maintenance/preprocessorFuzzTest\.php
</exclude-pattern>
141 <exclude-pattern>*/maintenance/rebuildImages\.php
</exclude-pattern>
142 <exclude-pattern>*/maintenance/renderDump\.php
</exclude-pattern>
143 <exclude-pattern>*/maintenance/shell\.php
</exclude-pattern>
144 <exclude-pattern>*/maintenance/sql\.php
</exclude-pattern>
145 <exclude-pattern>*/maintenance/sqlite.inc
</exclude-pattern>
146 <exclude-pattern>*/maintenance/sqlite\.php
</exclude-pattern>
147 <exclude-pattern>*/maintenance/term/MWTerm\.php
</exclude-pattern>
148 <exclude-pattern>*/maintenance/update\.php
</exclude-pattern>
149 <exclude-pattern>*/maintenance/userDupes.inc
</exclude-pattern>
150 <exclude-pattern>*/maintenance/userOptions\.php
</exclude-pattern>
151 <exclude-pattern>*/maintenance/view\.php
</exclude-pattern>
152 <exclude-pattern>*/profileinfo\.php
</exclude-pattern>
153 <!-- Language converters use the pattern of 2 classes in one file -->
154 <exclude-pattern>*/languages/*\.php
</exclude-pattern>
155 <!-- Skip violations in some tests for now -->
156 <exclude-pattern>*/tests/parser/*\.php
</exclude-pattern>
157 <exclude-pattern>*/tests/phan/*\.php
</exclude-pattern>
158 <exclude-pattern>*/tests/phpunit/maintenance/*\.php
</exclude-pattern>
159 <exclude-pattern>*/tests/phpunit/bootstrap\.php
</exclude-pattern>
160 <exclude-pattern>*/tests/phpunit/phpunit\.php
</exclude-pattern>
162 <rule ref=
"MediaWiki.Files.ClassMatchesFilename.WrongCase">
164 Whitelist existing violations, but enable the sniff to prevent
167 <exclude-pattern>*/maintenance/language/alltrans\.php
</exclude-pattern>
168 <exclude-pattern>*/maintenance/language/digit2html\.php
</exclude-pattern>
169 <exclude-pattern>*/maintenance/language/langmemusage\.php
</exclude-pattern>
170 <exclude-pattern>*/maintenance/mctest\.php
</exclude-pattern>
171 <exclude-pattern>*/maintenance/mergeMessageFileList\.php
</exclude-pattern>
172 <exclude-pattern>*/maintenance/mwdocgen\.php
</exclude-pattern>
173 <exclude-pattern>*/maintenance/rebuildall\.php
</exclude-pattern>
174 <exclude-pattern>*/maintenance/rebuildmessages\.php
</exclude-pattern>
175 <exclude-pattern>*/maintenance/rebuildrecentchanges\.php
</exclude-pattern>
176 <exclude-pattern>*/maintenance/rebuildtextindex\.php
</exclude-pattern>
177 <exclude-pattern>*/maintenance/storage/checkStorage\.php
</exclude-pattern>
178 <exclude-pattern>*/maintenance/storage/recompressTracked\.php
</exclude-pattern>
179 <exclude-pattern>*/maintenance/storage/trackBlobs\.php
</exclude-pattern>
180 <!-- Skip violations in some tests for now -->
181 <exclude-pattern>*/tests/phpunit/includes/GlobalFunctions/*\.php
</exclude-pattern>
182 <exclude-pattern>*/tests/phpunit/maintenance/*\.php
</exclude-pattern>
185 <rule ref=
"Generic.Files.OneObjectStructurePerFile.MultipleFound">
187 Whitelist existing violations, but enable the sniff to prevent
190 <exclude-pattern>*/maintenance/dumpIterator\.php
</exclude-pattern>
191 <exclude-pattern>*/maintenance/Maintenance\.php
</exclude-pattern>
192 <exclude-pattern>*/maintenance/findDeprecated\.php
</exclude-pattern>
193 <exclude-pattern>*/maintenance/storage/recompressTracked\.php
</exclude-pattern>
194 <exclude-pattern>*/maintenance/preprocessorFuzzTest\.php
</exclude-pattern>
195 <exclude-pattern>*/maintenance/language/languages.inc
</exclude-pattern>
196 <exclude-pattern>*/maintenance/language/StatOutputs\.php
</exclude-pattern>
197 <exclude-pattern>*/maintenance/language/checkLanguage.inc
</exclude-pattern>
198 <exclude-pattern>*/maintenance/language/generateCollationData\.php
</exclude-pattern>
199 <exclude-pattern>*/maintenance/term/MWTerm\.php
</exclude-pattern>
200 <!-- Language converters use the pattern of 2 classes in one file -->
201 <exclude-pattern>*/languages/*\.php
</exclude-pattern>
202 <!-- We don't care that much about violations in tests -->
203 <exclude-pattern>*/tests/*\.php
</exclude-pattern>
205 <rule ref=
"PSR2.Methods.MethodDeclaration.Underscore">
206 <exclude-pattern>*/includes/StubObject\.php
</exclude-pattern>
207 <exclude-pattern>*/includes/StubUserLang\.php
</exclude-pattern>
209 <rule ref=
"MediaWiki.Usage.AssignmentInReturn.AssignmentInReturn">
210 <exclude-pattern>*/tests/phpunit/*\.php
</exclude-pattern>
212 <rule ref=
"MediaWiki.Usage.ForbiddenFunctions.escapeshellarg">
214 Whitelist existing violations, but enable the sniff to prevent
217 <exclude-pattern>*/includes/libs/filebackend/FSFileBackend\.php
</exclude-pattern>
218 <exclude-pattern>*/includes/shell/Command\.php
</exclude-pattern>
219 <exclude-pattern>*/includes/shell/Shell\.php
</exclude-pattern>
221 <rule ref=
"MediaWiki.Usage.ForbiddenFunctions.popen">
223 Whitelist existing violations, but enable the sniff to prevent
226 <exclude-pattern>*/includes/GlobalFunctions\.php
</exclude-pattern>
227 <exclude-pattern>*/includes/libs/filebackend/FSFileBackend\.php
</exclude-pattern>
228 <exclude-pattern>*/maintenance/includes/SevenZipStream\.php
</exclude-pattern>
229 <exclude-pattern>*/maintenance/populateImageSha1\.php
</exclude-pattern>
231 <rule ref=
"MediaWiki.Usage.ForbiddenFunctions.proc_open">
233 Whitelist existing violations, but enable the sniff to prevent
236 <exclude-pattern>includes/export/DumpPipeOutput\.php
</exclude-pattern>
237 <exclude-pattern>includes/resourceloader/ResourceLoaderImage\.php
</exclude-pattern>
238 <exclude-pattern>includes/shell/Command\.php
</exclude-pattern>
239 <exclude-pattern>maintenance/includes/TextPassDumper\.php
</exclude-pattern>
240 <exclude-pattern>maintenance/mysql\.php
</exclude-pattern>
241 <exclude-pattern>maintenance/storage/recompressTracked\.php
</exclude-pattern>
242 <exclude-pattern>tests/parser/editTests\.php
</exclude-pattern>
244 <rule ref=
"MediaWiki.Usage.ForbiddenFunctions.shell_exec">
246 Whitelist existing violations, but enable the sniff to prevent
249 <exclude-pattern>*/maintenance/mwdocgen\.php
</exclude-pattern>
250 <exclude-pattern>*/maintenance/updateCredits\.php
</exclude-pattern>
252 <rule ref=
"MediaWiki.Usage.ForbiddenFunctions.system">
254 Whitelist existing violations, but enable the sniff to prevent
257 <exclude-pattern>*/maintenance/mwdocgen\.php
</exclude-pattern>
259 <rule ref=
"MediaWiki.Commenting.MissingCovers.MissingCovers">
260 <exclude-pattern>tests/phpunit/structure/*
</exclude-pattern>
263 <arg name=
"encoding" value=
"UTF-8"/>
264 <arg name=
"extensions" value=
"php,php5,inc,sample"/>
265 <exclude-pattern type=
"relative">^extensions/
</exclude-pattern>
266 <exclude-pattern type=
"relative">^skins/
</exclude-pattern>
267 <exclude-pattern>AdminSettings\.php
</exclude-pattern>
268 <exclude-pattern>LocalSettings\.php
</exclude-pattern>