XmlDumpWriter: Remove unused variable from writeText()
[mediawiki.git] / .phpcs.xml
blob48bf42fa971220ea9e182df1ba0bb61cb900d4d3
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.Commenting.PropertyDocumentation.SpacingAfter" />
13                 <exclude name="MediaWiki.Commenting.PropertyDocumentation.WrongStyle" />
14                 <exclude name="MediaWiki.ControlStructures.AssignmentInControlStructures.AssignmentInControlStructures" />
15                 <exclude name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName" />
16                 <exclude name="MediaWiki.Usage.DbrQueryUsage.DbrQueryFound" />
17                 <exclude name="MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgTitle" />
18                 <exclude name="MediaWiki.Usage.ExtendClassUsage.FunctionVarUsage" />
19                 <exclude name="MediaWiki.Usage.ForbiddenFunctions.passthru" />
20                 <exclude name="MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals" />
21                 <exclude name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />
22                 <exclude name="PSR2.Classes.PropertyDeclaration.Multiple" />
23         </rule>
24         <rule ref="MediaWiki.NamingConventions.ValidGlobalName">
25                 <properties>
26                         <property name="ignoreList" type="array" value="$IP" />
27                 </properties>
28         </rule>
29         <rule ref="MediaWiki.NamingConventions.ValidGlobalName.allowedPrefix">
30                 <exclude-pattern>*/maintenance/doMaintenance\.php</exclude-pattern>
31                 <exclude-pattern>*/maintenance/mergeMessageFileList\.php</exclude-pattern>
32                 <exclude-pattern>*/maintenance/CommandLineInc\.php</exclude-pattern>
33                 <exclude-pattern>*/tests/phpunit/MediaWikiIntegrationTestCase\.php</exclude-pattern>
34         </rule>
35         <rule ref="Generic.Files.LineLength">
36                 <exclude-pattern>*/languages/messages/*</exclude-pattern>
37                 <exclude-pattern>*/tests/*</exclude-pattern>
38         </rule>
39         <rule ref="MediaWiki.Files.ClassMatchesFilename.NotMatch">
40                 <!--
41                         Continue to allow existing violations, but enable the sniff to prevent
42                         any new occurrences.
43                 -->
44                 <exclude-pattern>*/includes/specials/SpecialMostimages\.php</exclude-pattern>
45                 <exclude-pattern>*/includes/specials/SpecialMovepage\.php</exclude-pattern>
46                 <exclude-pattern>*/includes/specials/SpecialUserrights\.php</exclude-pattern>
47                 <exclude-pattern>*/includes/specials/SpecialWantedfiles\.php</exclude-pattern>
48                 <exclude-pattern>*/includes/specials/SpecialWantedpages\.php</exclude-pattern>
49                 <exclude-pattern>*/maintenance/cleanupTitles\.php</exclude-pattern>
50                 <exclude-pattern>*/maintenance/edit\.php</exclude-pattern>
51                 <exclude-pattern>*/maintenance/findDeprecated\.php</exclude-pattern>
52                 <exclude-pattern>*/maintenance/getText\.php</exclude-pattern>
53                 <exclude-pattern>*/maintenance/importDump\.php</exclude-pattern>
54                 <exclude-pattern>*/maintenance/install\.php</exclude-pattern>
55                 <exclude-pattern>*/maintenance/jsparse\.php</exclude-pattern>
56                 <exclude-pattern>*/maintenance/lag\.php</exclude-pattern>
57                 <exclude-pattern>*/maintenance/language/StatOutputs\.php</exclude-pattern>
58                 <exclude-pattern>*/maintenance/language/date-formats\.php</exclude-pattern>
59                 <exclude-pattern>*/maintenance/mysql\.php</exclude-pattern>
60                 <exclude-pattern>*/maintenance/parse\.php</exclude-pattern>
61                 <exclude-pattern>*/maintenance/preprocessorFuzzTest\.php</exclude-pattern>
62                 <exclude-pattern>*/maintenance/rebuildImages\.php</exclude-pattern>
63                 <exclude-pattern>*/maintenance/renderDump\.php</exclude-pattern>
64                 <exclude-pattern>*/maintenance/shell\.php</exclude-pattern>
65                 <exclude-pattern>*/maintenance/sql\.php</exclude-pattern>
66                 <exclude-pattern>*/maintenance/update\.php</exclude-pattern>
67                 <exclude-pattern>*/maintenance/userOptions\.php</exclude-pattern>
68                 <exclude-pattern>*/maintenance/view\.php</exclude-pattern>
69                 <!-- Skip violations in some tests for now -->
70                 <exclude-pattern>*/tests/parser/*</exclude-pattern>
71                 <exclude-pattern>*/tests/phpunit/maintenance/*</exclude-pattern>
72                 <exclude-pattern>*/tests/phpunit/bootstrap\.php</exclude-pattern>
73                 <exclude-pattern>*/tests/phpunit/phpunit\.php</exclude-pattern>
74         </rule>
75         <rule ref="MediaWiki.Files.ClassMatchesFilename.WrongCase">
76                 <!--
77                         Continue to allow existing violations, but enable the sniff to prevent
78                         any new occurrences.
79                 -->
80                 <exclude-pattern>*/maintenance/language/alltrans\.php</exclude-pattern>
81                 <exclude-pattern>*/maintenance/language/digit2html\.php</exclude-pattern>
82                 <exclude-pattern>*/maintenance/language/langmemusage\.php</exclude-pattern>
83                 <exclude-pattern>*/maintenance/mctest\.php</exclude-pattern>
84                 <exclude-pattern>*/maintenance/mergeMessageFileList\.php</exclude-pattern>
85                 <exclude-pattern>*/maintenance/mwdocgen\.php</exclude-pattern>
86                 <exclude-pattern>*/maintenance/rebuildall\.php</exclude-pattern>
87                 <exclude-pattern>*/maintenance/rebuildmessages\.php</exclude-pattern>
88                 <exclude-pattern>*/maintenance/rebuildrecentchanges\.php</exclude-pattern>
89                 <exclude-pattern>*/maintenance/rebuildtextindex\.php</exclude-pattern>
90                 <exclude-pattern>*/maintenance/storage/checkStorage\.php</exclude-pattern>
91                 <exclude-pattern>*/maintenance/storage/recompressTracked\.php</exclude-pattern>
92                 <exclude-pattern>*/maintenance/storage/trackBlobs\.php</exclude-pattern>
93                 <!-- Skip violations in some tests for now -->
94                 <exclude-pattern>*/tests/phpunit/unit/includes/GlobalFunctions/*</exclude-pattern>
95                 <exclude-pattern>*/tests/phpunit/includes/GlobalFunctions/*</exclude-pattern>
96                 <exclude-pattern>*/tests/phpunit/maintenance/*</exclude-pattern>
97                 <exclude-pattern>*/tests/phpunit/integration/includes/GlobalFunctions/*</exclude-pattern>
98         </rule>
99         <rule ref="Generic.PHP.NoSilencedErrors.Discouraged">
100                 <exclude-pattern>*/tests/*</exclude-pattern>
101         </rule>
102         <rule ref="Generic.Files.OneObjectStructurePerFile.MultipleFound">
103                 <!--
104                         Continue to allow existing violations, but enable the sniff to prevent
105                         any new occurrences.
106                 -->
107                 <exclude-pattern>*/maintenance/dumpIterator\.php</exclude-pattern>
108                 <exclude-pattern>*/maintenance/findDeprecated\.php</exclude-pattern>
109                 <exclude-pattern>*/maintenance/storage/recompressTracked\.php</exclude-pattern>
110                 <exclude-pattern>*/maintenance/preprocessorFuzzTest\.php</exclude-pattern>
111                 <exclude-pattern>*/maintenance/language/StatOutputs\.php</exclude-pattern>
112                 <exclude-pattern>*/maintenance/language/generateCollationData\.php</exclude-pattern>
113                 <!-- We don't care that much about violations in tests -->
114                 <exclude-pattern>*/tests/*</exclude-pattern>
115         </rule>
116         <rule ref="MediaWiki.Usage.AssignmentInReturn.AssignmentInReturn">
117                 <exclude-pattern>*/tests/phpunit/*</exclude-pattern>
118         </rule>
119         <rule ref="MediaWiki.Usage.ForbiddenFunctions.popen">
120                 <!--
121                         Continue to allow existing violations, but enable the sniff to prevent
122                         any new occurrences.
123                 -->
124                 <exclude-pattern>*/includes/GlobalFunctions\.php</exclude-pattern>
125                 <exclude-pattern>*/includes/libs/filebackend/FSFileBackend\.php</exclude-pattern>
126                 <exclude-pattern>*/maintenance/includes/SevenZipStream\.php</exclude-pattern>
127                 <exclude-pattern>*/maintenance/populateImageSha1\.php</exclude-pattern>
128         </rule>
129         <rule ref="MediaWiki.Usage.ForbiddenFunctions.proc_open">
130                 <!--
131                         Continue to allow existing violations, but enable the sniff to prevent
132                         any new occurrences.
133                 -->
134                 <exclude-pattern>*/includes/export/DumpPipeOutput\.php</exclude-pattern>
135                 <exclude-pattern>*/includes/ResourceLoader/Image\.php</exclude-pattern>
136                 <exclude-pattern>*/includes/shell/Command\.php</exclude-pattern>
137                 <exclude-pattern>*/maintenance/includes/TextPassDumper\.php</exclude-pattern>
138                 <exclude-pattern>*/maintenance/mysql\.php</exclude-pattern>
139                 <exclude-pattern>*/maintenance/storage/recompressTracked\.php</exclude-pattern>
140                 <exclude-pattern>*/tests/parser/editTests\.php</exclude-pattern>
141         </rule>
142         <rule ref="MediaWiki.Usage.ForbiddenFunctions.shell_exec">
143                 <!--
144                         Continue to allow existing violations, but enable the sniff to prevent
145                         any new occurrences.
146                 -->
147                 <exclude-pattern>*/maintenance/mwdocgen\.php</exclude-pattern>
148                 <exclude-pattern>*/maintenance/updateCredits\.php</exclude-pattern>
149         </rule>
150         <rule ref="MediaWiki.Usage.ForbiddenFunctions.system">
151                 <!--
152                         Continue to allow existing violations, but enable the sniff to prevent
153                         any new occurrences.
154                 -->
155                 <exclude-pattern>*/maintenance/mwdocgen\.php</exclude-pattern>
156         </rule>
157         <rule ref="Generic.Arrays.DisallowShortArraySyntax">
158                 <!--
159                         T273340: Rule not to be enabled on any other file.
160                         PHPVersionCheck.php requires syntax to be old PHP compatible.
161                         The rest should therefore use [] rather than array() as per the
162                         MediaWiki style guide.
163                 -->
164                 <include-pattern>includes/PHPVersionCheck\.php</include-pattern>
165         </rule>
166         <file>.</file>
167         <arg name="encoding" value="UTF-8"/>
168         <arg name="extensions" value="php"/>
169         <exclude-pattern type="relative">^(extensions|skins)/*</exclude-pattern>
170         <exclude-pattern>LocalSettings(-installer)?\.php</exclude-pattern>
171 </ruleset>