commonsbooking/.phpcs.xml.dist at master · sbomsdorf/commonsbooking · GitHub

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
<?xml version="1.0"?>
<ruleset name="WordPress Coding Standards based custom ruleset for your plugin"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
	<description>Generally-applicable sniffs for WordPress plugins.</description>

	<!-- What to scan -->
	<file>.</file>
    <exclude-pattern>assets/</exclude-pattern>
	<exclude-pattern>vendor/</exclude-pattern>
	<exclude-pattern>node_modules/</exclude-pattern>

	<!-- 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. -->

    <!-- Cache the results between runs. -->
	<arg name="cache" value="./.cache-phpcs-free.cache"/>

	<!-- 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-" />

	<!-- 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.9"/>

	<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
		<properties>
			<!-- Value: replace the function, class, and variable prefixes used. Separate multiple prefixes with a comma. -->
			<property name="prefixes" type="array">
                <element value="cb_" /> <!-- globals -->
                <element value="commonsbooking_" />
                <element value="CommonsBooking" /> <!-- namespaces -->
            </property>
		</properties>
	</rule>

    <!-- Checks if text_domain used -->
	<rule ref="WordPress.WP.I18n">
		<properties>
			<property name="text_domain" type="array" value="commonsbooking"/>
		</properties>
	</rule>

	<rule ref="WordPress.WhiteSpace.ControlStructureSpacing">
		<properties>
			<property name="blank_line_check" value="true"/>
		</properties>
	</rule>

	<!-- https://github.com/PHPCompatibility/PHPCompatibilityWP -->
	<rule ref="PHPCompatibility">
        <exclude-pattern>tests/</exclude-pattern>
    </rule>

    <rule ref="PHPCompatibilityWP" />

    <rule ref="Generic.Commenting">
		<exclude-pattern>tests/</exclude-pattern>
	</rule>

    <rule ref="Squiz.Commenting.FileComment.Missing">
		<exclude-pattern>tests/</exclude-pattern>
	</rule>

    <rule ref="WordPress">
        <exclude name="WordPress.Files.FileName" />
        <exclude name="Wordpress.PHP.YodaConditions" />
        <exclude name="WordPress.NamingConventions.ValidVariableName" />
        <exclude name="WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid" />

        <!-- Excludes Short Array Syntax sniffs entirely -->
        <exclude name="Universal.Arrays.DisallowShortArraySyntax.Found" />
        <exclude name="Generic.Arrays.DisallowShortArraySyntax"/>
        <exclude name="Generic.Commenting.DocComment.MissingShort" />

        <!-- Exclude namespace -->
        <exclude name="Universal.NamingConventions.NoReservedKeywordParameterNames.namespaceFound" />

        <!-- Too much false positives in our codebase, but please reactivate if necessary -->
        <exclude name="WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned" />
        <exclude name="WordPress.Arrays.MultipleStatementAlignment.LongIndexSpaceBeforeDoubleArrow" />

        <exclude name="Squiz.Commenting.InlineComment.InvalidEndChar" />
        <exclude name="Squiz.Commenting.FileComment" />
        <exclude name="Squiz.Commenting.FunctionComment.ParamCommentFullStop" />

        <exclude name="Squiz.Commenting.FunctionComment.EmptyThrows" />
    </rule>


    <!--
    #############################################################################
    Global exclusions for tests.
    Copied from https://github.com/polylang/polylang/blob/master/phpcs.xml.dist
    #############################################################################
    -->

    <rule ref="Generic.Commenting.Fixme.CommentFound">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="Generic.Files.OneObjectStructurePerFile.MultipleFound">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="Generic.PHP.NoSilencedErrors.Forbidden">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="Squiz.Commenting.ClassComment.Missing">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="Squiz.Commenting.FileComment">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="Squiz.Commenting.FunctionComment.Missing">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="Squiz.Commenting.FunctionComment.MissingParamComment">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="Squiz.Commenting.VariableComment.Missing">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="Squiz.PHP.CommentedOutCode.Found">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid">
        <exclude-pattern>*/tests/phpunit/includes/testcase-trait.php</exclude-pattern>
    </rule>

    <rule ref="WordPress.NamingConventions.ValidHookName.UseUnderscores">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="WordPress.PHP.NoSilencedErrors.Discouraged">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="WordPress.Security">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <!-- Adds commonsbooking specific wrappers around wp_kses ... -->
    <!-- Note that phpcs as php is case insensitive -->
    <rule ref="WordPress.Security.EscapeOutput">
        <properties>
            <property name="customEscapingFunctions" type="array">
                <element value="commonsbooking_sanitizehtml"/>
                <element value="commonsbooking_sanitizearrayorstring" />
            </property>
        </properties>
    </rule>

</ruleset>