ncstate-delta · jrchamp · Oct 15, 2021 · May 26, 2022 · Jul 29, 2022 · Jul 29, 2022
diff --git a/.gitmodules b/.gitmodules
@@ -6,7 +6,13 @@
 	url = https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards.git
 [submodule "PHP_CodeSniffer"]
 	path = PHP_CodeSniffer
-	url = https://github.com/squizlabs/PHP_CodeSniffer.git
-[submodule "moodle-local_codechecker"]
-	path = moodle-local_codechecker
-	url = https://github.com/moodlehq/moodle-local_codechecker.git
+	url = https://github.com/PHPCSStandards/PHP_CodeSniffer.git
+[submodule "PHPCSUtils"]
+	path = PHPCSUtils
+	url = https://github.com/PHPCSStandards/PHPCSUtils.git
+[submodule "moodle-cs"]
+	path = moodle-cs
+	url = https://github.com/moodlehq/moodle-cs.git
+[submodule "PHPCSExtra"]
+	path = PHPCSExtra
+	url = https://github.com/PHPCSStandards/PHPCSExtra.git
diff --git a/PHPCSExtra b/PHPCSExtra
diff --git a/PHPCSUtils b/PHPCSUtils
diff --git a/PHPCompatibility b/PHPCompatibility
diff --git a/PHP_CodeSniffer b/PHP_CodeSniffer
diff --git a/WordPress-Coding-Standards b/WordPress-Coding-Standards
diff --git a/delta.xml b/delta.xml
@@ -9,7 +9,7 @@
 	<arg name="parallel" value="8"/>
 
 	<!-- Load additional standards. -->
-	<config name="installed_paths" value="/misc/temp/phpcs/WordPress-Coding-Standards,/misc/temp/phpcs/PHPCompatibility" />
+	<config name="installed_paths" value="/misc/temp/phpcs/WordPress-Coding-Standards,/misc/temp/phpcs/PHPCompatibility,/misc/temp/phpcs/PHPCSUtils,/misc/temp/phpcs/PHPCSExtra" />
 
 	<!-- Exclude the Composer Vendor directory. -->
 	<exclude-pattern>/vendor/*</exclude-pattern>
@@ -20,8 +20,31 @@
 	<!-- Exclude minified Javascript files. -->
 	<exclude-pattern>*.min.js</exclude-pattern>
 
-	<!-- Include the WordPress-Extra standard. -->
-	<rule ref="WordPress-Extra">
+	<!-- Include the PSR1 standard. -->
+	<rule ref="PSR1">
+		<!-- WordPress has its own rules for these. -->
+		<exclude name="Generic.WhiteSpace.DisallowTabIndent"/>
+		<exclude name="PSR1.Classes.ClassDeclaration"/>
+		<exclude name="PSR1.Methods.CamelCapsMethodName"/>
+
+		<!-- Legacy code has lots of side effects. -->
+		<exclude name="PSR1.Files.SideEffects"/>
+	</rule>
+
+	<!-- Include the PSR12 standard. -->
+	<rule ref="PSR12">
+		<!-- WordPress has its own rules for these. -->
+		<exclude name="Generic.Files.LineLength"/>
+		<exclude name="PSR12.ControlStructures.ControlStructureSpacing"/>
+		<exclude name="PSR12.Files.FileHeader"/>
+		<exclude name="PSR2.Classes.ClassDeclaration"/>
+		<exclude name="PSR2.Methods.FunctionCallSignature"/>
+		<exclude name="Squiz.Classes.ValidClassName"/>
+		<exclude name="Squiz.Functions.MultiLineFunctionDeclaration"/>
+	</rule>
+
+	<!-- Include the WordPress standard. -->
+	<rule ref="WordPress">
 		<!--
 		We can run `phpcs` with the '-s' flag, which allows us to see the names
 		of the sniffs reporting errors. Once we know the sniff names, we can opt
@@ -36,6 +59,7 @@
 
 		<!-- File-level comments are not required. -->
 		<exclude name="Squiz.Commenting.FileComment.Missing"/>
+		<exclude name="Squiz.Commenting.FileComment.MissingPackageTag"/>
 
 		<!-- Comment alignment spacing. -->
 		<exclude name="Squiz.Commenting.FunctionComment.SpacingAfterParamType"/>
@@ -44,47 +68,46 @@
 		<!-- Add back? Double quotes only when necessary. -->
 		<exclude name="Squiz.Strings.DoubleQuoteUsage"/>
 
+		<!-- Allow increment/decrement after variable. -->
+		<exclude name="Universal.Operators.DisallowStandalonePostIncrementDecrement"/>
+
 		<!-- Add back? Hyphenated filenames. -->
 		<exclude name="WordPress.Files.FileName"/>
 
 		<!-- Add back? No assignments in while conditions. -->
 		<exclude name="WordPress.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition"/>
 
 		<!-- Add back? date() vs gmdate(). -->
-		<exclude name="WordPress.DateTime.RestrictedFunctions"/>
+		<exclude name="WordPress.DateTime"/>
 
 		<!-- No WordPress spaces. -->
+		<exclude name="Generic.WhiteSpace.ArbitraryParenthesesSpacing"/>
 		<exclude name="WordPress.Arrays.ArrayDeclarationSpacing"/>
 		<exclude name="WordPress.Arrays.ArrayKeySpacingRestrictions"/>
-		<exclude name="Generic.WhiteSpace.ArbitraryParenthesesSpacing"/>
-		<exclude name="WordPress.WhiteSpace.ControlStructureSpacing"/>
-		<exclude name="WordPress.WhiteSpace.OperatorSpacing"/>
+		<exclude name="WordPress.WhiteSpace"/>
 
 		<!-- Yoda is illogical and handled by WordPress.CodeAnalysis.AssignmentInCondition. -->
 		<exclude name="WordPress.PHP.YodaConditions"/>
 
 		<!-- WP Specific: Requires use of $wpdb. -->
-		<exclude name="WordPress.DB.RestrictedClasses"/>
-		<exclude name="WordPress.DB.RestrictedFunctions"/>
+		<exclude name="WordPress.DB"/>
 
 		<!-- WP Specific: Requires use of WP functions. -->
-		<exclude name="WordPress.Security.EscapeOutput"/>
-		<exclude name="WordPress.Security.NonceVerification"/>
-		<exclude name="WordPress.WP.AlternativeFunctions"/>
-		<exclude name="WordPress.WP.DeprecatedFunctions"/>
-		<exclude name="WordPress.WP.EnqueuedResources"/>
-		<exclude name="WordPress.WP.TimezoneChange"/>
-		<exclude name="WordPress.WP.GlobalVariablesOverride"/>
-	</rule>
+		<exclude name="WordPress.PHP.IniSet"/>
+		<exclude name="WordPress.Security"/>
 
-	<!-- Let's also check that everything is properly documented. -->
-	<rule ref="WordPress-Docs"/>
+		<!-- WP Specific: General WordPress -->
+		<exclude name="WordPress.WP"/>
+	</rule>
 
 	<!-- Check for PHP cross-version compatibility. -->
-	<config name="testVersion" value="7.1-99.0"/>
+	<config name="testVersion" value="7.2-99.0"/>
 	<rule ref="PHPCompatibility">
-		<!-- Incorrect error. -->
+		<!-- PHP 4.3 - Incorrect error. -->
 		<exclude name="PHPCompatibility.PHP.NewFunctionParameters.php_uname_modeFound"/>
+
+		<!-- PHP 8.1 - We don't care that the default flags for htmlspecialchars() has changed. Both defaults are acceptable. -->
+		<exclude name="PHPCompatibility.ParameterValues.NewHTMLEntitiesFlagsDefault.NotSet"/>
 	</rule>
 
 	<!-- No spaces around function call signature. No WordPress spaces. -->
@@ -105,9 +128,13 @@
 	<rule ref="Generic.CodeAnalysis">
 		<!-- Add back? No assignments in while conditions. -->
 		<exclude name="Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition"/>
+
+		<!-- Handled in a better way by Squiz.Commenting.EmptyCatchComment.Missing -->
+		<exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedCatch"/>
 	</rule>
 	<rule ref="Generic.Commenting"/>
 	<rule ref="Generic.Metrics"/>
+	<rule ref="Generic.PHP.Syntax"/>
 	<rule ref="Generic.Strings.UnnecessaryStringConcat">
 		<properties>
 			<property name="allowMultiline" value="true" />
@@ -148,9 +175,25 @@
 		</properties>
 	</rule>
 
+	<!-- Switch breaks are followed by newline or the switch end. -->
+	<rule ref="Squiz.ControlStructures.SwitchDeclaration">
+		<exclude name="Squiz.ControlStructures.SwitchDeclaration.BreakIndent" />
+	</rule>
+
 	<!-- Scope closing brace on own line. -->
 	<rule ref="Squiz.WhiteSpace.ScopeClosingBrace" />
 
+	<!-- Enforce arrays with commas and appropriate spaces. -->
+	<rule ref="NormalizedArrays.Arrays.ArrayBraceSpacing">
+		<properties>
+			<property name="spacesSingleLine" value="0"/>
+		</properties>
+	</rule>
+	<rule ref="NormalizedArrays.Arrays.CommaAfterLast"/>
+
+	<!-- Disallow PHP's alternative control structure syntax. -->
+	<rule ref="Universal.ControlStructures.DisallowAlternativeSyntax"/>
+
 	<!-- Forbidden functions. -->
 	<rule ref="Generic.PHP.ForbiddenFunctions">
 		<properties>

diff --git a/moodle-cs b/moodle-cs
diff --git a/moodle-local_codechecker b/moodle-local_codechecker
diff --git a/moodle.xml b/moodle.xml
@@ -9,7 +9,7 @@
 	<arg name="parallel" value="8"/>
 
 	<!-- Load additional standards. -->
-	<config name="installed_paths" value="/misc/temp/phpcs/moodle-local_codechecker" />
+	<config name="installed_paths" value="/misc/temp/phpcs/moodle-cs,/misc/temp/phpcs/PHPCompatibility,/misc/temp/phpcs/PHPCSUtils,/misc/temp/phpcs/PHPCSExtra" />
 
 	<!-- Exclude the Composer Vendor directory. -->
 	<exclude-pattern>/vendor/*</exclude-pattern>
@@ -21,14 +21,20 @@
 	<exclude-pattern>*.min.js</exclude-pattern>
 
 	<!-- Include the moodle standard. -->
-	<rule ref="moodle">
+	<rule ref="moodle-extra">
 		<!--
 		We can run `phpcs` with the '-s' flag, which allows us to see the names
 		of the sniffs reporting errors. Once we know the sniff names, we can opt
 		to exclude sniffs which don't suit our project.
 		-->
 	</rule>
 
+	<!-- Check PHP syntax. -->
+	<rule ref="Generic.PHP.Syntax"/>
+
+	<!-- We require PHP >= 7.1 which allows constant visibility -->
+	<rule ref="PSR12.Properties.ConstantVisibility"/>
+
 	<!-- Check for PHP cross-version compatibility. -->
 	<config name="testVersion" value="7.1-99.0"/>
 </ruleset>
diff --git a/phpcompatibility.sh b/phpcompatibility.sh
@@ -0,0 +1 @@
+/misc/temp/phpcs/PHP_CodeSniffer/bin/phpcs -p --colors --standard=/misc/temp/phpcs/phpcompatibility.xml --basepath=. .
diff --git a/phpcompatibility.xml b/phpcompatibility.xml
@@ -8,7 +8,7 @@
 	<!-- Check up to 8 files simultanously. -->
 	<arg name="parallel" value="8"/>
 
-	<config name="installed_paths" value="/misc/temp/phpcs/PHPCompatibility" />
+	<config name="installed_paths" value="/misc/temp/phpcs/PHPCompatibility,/misc/temp/phpcs/PHPCSUtils,/misc/temp/phpcs/PHPCSExtra" />
 
 	<!-- Exclude the Composer Vendor directory. -->
 	<exclude-pattern>/vendor/*</exclude-pattern>
@@ -19,9 +19,16 @@
 	<!-- Exclude minified Javascript files. -->
 	<exclude-pattern>*.min.js</exclude-pattern>
 
+	<!-- Check PHP syntax. -->
+	<rule ref="Generic.PHP.Syntax"/>
+
 	<!-- Check for PHP cross-version compatibility. -->
-	<config name="testVersion" value="7.1-99.0"/>
+	<config name="testVersion" value="7.0-99.0"/>
 	<rule ref="PHPCompatibility">
-		<exclude name="PHPCompatibility.PHP.NewFunctionParameters.php_uname_modeFound"/> <!-- Incorrect error -->
+		<!-- PHP 4.3 - Incorrect error. -->
+		<exclude name="PHPCompatibility.PHP.NewFunctionParameters.php_uname_modeFound"/>
+
+		<!-- PHP 8.1 - We don't care that the default flags for htmlspecialchars() has changed. Both defaults are acceptable. -->
+		<exclude name="PHPCompatibility.ParameterValues.NewHTMLEntitiesFlagsDefault.NotSet"/>
 	</rule>
 </ruleset>
diff --git a/run_phpcs.php b/run_phpcs.php
@@ -12,12 +12,8 @@
 		if (is_readable($path)) {
 			echo $filename . PHP_EOL;
 			passthru("phpcs -p --colors --standard=$phpcs_dir/phpcompatibility.xml --report=json --report-file=$phpcs_dir/output/$filename.json --basepath=$path $path");
-		}
-		else {
+		} else {
 			echo 'ERROR: Folder not readable - ' . $path . PHP_EOL;
 		}
 	}
-	else {
-		//echo 'ERROR: Folder does not exist - ' . $path . PHP_EOL;
-	}
 }
diff --git a/wp.xml b/wp.xml
@@ -2,14 +2,11 @@
 <ruleset name="DELTA-WordPress-Development">
 	<description>A custom set of rules based on WordPress project</description>
 
-	<!-- Only scan PHP files. -->
-	<arg name="extensions" value="php"/>
-
 	<!-- Check up to 8 files simultanously. -->
 	<arg name="parallel" value="8"/>
 
 	<!-- Load additional standards. -->
-	<config name="installed_paths" value="/misc/temp/phpcs/WordPress-Coding-Standards,/misc/temp/phpcs/PHPCompatibility" />
+	<config name="installed_paths" value="/misc/temp/phpcs/WordPress-Coding-Standards,/misc/temp/phpcs/PHPCompatibility,/misc/temp/phpcs/PHPCSUtils,/misc/temp/phpcs/PHPCSExtra" />
 
 	<!-- Exclude the Composer Vendor directory. -->
 	<exclude-pattern>/vendor/*</exclude-pattern>
@@ -20,29 +17,30 @@
 	<!-- Exclude minified Javascript files. -->
 	<exclude-pattern>*.min.js</exclude-pattern>
 
-	<!-- Include the WordPress-Extra standard. -->
-	<rule ref="WordPress-Extra"/>
-
-	<!-- Let's also check that everything is properly documented. -->
-	<rule ref="WordPress-Docs"/>
+	<!-- Include the WordPress standard. -->
+	<rule ref="WordPress"/>
 
 	<!-- This rule is not part of the standard, but is used by WPCS natively. -->
 	<rule ref="PSR2.Methods.FunctionClosingBrace"/>
 
 	<!-- Check for PHP cross-version compatibility. -->
 	<config name="testVersion" value="5.6-99.0"/>
 	<rule ref="PHPCompatibility">
-		<!-- Incorrect error. -->
+		<!-- PHP 4.3 - Incorrect error. -->
 		<exclude name="PHPCompatibility.PHP.NewFunctionParameters.php_uname_modeFound"/>
 
 		<!-- Only applies to PHP 5.6.16 and older. -->
 		<exclude name="PHPCompatibility.PHP.NewConstants.mysqli_client_ssl_dont_verify_server_certFound"/>
+
+		<!-- PHP 8.1 - We don't care that the default flags for htmlspecialchars() has changed. Both defaults are acceptable. -->
+		<exclude name="PHPCompatibility.ParameterValues.NewHTMLEntitiesFlagsDefault.NotSet"/>
 	</rule>
 
 	<!-- Code quality. -->
 	<rule ref="Generic.CodeAnalysis"/>
 	<rule ref="Generic.Commenting"/>
 	<rule ref="Generic.Metrics"/>
+	<rule ref="Generic.PHP.Syntax"/>
 	<rule ref="Generic.Strings.UnnecessaryStringConcat">
 		<properties>
 			<property name="allowMultiline" value="true" />
@@ -64,10 +62,6 @@
 		<exclude name="Squiz.Commenting.FunctionComment.SpacingAfterParamType"/>
 		<exclude name="Squiz.Commenting.FunctionComment.SpacingAfterParamName"/>
 	</rule>
-	<rule ref="Squiz.Commenting.InlineComment">
-		<!-- Add back? Requires either a period, question mark or exclamation point, but that's too restrictive (e.g. URLs). -->
-		<exclude name="Squiz.Commenting.InlineComment.InvalidEndChar" />
-	</rule>
 	<rule ref="Squiz.Commenting.VariableComment"/>
 
 	<!-- Override statement alignment to have a single space. -->
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		/misc/temp/phpcs/PHP_CodeSniffer/bin/phpcs -p --colors --standard=/misc/temp/phpcs/phpcompatibility.xml --basepath=. .