Merge pull request #2097 from WordPress/feature/core-move-rules-inclu…

…de-require-from-extra Core: move rules related to include/require statements from `Extra` to `Core`
WordPress · Oct 28, 2022 · a47e644 · a47e644
2 parents 81d479c + e13cb6c
commit a47e644
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 17 deletions.
diff --git a/WordPress-Core/ruleset.xml b/WordPress-Core/ruleset.xml
@@ -64,6 +64,31 @@
 		 https://github.com/WordPress/WordPress-Coding-Standards/issues/527 -->
 
 
+	<!--
+	#############################################################################
+	Handbook: General - Writing include/require statements.
+	Ref: https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/#single-and-double-quotes
+	#############################################################################
+	-->
+
+	<!-- Covers rule: include[_once] and require[_once] are language constructs, they do
+		 not need parentheses around the path, so those shouldn't be used. -->
+	<rule ref="PEAR.Files.IncludingFile.BracketsNotRequired"/>
+
+	<!-- Covers rule: There should only be one space between the path and the include/require keywords.
+		 Note: the sniff covers more language constructs than just include/require. While not in the handbook,
+		 WP Core already complies with this, so we may as well enforce it.  -->
+	<rule ref="Generic.WhiteSpace.LanguageConstructSpacing"/>
+
+	<!-- Covers rule: It is strongly recommended to use require[_once] for unconditional includes. -->
+	<rule ref="PEAR.Files.IncludingFile.UseRequire">
+		<type>warning</type>
+	</rule>
+	<rule ref="PEAR.Files.IncludingFile.UseRequireOnce">
+		<type>warning</type>
+	</rule>
+
+
 	<!--
 	#############################################################################
 	Handbook: Naming - Naming Conventions.

diff --git a/WordPress-Extra/ruleset.xml b/WordPress-Extra/ruleset.xml
@@ -35,23 +35,6 @@
 		 https://github.com/WordPress/WordPress-Coding-Standards/pull/809 -->
 	<rule ref="Squiz.PHP.DisallowSizeFunctionsInLoops"/>
 
-	<!-- And yet more best practices.
-		 https://github.com/WordPress/WordPress-Coding-Standards/issues/1143 -->
-	<rule ref="PEAR.Files.IncludingFile.BracketsNotRequired">
-		<type>warning</type>
-	</rule>
-	<rule ref="PEAR.Files.IncludingFile.UseRequire">
-		<type>warning</type>
-	</rule>
-	<rule ref="PEAR.Files.IncludingFile.UseRequireOnce">
-		<type>warning</type>
-	</rule>
-
-	<!-- Check correct spacing of language constructs. This also ensures that the
-		 above rule for not using brackets with require is fixed correctly.
-		 https://github.com/WordPress/WordPress-Coding-Standards/issues/1153 -->
-	<rule ref="Generic.WhiteSpace.LanguageConstructSpacing"/>
-
 	<!-- Check that functions use all parameters passed.
 		 https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/pull/xxx -->
 	<rule ref="Generic.CodeAnalysis.UnusedFunctionParameter">