plugin/ruleset.xml at master · code-atlantic/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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<?xml version="1.0"?>
<ruleset name="WordPress Coding Standards for Plugin">
	<description>Sniffs for WordPress plugins</description>

	<rule ref="PHPCompatibilityWP"/>
	<config name="testVersion" value="5.6-"/>

	<rule ref="WordPress-Extra"/>
	<rule ref="WordPress-Docs"/>
	<rule ref="WordPress.WP.I18n"/>

	<!-- <rule ref="VariableAnalysis.CodeAnalysis.VariableAnalysis">
		<properties>
			<property name="allowUnusedParametersBeforeUsed" value="true"/>
		</properties>
	</rule>
	<rule ref="WordPress.CodeAnalysis.EmptyStatement"/> -->

	<!-- <rule ref="PEAR.Functions.FunctionCallSignature">
		<properties>
			<property name="allowMultipleArguments" value="false"/>
		</properties>
	</rule> -->

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

	<arg name="extensions" value="php"/>

	<file>./classes</file>
	<file>./includes</file>
	<file>./packages</file>
	<file>./tests</file>
	<file>./popup-maker-popup-analytics.php</file>

  <!-- Exclude these -->
  <exclude-pattern>*/vendor/*</exclude-pattern>
  <exclude-pattern>*/tests/*</exclude-pattern>
  <exclude-pattern>*.js</exclude-pattern>

	<!-- Temporary due to usage of CONSTANT like names for core variables. -->
	<rule ref="WordPress.NamingConventions.ValidVariableName.PropertyNotSnakeCase">
		<exclude-pattern>*</exclude-pattern>
	</rule>

	<!-- Allow short syntax arrays. -->
	<rule ref="Generic.Arrays.DisallowShortArraySyntax.Found">
		<exclude-pattern>*</exclude-pattern>
	</rule>

	<!-- Allow PSR file name & class names. -->
	<rule ref="WordPress.Files.FileName.NotHyphenatedLowercase">
		<exclude-pattern>*</exclude-pattern>
	</rule>

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

  <rule ref="WordPress-Core">
      <exclude name="WordPress.Files.FileName.InvalidClassFileName" />
      <exclude name="WordPress.Files.FileName.NotHyphenatedLowercase" />
  </rule>
  <rule ref="WordPress">
      <!-- <exclude name="WordPress.Files.FileName" /> -->
      <exclude name="WordPress.Files.FileName.InvalidClassFileName" />
      <exclude name="WordPress.Files.FileName.NotHyphenatedLowercase" />
      <exclude name="WordPress.NamingConventions.ValidVariableName" />
      <exclude name="WordPress.WP.I18n.NonSingularStringLiteralText" />
      <exclude name="WordPress.PHP.NoSilencedErrors.Discouraged" />
      <exclude name="WordPress.PHP.DisallowShortTernary.Found" />
  </rule>

  <!-- Enforce space before closing parenthesis -->
  <rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing.SpacingBeforeClose">
      <severity>5</severity>
  </rule>

	<!-- Do not require docblocks for unit tests -->
	<!-- <rule ref="Squiz.Commenting.FunctionComment.Missing">
		<exclude-pattern>phpunit/*</exclude-pattern>
	</rule>
	<rule ref="Squiz.Commenting.FileComment.Missing">
		<exclude-pattern>phpunit/*</exclude-pattern>
	</rule>
	<rule ref="Squiz.Commenting.ClassComment.Missing">
		<exclude-pattern>phpunit/*</exclude-pattern>
	</rule>
	<rule ref="Squiz.Commenting.ClassComment.SpacingAfter">
		<exclude-pattern>phpunit/*</exclude-pattern>
	</rule>
	<rule ref="Squiz.Commenting.FunctionComment.MissingParamTag">
		<exclude-pattern>phpunit/*</exclude-pattern>
	</rule>
	<rule ref="Generic.Commenting.DocComment.Empty">
    	<exclude-pattern>phpunit/*</exclude-pattern>
    </rule>
	<rule ref="Generic.Commenting.DocComment.MissingShort">
		<exclude-pattern>phpunit/*</exclude-pattern>
	</rule>
	<rule ref="Squiz.Commenting.VariableComment.Missing">
		<exclude-pattern>phpunit/*</exclude-pattern>
	</rule>
	<rule ref="Squiz.Commenting.FunctionCommentThrowTag.Missing">
		<exclude-pattern>phpunit/*</exclude-pattern>
	</rule> -->
</ruleset>