Merge pull request #364 from Yoast/JRF/yoastcs-more-docblock-comment-…

…rules

YoastCS: more docblock/comment rules

Yoast/Reports/Threshold.php

@@ -21,6 +21,7 @@
  * @since 2.2.0
  *
  * @phpcs:disable VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- Flags unused params which are required via the interface. Invalid.
+ * @phpcs:disable SlevomatCodingStandard.TypeHints.DisallowMixedTypeHint.DisallowedMixedTypeHint -- Type is too complex to document properly.
  */
 final class Threshold implements Report {
 

Yoast/ruleset.xml

@@ -317,6 +317,82 @@
 	SNIFFS RELATED TO COMMENTS AND DOCBLOCKS
 	#############################################################################
 	-->
+	<!-- Undo the WPCS-Docs silencing of the @param tag formatting/alignment and grammar/punctuation rules. -->
+	<rule ref="Squiz.Commenting.FunctionComment.SpacingAfterParamName">
+		<severity>5</severity>
+	</rule>
+	<rule ref="Squiz.Commenting.FunctionComment.ParamCommentNotCapital">
+		<severity>5</severity>
+	</rule>
+
+	<!-- Undo the WPCS-Docs silencing of some @return tag related rules. -->
+	<rule ref="Squiz.Commenting.FunctionComment.MissingReturn">
+		<severity>5</severity>
+	</rule>
+	<rule ref="Squiz.Commenting.FunctionComment.InvalidReturnNotVoid">
+		<severity>5</severity>
+	</rule>
+
+	<!-- Enforces using shorthand scalar typehint variants. -->
+	<rule ref="SlevomatCodingStandard.TypeHints.LongTypeHints"/>
+
+	<!-- Enforces null type hint on last position. -->
+	<rule ref="SlevomatCodingStandard.TypeHints.NullTypeHintOnLastPosition"/>
+
+	<!-- Check property type information, but don't enforce native type declarations. -->
+	<rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint">
+		<properties>
+			<!-- PHP 7.4+. -->
+			<property name="enableNativeTypeHint" value="false"/>
+			<!-- PHP 8.0+. -->
+			<property name="enableMixedTypeHint" value="false"/>
+			<property name="enableUnionTypeHint" value="false"/>
+			<!-- PHP 8.1+. -->
+			<property name="enableIntersectionTypeHint" value="false"/>
+			<!-- PHP 8.2+. -->
+			<property name="enableStandaloneNullTrueFalseTypeHints" value="false"/>
+		</properties>
+	</rule>
+
+	<!-- Check parameter type information, but don't enforce native type declarations. -->
+	<rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint">
+		<properties>
+			<!-- PHP 8.0+. -->
+			<property name="enableMixedTypeHint" value="false"/>
+			<property name="enableUnionTypeHint" value="false"/>
+			<!-- PHP 8.1+. -->
+			<property name="enableIntersectionTypeHint" value="false"/>
+			<!-- PHP 8.2+. -->
+			<property name="enableStandaloneNullTrueFalseTypeHints" value="false"/>
+		</properties>
+
+		<exclude name="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint"/>
+	</rule>
+
+	<!-- Check return type information, but don't enforce native type declarations. -->
+	<rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint">
+		<properties>
+			<!-- PHP 8.0+. -->
+			<property name="enableStaticTypeHint" value="false"/>
+			<property name="enableMixedTypeHint" value="false"/>
+			<property name="enableUnionTypeHint" value="false"/>
+			<!-- PHP 8.1+. -->
+			<property name="enableIntersectionTypeHint" value="false"/>
+			<property name="enableNeverTypeHint" value="false"/>
+			<!-- PHP 8.2+. -->
+			<property name="enableStandaloneNullTrueFalseTypeHints" value="false"/>
+		</properties>
+
+		<exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint"/>
+		<exclude name="SlevomatCodingStandard.TypeHints.ReturnTypeHint.UselessAnnotation"/>
+	</rule>
+
+	<!-- Disallows usage of "mixed" type hint. -->
+	<rule ref="SlevomatCodingStandard.TypeHints.DisallowMixedTypeHint">
+		<!-- Make an exception for the tests as "mixed" is a valid type for testing type validation in code. -->
+		<exclude-pattern>*/tests/*\.php$</exclude-pattern>
+	</rule>
+
 	<!-- CS: don't allow "// end class" comments and the likes. -->
 	<rule ref="PSR12.Classes.ClosingBrace"/>