pattern-builder/phpcs.xml.dist at main · Twenty-Bellows/pattern-builder · 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
<?xml version="1.0"?>
<ruleset name="Pattern Builder Coding Standards">
	<description>WordPress Coding Standards for Pattern Builder plugin.</description>

	<!-- Only scan PHP files -->
	<arg name="extensions" value="php"/>

	<!-- Show progress and sniff codes in all reports -->
	<arg value="ps"/>

	<!-- Check up to 8 files simultaneously. -->
	<arg name="parallel" value="8"/>

	<!-- Strip the filepaths down to the relevant bit. -->
	<arg name="basepath" value="./"/>

	<!-- Check all PHP files in plugin directory -->
	<file>.</file>

	<!-- Exclude paths -->
	<exclude-pattern>*/vendor/*</exclude-pattern>
	<exclude-pattern>*/node_modules/*</exclude-pattern>
	<exclude-pattern>*/build/*</exclude-pattern>
	<exclude-pattern>*/release/*</exclude-pattern>
	<exclude-pattern>*/tests/*</exclude-pattern>
	<exclude-pattern>*/dev-assets/*</exclude-pattern>
	<!-- In the working folder but not in the tree: the wp.org working copy the ship
	     scripts check out, and an agent's worktree. Both hold old copies of this
	     plugin, so linting them reports this repository's own history back at it. -->
	<exclude-pattern>*/svn/*</exclude-pattern>
	<exclude-pattern>*/.claude/*</exclude-pattern>
	<exclude-pattern>*.min.js</exclude-pattern>
	<exclude-pattern>*.min.css</exclude-pattern>

	<!-- Use WordPress Coding Standards -->
	<rule ref="WordPress">
		<!-- Allow short array syntax -->
		<exclude name="Generic.Arrays.DisallowShortArraySyntax"/>

		<!-- Don't force file comments -->
		<exclude name="Squiz.Commenting.FileComment"/>
		<exclude name="Squiz.Commenting.ClassComment"/>

		<!-- Allow namespaces -->
		<exclude name="PSR1.Classes.ClassDeclaration.MissingNamespace"/>

		<!-- Exclude deprecated sniff -->
		<exclude name="Generic.Functions.CallTimePassByReference"/>
	</rule>

	<!-- Set minimum supported PHP version -->
	<config name="minimum_supported_wp_version" value="6.6"/>
	<config name="testVersion" value="7.4-"/>

	<!-- Register custom capabilities so PHPCS doesn't flag them as unknown -->
	<rule ref="WordPress.WP.Capabilities">
		<properties>
			<property name="custom_capabilities" type="array">
				<element value="edit_tbell_pattern_blocks"/>
				<element value="delete_tbell_pattern_block"/>
				<element value="delete_tbell_pattern_blocks"/>
			</property>
		</properties>
	</rule>

	<!-- Allow namespaces for our classes -->
	<rule ref="WordPress.Files.FileName">
		<properties>
			<property name="strict_class_file_names" value="false"/>
		</properties>
		<exclude-pattern>*/includes/class-*.php</exclude-pattern>
	</rule>

	<!-- Text domain check -->
	<rule ref="WordPress.WP.I18n">
		<properties>
			<property name="text_domain" type="array">
				<element value="pattern-builder"/>
			</property>
		</properties>
	</rule>

</ruleset>