-
-
Notifications
You must be signed in to change notification settings - Fork 75
Expand file tree
/
Copy path.phpcs.xml.dist
More file actions
172 lines (163 loc) · 7.75 KB
/
.phpcs.xml.dist
File metadata and controls
172 lines (163 loc) · 7.75 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
<?xml version="1.0"?>
<ruleset name="WordPress Coding Standards based custom ruleset for your plugin">
<description>Generally-applicable sniffs for WordPress plugins.</description>
<!-- What to scan -->
<file>.</file>
<exclude-pattern>/vendor/</exclude-pattern>
<exclude-pattern>/node_modules/</exclude-pattern>
<exclude-pattern>/dependencies/</exclude-pattern>
<exclude-pattern>/../wordpress/</exclude-pattern>
<exclude-pattern>/inc/site-exporter/mu-migration/</exclude-pattern>
<!-- Test files use PHPUnit naming conventions (PascalCase), not WordPress file naming. -->
<rule ref="WordPress.Files.FileName">
<exclude-pattern>/tests/</exclude-pattern>
</rule>
<!-- Test files legitimately need direct DB access for data setup/teardown — no caching needed. -->
<rule ref="WordPress.DB.DirectDatabaseQuery">
<exclude-pattern>/tests/</exclude-pattern>
</rule>
<!-- Test files follow PHPUnit conventions, not WordPress doc comment requirements. -->
<rule ref="Squiz.Commenting.FunctionComment">
<exclude-pattern>/tests/</exclude-pattern>
</rule>
<rule ref="Squiz.Commenting.ClassComment">
<exclude-pattern>/tests/</exclude-pattern>
</rule>
<rule ref="Squiz.Commenting.FileComment">
<exclude-pattern>/tests/</exclude-pattern>
</rule>
<!-- Test files may use non-Yoda conditions for readability. -->
<rule ref="WordPress.PHP.YodaConditions">
<exclude-pattern>/tests/</exclude-pattern>
</rule>
<!-- Test files may use inline arrays in function calls for conciseness. -->
<rule ref="PEAR.Functions.FunctionCallSignature.ContentAfterOpenBracket">
<exclude-pattern>/tests/</exclude-pattern>
</rule>
<rule ref="PEAR.Functions.FunctionCallSignature.CloseBracketLine">
<exclude-pattern>/tests/</exclude-pattern>
</rule>
<rule ref="PEAR.Functions.FunctionCallSignature.MultipleArguments">
<exclude-pattern>/tests/</exclude-pattern>
</rule>
<!-- Test files may use inline arrays for readability. -->
<rule ref="WordPress.Arrays.ArrayDeclaration.MultiLineNotAllowed">
<exclude-pattern>/tests/</exclude-pattern>
</rule>
<rule ref="WordPress.Arrays.ArrayDeclaration.CloseBraceNewLine">
<exclude-pattern>/tests/</exclude-pattern>
</rule>
<rule ref="WordPress.Arrays.ArrayDeclaration.AssociativeKeyFound">
<exclude-pattern>/tests/</exclude-pattern>
</rule>
<rule ref="WordPress.Arrays.ArrayKeySpacingRestrictions">
<exclude-pattern>/tests/</exclude-pattern>
</rule>
<!-- How to scan -->
<!-- Usage instructions: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage -->
<!-- Annotated ruleset: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
<arg value="sp"/> <!-- Show sniff and progress -->
<!-- <arg name="basepath" value="./"/>--><!-- Strip the file paths down to the relevant bit -->
<arg name="colors"/>
<arg name="extensions" value="php"/>
<arg name="parallel" value="8"/><!-- Enables parallel processing when available for faster results. -->
<!-- Rules: Check PHP version compatibility -->
<!-- https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions -->
<config name="testVersion" value="7.4-"/>
<!-- https://github.com/PHPCompatibility/PHPCompatibilityWP -->
<rule ref="PHPCompatibilityWP"/>
<!-- Rules: WordPress Coding Standards -->
<!-- https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards -->
<!-- https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties -->
<config name="minimum_supported_wp_version" value="5.3"/>
<rule ref="WordPress">
<exclude name="Squiz.Commenting.InlineComment.InvalidEndChar" />
<exclude name="WordPress.WhiteSpace.ControlStructureSpacing.NoSpaceAfterOpenParenthesis" />
<exclude name="WordPress.WhiteSpace.ControlStructureSpacing.NoSpaceBeforeCloseParenthesis" />
<exclude name="Squiz.Commenting.VariableComment.Missing" />
<exclude name="WordPress.WhiteSpace.CastStructureSpacing.NoSpaceBeforeOpenParenthesis" />
<exclude name="WordPress.WhiteSpace.OperatorSpacing.NoSpaceBefore" />
<exclude name="Universal.Arrays.DisallowShortArraySyntax" />
<exclude name="Universal.Operators.DisallowShortTernary" />
<exclude name="Squiz.Commenting.FileComment.SpacingAfterOpen" />
<exclude name="Squiz.Commenting.FileComment.SpacingAfterComment" />
<exclude name="Squiz.Commenting.FileComment.PackageName" />
<exclude name="WordPress.WP.GlobalVariablesOverride.Prohibited" />
<exclude name="Generic.Commenting.DocComment.MissingShort" />
<exclude name="Squiz.Commenting.FileComment.MissingPackageTag" />
<exclude name="WordPress.NamingConventions.PrefixAllGlobals" />
</rule>
<rule ref="WordPress.WhiteSpace.ControlStructureSpacing">
<properties>
<property name="blank_line_check" value="true"/>
</properties>
</rule>
<rule ref="PEAR.Functions.FunctionCallSignature">
<properties>
<property name="requiredSpacesAfterOpen" value="0"/>
<property name="requiredSpacesBeforeClose" value="0"/>
</properties>
</rule>
<rule ref="NormalizedArrays.Arrays.ArrayBraceSpacing">
<properties>
<property name="spacesSingleLine" value="0"/>
</properties>
</rule>
<rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing">
<properties>
<property name="equalsSpacing" value="1"/>
<property name="requiredSpacesAfterOpen" value="0"/>
<property name="requiredSpacesBeforeClose" value="0"/>
</properties>
</rule>
<rule ref="Generic.WhiteSpace.ArbitraryParenthesesSpacing">
<properties>
<property name="spacing" value="0"/>
<property name="ignoreNewlines" value="true"/>
</properties>
</rule>
<rule ref="WordPress.WP.Capabilities">
<properties>
<property name="custom_capabilities" type="array">
<element key="0" value="wu_edit_broadcasts"/>
<element key="1" value="wu_edit_checkout_forms"/>
<element key="2" value="wu_edit_settings"/>
<element key="3" value="wu_read_sites"/>
<element key="4" value="read_notes"/>
<element key="5" value="edit_notes"/>
<element key="6" value="delete_notes"/>
<element key="7" value="wu_edit_payments"/>
<element key="8" value="wu_edit_sites"/>
<element key="9" value="wu_delete_sites"/>
<element key="10" value="wu_delete_payments"/>
<element key="11" value="wu_transfer_memberships"/>
<element key="12" value="wu_transfer_sites"/>
<element key="13" value="wu_read_financial" />
<element key="14" value="wu_manage_invoice" />
<element key="15" value="wu_delete_memberships" />
<element key="16" value="read_tax_rates" />
<element key="17" value="wu_read_dashboard" />
<element key="18" value="wu_read_memberships" />
<element key="19" value="wu_read_customers" />
<element key="20" value="wu_read_products" />
<element key="21" value="wu_read_payments" />
<element key="22" value="wu_read_discount_codes" />
<element key="23" value="wu_read_settings" />
</property>
</properties>
</rule>
<rule ref="WordPress.Security.ValidatedSanitizedInput">
<properties>
<property name="customSanitizingFunctions" type="array">
<element value="wu_clean" />
</property>
</properties>
</rule>
<rule ref="WordPress.WP.I18n">
<properties>
<property name="text_domain" type="array">
<element value="ultimate-multisite"/>
</property>
</properties>
</rule>
</ruleset>