blockwright/phpcs.xml.dist at main · markrusselldev/blockwright · 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
<?xml version="1.0"?>
<ruleset name="Blockwright">
	<description>WordPress Coding Standards for the Blockwright theme</description>

	<!-- What to scan (theme PHP only). -->
	<file>functions.php</file>
	<file>inc</file>
	<file>patterns</file>

	<!-- What to skip. -->
	<exclude-pattern>*/vendor/*</exclude-pattern>
	<exclude-pattern>*/node_modules/*</exclude-pattern>
	<exclude-pattern>*/dist/*</exclude-pattern>
	<!-- Dev-only tooling, stripped from the release build (see scripts/release.js);
	     lint what actually ships. -->
	<exclude-pattern>inc/dev*.php</exclude-pattern>

	<!-- Default CLI behaviour. -->
	<arg name="colors"/>
	<arg name="report" value="full"/>
	<arg name="report-width" value="120"/>
	<arg value="p"/> <!-- progress -->
	<arg value="s"/> <!-- show sniff codes -->
	<arg name="extensions" value="php"/>
	<arg name="parallel" value="8"/>

	<!-- Standards. -->
	<rule ref="WordPress-Core"/>
	<rule ref="WordPress-Extra"/>
	<rule ref="WordPress-Docs"/>

	<!-- PHP compatibility: match style.css "Requires PHP: 7.4". -->
	<config name="testVersion" value="7.4-"/>
	<rule ref="PHPCompatibilityWP"/>

	<!-- WordPress target: match style.css "Requires at least: 6.9". -->
	<config name="minimum_wp_version" value="7.0"/>

	<!-- Pattern files use WordPress's pattern header (Title/Slug/Categories), not a
	     standard PHP file doc block, so the file-comment sniffs don't apply. -->
	<rule ref="Squiz.Commenting.FileComment">
		<exclude-pattern>patterns/*</exclude-pattern>
	</rule>

	<!-- i18n text domain. -->
	<rule ref="WordPress.WP.I18n">
		<properties>
			<property name="text_domain" type="array">
				<element value="blockwright"/>
			</property>
		</properties>
	</rule>

	<!-- Global prefixes for functions/classes/hooks/globals. -->
	<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
		<properties>
			<property name="prefixes" type="array">
				<element value="blockwright"/>
			</property>
		</properties>
		<!-- Pattern files are require'd inside a function by WordPress's pattern
		     loader (_register_theme_block_patterns), so their top-level variables
		     are function-scoped locals, not globals - matching WP core's own
		     unprefixed pattern variables. -->
		<exclude-pattern>patterns/*</exclude-pattern>
	</rule>
</ruleset>