media-experiments/phpcs.xml.dist at main · swissspidy/media-experiments · 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
<?xml version="1.0"?>
<ruleset name="WordPress Coding Standards for Media Experiments Plugin">
	<description>A custom set of code standard rules for Media Experiments.</description>

	<rule ref="WordPress-Core">
		<exclude name="Universal.Arrays.DisallowShortArraySyntax" />
	</rule>

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

	<rule ref="WordPress.WP.I18n">
		<properties>
			<property name="text_domain" value="media-experiments" />
		</properties>
	</rule>

	<!-- Make sure we prefix everything in the global namespace. -->
	<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
		<properties>
			<property name="prefixes" type="array">
				<element value="mexp"/>
				<element value="MediaExperiments"/>
				<element value="media_experiments"/>
			</property>
		</properties>
	</rule>

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

	<!-- We only support the latest major WordPress release. -->
	<config name="minimum_supported_wp_version" value="7.1" />
	<rule ref="WordPress.WP.DeprecatedFunctions" />

	<!-- Check all PHP files in directory tree by default. -->
	<arg name="extensions" value="php"/>
	<file>.</file>

	<!--
	File Layout: Declare symbols or run code, but not both.

	inc/*.php files legitimately mix the two: every one of them opens with
	the standard `if ( ! defined( 'ABSPATH' ) ) { exit; }` guard alongside
	its function/class declarations, which is the side effect this sniff
	means to catch. media-experiments.php is excluded for the same reason
	(the plugin bootstrap file both defines constants and requires the
	inc/ files).
	-->
	<rule ref="PSR1.Files.SideEffects">
		<exclude-pattern>media-experiments.php</exclude-pattern>
		<exclude-pattern>inc/*.php</exclude-pattern>
	</rule>

	<!-- Prevent false positives for IDE annotations. -->
	<rule ref="Squiz.PHP.CommentedOutCode">
		<properties>
			<property name="maxPercentage" value="75" />
		</properties>
	</rule>

	<!-- Test for PHP 8.0+ compatibility. -->
	<config name="testVersion" value="8.0-"/>

	<exclude-pattern>inc/class-blurhash.php</exclude-pattern>
	<exclude-pattern>*/build/*</exclude-pattern>
	<exclude-pattern>*/node_modules/*</exclude-pattern>
	<exclude-pattern>*/vendor/*</exclude-pattern>
	<exclude-pattern>*/tests/*/bootstrap.php</exclude-pattern>
	<exclude-pattern>*/tests/e2e/plugins/*</exclude-pattern>
	<exclude-pattern>*/tests/phpunit/data/*</exclude-pattern>
</ruleset>