wpsteak-plugin/phpcs.xml at master · Apiki/wpsteak-plugin · 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
<?xml version="1.0"?>
<rulesetname="wpsteak">
	<description>Custom ruleset for the wpsteak plugin.</description>

<!-- For help in understanding this file: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
<!-- For help in using PHPCS: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage -->

<!-- What to scan -->
	<file>.</file>
<!-- Ignoring Files and Folders:
 https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#ignoring-files-and-folders -->
	<exclude-pattern>api-reference/</exclude-pattern>
	<exclude-pattern>dist/</exclude-pattern>
	<exclude-pattern>node_modules/</exclude-pattern>
	<exclude-pattern>resources/</exclude-pattern>
	<exclude-pattern>vendor/</exclude-pattern>
<!-- Scrutinizer dependency -->
	<exclude-pattern>wordpress/</exclude-pattern>

<!-- How to scan -->
	<argvalue="sp"/> <!-- Show sniff and progress -->
	<argname="colors"/> <!-- Show results with colors -->
	<argname="basepath"value="."/> <!-- Strip the file paths down to the relevant bit -->
	<argname="parallel"value="50"/> <!-- Enables parallel processing when available for faster results. -->
	<argname="extensions"value="php"/> <!-- Limit to PHP files -->

<!-- Rules: Check PHP version compatibility - see
 https://github.com/PHPCompatibility/PHPCompatibilityWP -->
	<ruleref="PHPCompatibilityWP"/>
<!-- For help in understanding this testVersion:
 https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions -->
	<configname="testVersion"value="7.4-"/>

<!-- Rules: WordPress Coding Standards - see
 https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards -->
	<ruleref="WordPress-Extra"><!-- Includes WordPress-Core -->
 <excludename="Generic.Arrays.DisallowShortArraySyntax"/>
 <excludename="Generic.Formatting.MultipleStatementAlignment"/>
 <excludename="WordPress.Arrays.ArrayDeclarationSpacing"/>
 <excludename="WordPress.Arrays.MultipleStatementAlignment"/>
	</rule>
<!-- For help in understanding these custom sniff properties:
 https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties -->
	<configname="minimum_supported_wp_version"value="4.9"/>

	<ruleref="WordPress.Files.FileName">
 <properties>
 <propertyname="strict_class_file_names"value="false"/>
 </properties>
 <excludename="WordPress.Files.FileName.NotHyphenatedLowercase"/>
	</rule>

	<ruleref="WordPress.WP.I18n">
 <properties>
 <propertyname="text_domain"type="array">
 <elementvalue="app"/>
 </property>
 </properties>
	</rule>

	<ruleref="SlevomatCodingStandard.Namespaces">
 <properties>
 <propertyname="namespacesRequiredToUse"type="array">
 <elementvalue="App"/>
 <elementvalue="Carbon_Fields"/>
 <elementvalue="Cedaro"/>
 <elementvalue="WPSteak"/>
 </property>
 </properties>
	</rule>

	<ruleref="SlevomatCodingStandard.Files.TypeNameMatchesFileName">
 <properties>
 <propertyname="rootNamespaces"type="array">
 <elementkey="src"value="App"/>
 <elementkey="tests"value="App\Test"/>
 </property>
 </properties>
	</rule>

	<ruleref="SlevomatCodingStandard">
 <excludename="SlevomatCodingStandard.Namespaces.FullyQualifiedGlobalConstants"/>
 <excludename="SlevomatCodingStandard.Namespaces.FullyQualifiedGlobalFunctions"/>
 <excludename="SlevomatCodingStandard.ControlStructures.NewWithoutParentheses"/>
 <excludename="SlevomatCodingStandard.Commenting.DisallowOneLinePropertyDocComment"/>
 <excludename="SlevomatCodingStandard.Functions.DisallowArrowFunction"/>
 <excludename="SlevomatCodingStandard.ControlStructures.DisallowYodaComparison"/>
 <excludename="SlevomatCodingStandard.Commenting.UselessInheritDocComment"/>
 <excludename="SlevomatCodingStandard.PHP.RequireExplicitAssertion"/>
 <excludename="SlevomatCodingStandard.Variables.DisallowSuperGlobalVariable"/>
	</rule>
</ruleset>