NavSweeper/phpcs.xml at main · mgiannopoulos24/NavSweeper · 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
<?xml version="1.0"?>
<ruleset name="Navsweeper Coding Standards">
	<description>PHPCS configuration for Navsweeper</description>

	<file>.</file>

    <!-- Exclude files -->
	<exclude-pattern>*/vendor/*</exclude-pattern>
	<exclude-pattern>*/tests/*</exclude-pattern>
	<exclude-pattern>*/node_modules/*</exclude-pattern>

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

	<!-- Show progress, show the error codes for each message (source). -->
	<arg value="ps" />

    <!-- Add colors -->
    <arg name="colors"/>

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

	<!-- Configs -->
	<config name="minimum_supported_wp_version" value="6.5" />
	<config name="testVersion" value="8.3-" />

    <!-- Rules -->
	<rule ref="WordPress">
		<exclude name="WordPress.PHP.DevelopmentFunctions.error_log_error_log"/>
		<exclude name="WordPress.Security.EscapeOutput.UnsafePrintingFunction"/>
	</rule>

	<!-- Include the WordPress-Extra standard. -->
	<rule ref="WordPress-Extra" />

	<!-- Let's also check that everything is properly documented. -->
	<rule ref="WordPress-Docs"/>

	<!-- Add in some extra rules from other standards. -->
	<rule ref="Generic.Commenting.Todo"/>

	<rule ref="PHPCompatibility"/>

	<exclude-pattern>scripts</exclude-pattern>

	<!-- Text Domain -->
	<rule ref="WordPress.WP.I18n">
		<properties>
			<property name="text_domain" type="array">
				<element value="navsweeper"/>
			</property>
		</properties>
	</rule>

</ruleset>