forked from wp-cli/wp-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathphpcs.xml.dist
More file actions
130 lines (109 loc) · 5.66 KB
/
phpcs.xml.dist
File metadata and controls
130 lines (109 loc) · 5.66 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
<?xml version="1.0"?>
<ruleset name="WP-CLI">
<description>Custom ruleset for WP-CLI</description>
<!--
#############################################################################
COMMAND LINE ARGUMENTS
For help understanding this file: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml
For help using PHPCS: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage
#############################################################################
-->
<!-- What to scan. -->
<file>.</file>
<!-- Ignoring select files/folders.
https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#ignoring-files-and-folders -->
<exclude-pattern>*/tests/data/*</exclude-pattern>
<exclude-pattern>*/bundle/*</exclude-pattern>
<!-- Show progress. -->
<arg value="p"/>
<!-- Strip the filepaths down to the relevant bit. -->
<arg name="basepath" value="./"/>
<!-- Check up to 8 files simultaneously. -->
<arg name="parallel" value="8"/>
<!--
#############################################################################
USE THE WP_CLI_CS RULESET
#############################################################################
-->
<rule ref="WP_CLI_CS">
<!-- The `while` control structure is the only one where assignments in conditions are mostly valid. -->
<exclude name="Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition"/>
</rule>
<!--
#############################################################################
PROJECT SPECIFIC CONFIGURATION FOR SNIFFS
#############################################################################
-->
<!-- For help understanding the `testVersion` configuration setting:
https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions -->
<config name="testVersion" value="5.6-"/>
<!-- Verify that everything in the global namespace is either namespaced or prefixed.
The default prefixes `WP_CLI` (for namespaces and classes) and `wpcli` (for variables) are inherited
from the ruleset. This adds one additional allowed prefix specifically for hooks (though
not automatically limited to them).
See: https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties#naming-conventions-prefix-everything-in-the-global-namespace -->
<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
<properties>
<property name="prefixes" type="array" extend="true">
<element value="cli_"/><!-- Hooks. -->
</property>
</properties>
</rule>
<!-- Whitelist the Utils\mysql_host_to_cli_args() method.
See: https://github.com/phpcompatibility/phpcompatibility#phpcompatibility-specific-options -->
<rule ref="PHPCompatibility.Extensions.RemovedExtensions">
<properties>
<property name="functionWhitelist" type="array">
<element value="mysql_host_to_cli_args"/>
</property>
</properties>
</rule>
<!-- Allow for back-compat conversion comments to be explained in logical shorthand.
See: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Customisable-Sniff-Properties#squizphpcommentedoutcode -->
<rule ref="Squiz.PHP.CommentedOutCode">
<properties>
<property name="maxPercentage" value="45"/>
</properties>
</rule>
<!--
#############################################################################
SELECTIVE EXCLUSIONS
#############################################################################
-->
<!-- Exclude existing classes from the prefix rule as it would break BC to prefix them now. -->
<rule ref="WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedClassFound">
<exclude-pattern>*/php/commands/src/CLI_(Cache_)?Command\.php$</exclude-pattern>
<exclude-pattern>*/php/commands/src/Help_Command\.php$</exclude-pattern>
</rule>
<!-- Exclude existing classes from the prefix rule as it would break BC to prefix them now. -->
<rule ref="WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound">
<exclude-pattern>php/wp-settings-cli\.php$</exclude-pattern>
</rule>
<!-- These are all to do with file-system related tests. Just ignore them. -->
<rule ref="WordPress.WP.CapitalPDangit">
<exclude-pattern>*/tests/(Extractor|Utils)Test\.php$</exclude-pattern>
</rule>
<!-- Allow for select data providers for tests to use single-line associative arrays. -->
<rule ref="WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound">
<exclude-pattern>*/tests/(Process|Utils)Test\.php$</exclude-pattern>
</rule>
<!-- This is a procedural stand-alone file that is never loaded in a WordPress context,
so this file does not have to comply with WP naming conventions. -->
<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
<exclude-pattern>*/utils/get-package-require-from-composer\.php$</exclude-pattern>
</rule>
<!-- Exclude existing classes from the protected parameter names rule as it would break BC to change these now. -->
<rule ref="Universal.NamingConventions.NoReservedKeywordParameterNames">
<exclude-pattern>*/php/WP_CLI/Iterators/Transform\.php</exclude-pattern>
<exclude-pattern>*/php/WP_CLI/Inflector\.php</exclude-pattern>
<exclude-pattern>*/php/WP_CLI/Autoloader\.php</exclude-pattern>
<exclude-pattern>*/php/WP_CLI/Dispatcher/CommandFactory\.php</exclude-pattern>
<exclude-pattern>*/php/WP_CLI/Dispatcher/CompositeCommand\.php</exclude-pattern>
<exclude-pattern>*/php/WP_CLI/Dispatcher/Subcommand\.php</exclude-pattern>
<exclude-pattern>*/php/utils\.php</exclude-pattern>
<exclude-pattern>*/php/utils-wp\.php</exclude-pattern>
<exclude-pattern>*/php/WP_CLI/Runner\.php</exclude-pattern>
<exclude-pattern>*/php/WP_CLI/UpgraderSkin\.php$</exclude-pattern>
<exclude-pattern>*/php/class-wp-cli\.php$</exclude-pattern>
</rule>
</ruleset>