Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathphpcs.xml.dist
More file actions
Latest commit
219 lines (185 loc) · 8.89 KB
/
Copy pathphpcs.xml.dist
File metadata and controls
219 lines (185 loc) · 8.89 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
<?xml version="1.0"?>
<rulesetname="TheWebSolver Codegarage Coding Standards">
<!-- See https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
<!-- See https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards -->
<!-- See https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki -->
<!-- See https://github.com/wimg/PHPCompatibility -->
<!-- See https://tommcfarlin.com/php-codesniffer/ -->
<!-- See https://tommcfarlin.com/php-codesniffer-in-visual-studio-code/ -->
<description>A custom set of code standard rules to check.</description>
<configname="testVersion"value="8.2"/>
<!--
Pass some flags as PHPCS CLI arguments:
p: Show progress of the run.
s: Show sniff codes in all reports.
v: Print verbose output.
n: Do not print warnings.
-->
<argvalue="psv"/>
<!-- Check up to 8 files simultaneously. -->
<argname="parallel"value="8"/>
<argname="colors"/>
<!-- Only check the PHP, CSS and SCSS files. JS files must be checked separately with ESLint. -->
<argname="extensions"value="php,css,scss/css"/>
<!-- Check all files in this directory and the directories below it. -->
<file>.</file>
<!-- Exclude node modules -->
<exclude-pattern>*/node_modules/*</exclude-pattern>
<!-- Exclude vendors except first-party libraries. -->
<exclude-pattern>*/vendor/*</exclude-pattern>
<!-- Ignore PHP files on asset directory. -->
<exclude-pattern>*/assets/css*.php</exclude-pattern>
<exclude-pattern>*/assets/js*.php</exclude-pattern>
<!--
#############################################################################
SNIFF RULE PACKAGES USED:
#############################################################################
-->
<ruleref="WordPress"/>
<ruleref="WordPress-Core" />
<ruleref="WordPress-Docs" />
<ruleref="WordPress-Extra" />
<ruleref="PHPCompatibility" />
<!--
#############################################################################
UNIVERSAL SNIFF RULE CONFIGURATIONS:
#############################################################################
-->
<ruleref="Universal.Operators.DisallowShortTernary">
<!-- Allow short ternary operator. Eg: $x ?: $y -->
<excludename="Universal.Operators.DisallowShortTernary.Found" />
</rule>
<!-- Allow setting param names: "$for", "$object", etc. -->
<ruleref="Universal.NamingConventions">
<excludename="Universal.NamingConventions.NoReservedKeywordParameterNames"/>
</rule>
<!-- Allow using double negation "!!". -->
<ruleref="Universal.CodeAnalysis">
<excludename="Universal.CodeAnalysis.NoDoubleNegative.FoundDouble"/>
</rule>
<!--
#############################################################################
GENERIC SNIFF RULE CONFIGURATIONS:
#############################################################################
-->
<ruleref="Generic.CodeAnalysis">
<!-- Allow variable assignment in the condition. Eg: if( $x = file_exists( $y ) ) { require $x; } -->
<excludename="Generic.CodeAnalysis.AssignmentInCondition.Found" />
<!-- Allow variable assignment in the ternary operator. Eg: true === ( $z = file_exists( $y ) ) ? $z : $x; -->
<excludename="Generic.CodeAnalysis.AssignmentInCondition.FoundInTernaryCondition" />
<excludename="Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition" />
</rule>
<ruleref="Generic.Commenting.DocComment">
<excludename="Generic.Commenting.DocComment.MissingShort"/>
</rule>
<ruleref="Generic.CodeAnalysis.UnusedFunctionParameter">
<excludename="Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed"/>
</rule>
<!--
#############################################################################
SQUIZ SNIFF RULE CONFIGURATIONS:
https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-Ruleset
#############################################################################
-->
<ruleref="Squiz.PHP.DisallowMultipleAssignments">
<!-- Allow assignment in the control structure. Eg: if( $x = adding( $y + $z ) > 0 ) { return $x; } -->
<excludename="Squiz.PHP.DisallowMultipleAssignments.FoundInControlStructure" />
<!-- Allow multiple assignment in the same line. Eg: $x = $y = 'value' -->
<excludename="Squiz.PHP.DisallowMultipleAssignments.Found" />
</rule>
<ruleref="Squiz.Commenting">
<excludename="Squiz.Commenting.FileComment.Missing"/>
<excludename="Squiz.Commenting.FunctionComment.Missing"/>
<excludename="Squiz.Commenting.ClassComment.Missing"/>
<excludename="Squiz.Commenting.VariableComment.Missing"/>
<excludename="Squiz.Commenting.FunctionComment.ParamCommentFullStop"/>
<excludename="Squiz.Commenting.FunctionComment.MissingParamComment"/>
<excludename="Squiz.Commenting.VariableComment.MissingVar"/>
<!-- Allow comments on same line as code. -->
<excludename="Squiz.Commenting.PostStatementComment.Found"/>
<!-- Allow annotations (such as silencing PHPStan error that starts with "@") on same line as code. -->
<excludename="Squiz.Commenting.PostStatementComment.AnnotationFound"/>
<excludename="Squiz.Commenting.FunctionComment.ParamNameNoMatch"/>
<!-- Do not sniff comments about @param & @throws in docComment. -->
<excludename="Squiz.Commenting.FunctionComment.MissingParamTag"/>
<excludename="Squiz.Commenting.FunctionComment.MissingParamName"/>
<excludename="Squiz.Commenting.FunctionComment.IncorrectTypeHint"/>
<excludename="Squiz.Commenting.FunctionCommentThrowTag.WrongNumber"/>
</rule>
<ruleref="Squiz.PHP.CommentedOutCode">
<properties>
<propertyname="maxPercentage"value="90%"/>
</properties>
</rule>
<!--
#############################################################################
PSR SNIFF RULE CONFIGURATIONS:
#############################################################################
-->
<ruleref="PSR12.Traits.UseDeclaration">
<excludename="PSR12.Traits.UseDeclaration.MultipleImport"/>
</rule>
<ruleref="PSR12.Files.FileHeader">
<!-- Allow class-based use imports after function-based use imports in the file header. -->
<excludename="PSR12.Files.FileHeader.IncorrectOrder"/>
<!-- Do not force to group imports by class and function. -->
<excludename="PSR12.Files.FileHeader.IncorrectGrouping"/>
</rule>
<!--
#############################################################################
WORDPRESS SPECIFIC SNIFF RULE CONFIGURATIONS:
https://github.com/WordPress/WordPress-Coding-Standards/wiki/Customizable-sniff-properties
#############################################################################
-->
<!--
Allow for named specific exceptions to the file name rules based
on the directory hierarchy and ensure PSR-4 autoloading compatibility.
- Remove strict class file name requirement.
- Remove no hyphenated lowercase requirement.
-->
<ruleref="WordPress.Files.FileName">
<properties>
<propertyname="strict_class_file_names"value="false" />
</properties>
<excludename="WordPress.Files.FileName.NotHyphenatedLowercase" />
</rule>
<ruleref="WordPress.Arrays.MultipleStatementAlignment">
<properties>
<!-- No need to adjust alignment of large arrays when the item with the largest key is removed. -->
<propertyname="exact"value="false"/>
<!-- Don't align multi-line items if ALL items in the array are multi-line. -->
<propertyname="alignMultilineItems"value="!=100"/>
<!-- Array assignment operator should always be on the same line as the array key. -->
<propertyname="ignoreNewlines"value="false"/>
</properties>
</rule>
<ruleref="WordPress.NamingConventions.ValidVariableName">
<!-- Assigning value to the non-snakeCased property. -->
<excludename="WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase"/>
<excludename="WordPress.NamingConventions.ValidVariableName.PropertyNotSnakeCase"/>
<excludename="WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase"/>
<excludename="WordPress.NamingConventions.ValidVariableName.InterpolatedVariableNotSnakeCase"/>
</rule>
<!-- Maintaining same format as enum's other default methods. -->
<ruleref="WordPress.NamingConventions.ValidFunctionName">
<excludename="WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid"/>
<excludename="WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid"/>
</rule>
<ruleref="WordPress.Security">
<excludename="WordPress.Security.EscapeOutput.ExceptionNotEscaped"/>
<excludename="WordPress.Security.EscapeOutput.OutputNotEscaped"/>
</rule>
<ruleref="WordPress.CodeAnalysis">
<excludename="WordPress.CodeAnalysis.AssignmentInTernaryCondition.FoundInTernaryCondition"/>
</rule>
<ruleref="WordPress.WP">
<excludename="WordPress.WP.AlternativeFunctions"/>
</rule>
<!--
Allow using "$this" for enum methods. Temp fix until PHPCompatibilityWP
is updated to support PHPCompatibility v10.x.
-->
<ruleref="PHPCompatibility.Variables.ForbiddenThisUseContexts.OutsideObjectContext">
<excludename="PHPCompatibility.Variables.ForbiddenThisUseContexts.OutsideObjectContext"/>
</rule>
</ruleset>