wedocs-plugin/phpcs.xml.dist at develop · arifulhoque7/wedocs-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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<?xml version="1.0"?>
<ruleset name="WordPress Coding Standards for weDocs">
	<description>Generally-applicable sniffs for WordPress plugins.</description>

	<!-- What to scan -->
    <file>.</file>
    <exclude-pattern>*/.git/*</exclude-pattern>
    <exclude-pattern>*/assets/*</exclude-pattern>
    <exclude-pattern>*/src/*</exclude-pattern>
    <exclude-pattern>*/build/*</exclude-pattern>
    <exclude-pattern>*/node_modules/*</exclude-pattern>
    <exclude-pattern>*/vendor/*</exclude-pattern>
    <exclude-pattern>*/tests/*</exclude-pattern>
    <!-- Developer tooling, not shipped plugin runtime: the WordPress sniffs for
         global prefixes, WP_Filesystem and system calls do not apply to a CLI
         script. WPUF excludes this directory for the same reason. -->
    <exclude-pattern>*/bin/*</exclude-pattern>
    <exclude-pattern>*.js</exclude-pattern>
    <exclude-pattern>*.mo</exclude-pattern>
    <exclude-pattern>*.po</exclude-pattern>
    <exclude-pattern>*.css</exclude-pattern>
    <exclude-pattern>*.scss</exclude-pattern>
    <exclude-pattern>languages/*</exclude-pattern>

	<!-- How to scan -->
	<!-- Usage instructions: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage -->
	<!-- Annotated ruleset: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml -->
	<arg value="sp"/> <!-- Show sniff and progress -->
	<arg name="basepath" value="./"/><!-- Strip the file paths down to the relevant bit -->
	<arg name="colors"/>
	<arg name="extensions" value="php"/>
	<arg name="parallel" value="8"/><!-- Enables parallel processing when available for faster results. -->

	<!-- Rules: Check PHP version compatibility -->
	<!-- https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions -->
	<config name="testVersion" value="7.4-"/>
	<!-- https://github.com/PHPCompatibility/PHPCompatibilityWP -->
	<rule ref="PHPCompatibilityWP"/>

	<!-- Rules: WordPress Coding Standards -->
	<!-- https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards -->
	<!-- https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties -->
	<config name="minimum_supported_wp_version" value="6.6"/>
    <rule ref="WordPress-Core"/>
	<rule ref="WordPress">
        <!-- House style is four spaces. Enforcing tabs would rewrite every line
             in the plugin and throw away the blame history. -->
        <exclude name="Generic.WhiteSpace.DisallowSpaceIndent"/>
        <!-- The whitespace-inside-parens family. phpcbf cannot fix these safely
             here: its fixers write TABS regardless of ScopeIndent tabIndent, so
             running it on this space-indented codebase produces mixed
             indentation (measured: 706 new tab-indented lines). Excluded so the
             gate reports defects a human can act on rather than 3,771 findings
             nobody can auto-fix. -->
        <exclude name="PEAR.Functions.FunctionCallSignature"/>
        <exclude name="WordPress.WhiteSpace.ControlStructureSpacing"/>
        <exclude name="NormalizedArrays.Arrays.ArrayBraceSpacing"/>
        <exclude name="Squiz.ControlStructures.ControlSignature"/>
        <exclude name="WordPress.Arrays.ArrayDeclarationSpacing"/>
        <exclude name="Squiz.WhiteSpace.SuperfluousWhitespace"/>
        <exclude name="WordPress.WhiteSpace.OperatorSpacing"/>
        <exclude name="Generic.WhiteSpace.ArbitraryParenthesesSpacing"/>
        <exclude name="Generic.WhiteSpace.ScopeIndent"/>
        <exclude name="Squiz.Functions.FunctionDeclarationArgumentSpacing"/>
        <exclude name="WordPress.Arrays.ArrayKeySpacingRestrictions"/>
	</rule>
	<rule ref="WordPress.WP.I18n">
		<properties>
            <property name="text_domain" type="array">
                <element value="wedocs"/>
            </property>
        </properties>
	</rule>
	<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
		<properties>
			<property name="prefixes" type="array">
				<element value="wedocs"/>
				<element value="WeDevs\WeDocs"/>
			</property>
		</properties>
	</rule>
    <rule ref="Squiz.Commenting">
		<severity>0</severity>
	</rule>
	<rule ref="Generic.Commenting.DocComment.SpacingBeforeTags">
		<severity>0</severity>
	</rule>
	<!-- Classes are PSR-4 autoloaded, so WPCS file naming does not apply. -->
	<rule ref="WordPress.Files.FileName">
		<severity>0</severity>
	</rule>
	<rule ref="WordPress.PHP.DevelopmentFunctions">
		<severity>0</severity>
	</rule>
	<rule ref="WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid">
		<severity>0</severity>
	</rule>
	<rule ref="WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned">
		<severity>0</severity>
	</rule>
	<rule ref="Generic.Formatting.MultipleStatementAlignment.NotSameWarning">
		<severity>0</severity>
	</rule>
	<rule ref="Generic.Commenting.DocComment.MissingShort">
		<severity>0</severity>
	</rule>
	<rule ref="WordPress.PHP.YodaConditions.NotYoda">
		<severity>0</severity>
	</rule>
	<rule ref="Generic.Functions.OpeningFunctionBraceKernighanRitchie.ContentAfterBrace">
		<severity>0</severity>
	</rule>
	<rule ref="WordPress.DB.DirectDatabaseQuery.NoCaching">
		<severity>0</severity>
	</rule>
	<rule ref="WordPress.DB.DirectDatabaseQuery.DirectQuery">
		<severity>0</severity>
	</rule>
	<rule ref="WordPress.DB.PreparedSQL.NotPrepared">
		<type>warning</type>
	</rule>
	<rule ref="WordPress.PHP.StrictInArray.MissingTrueStrict">
		<type>error</type>
	</rule>
	<!-- Short array syntax is the house style. -->
	<rule ref="Generic.Arrays.DisallowShortArraySyntax">
		<severity>0</severity>
	</rule>
	<rule ref="Universal.Arrays.DisallowShortArraySyntax">
		<severity>0</severity>
	</rule>

	<!-- Deliberate divergence from the WPUF rulesets, which silence this one:
	     escaping stays ON. It is the sniff that caught the unescaped output in
	     the Elementor widgets PR, and silencing it is how that ships unnoticed. -->
	<rule ref="WordPress.Security.EscapeOutput.OutputNotEscaped">
		<type>error</type>
	</rule>
</ruleset>