Merge pull request #837 from wmde/mediawiki-codesniffer

Replace wikibase-codesniffer with mediawiki-codesniffer

Author: rosalieper

.phpcs.xml

@@ -1,11 +1,39 @@
 <?xml version="1.0"?>
 <ruleset>
-	<rule ref="./vendor/wikibase/wikibase-codesniffer/Wikibase" />
 
-	<rule ref="Generic.Files.LineLength">
-		<properties>
-			<property name="lineLimit" value="120" />
-		</properties>
+	<!-- This rule set includes all rules from the MediaWiki rule set, see
+		https://github.com/wikimedia/mediawiki-tools-codesniffer/blob/master/MediaWiki/ruleset.xml
+		-->
+	<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
+
+		<!-- The function comment sniff is way to rigorous about way to many details that need
+			exceptions:
+			* It complains about missing documentation on fully self-explanatory function headers
+			  with strict type hints.
+			* It complains about missing documentation if there is a proper @see tag.
+			* It complains about duplicate spaces in "@param <type>  $<var>", but removing these
+			  doesn't make the code easier to read.
+			* It does not understand "@param <type> [$optional,…]. -->
+		<exclude name="MediaWiki.Commenting.FunctionComment" />
+
+		<exclude name="MediaWiki.Commenting.PropertyDocumentation.MissingDocumentationPrivate" />
+		<exclude name="MediaWiki.Commenting.PropertyDocumentation.MissingDocumentationProtected" />
+
+		<!-- We disagree with the idea of certain characters making comments "illegal" and blocking
+			patches from being merged. This behaves especially bad on code examples. -->
+		<exclude name="MediaWiki.Commenting.IllegalSingleLineComment" />
+
+		<!-- Starting a function's body with an empty line can be helpful after a very large header.
+			The code is not guaranteed to be easier to read if this is disallowed. -->
+		<exclude name="MediaWiki.WhiteSpace.DisallowEmptyLineFunctions" />
+
+		<!-- Even if we encourage to use a space in "function ()", we don't think this sniff should
+			block patches from being merged. -->
+		<exclude name="MediaWiki.WhiteSpace.SpaceAfterClosure" />
+
+		<!-- Even if we encourage to use spaces in comments, we don't think this sniff should block
+			patches from being merged. -->
+		<exclude name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment" />
 	</rule>
 
 	<!-- Metrics are intentionally not part of the base Wikibase CodeSniffer rule set. -->

composer.json

@@ -35,7 +35,7 @@
 		"ockcyp/covers-validator": "~1.1",
 		"phpmd/phpmd": "~2.6",
 		"phpunit/phpunit": "~8.0",
-		"wikibase/wikibase-codesniffer": "~1.2.0"
+		"mediawiki/mediawiki-codesniffer": "33.0.0"
 	},
 	"autoload": {
 		"psr-4": {

src/Statement/Statement.php

@@ -6,7 +6,6 @@
 use InvalidArgumentException;
 use Wikibase\DataModel\Entity\PropertyId;
 use Wikibase\DataModel\PropertyIdProvider;
-use Wikibase\DataModel\Reference;
 use Wikibase\DataModel\ReferenceList;
 use Wikibase\DataModel\Snak\Snak;
 use Wikibase\DataModel\Snak\SnakList;
@@ -55,7 +54,7 @@ class Statement implements Comparable, PropertyIdProvider {
 	private $references;
 
 	/**
-	 * @var integer, element of the Statement::RANK_ enum
+	 * @var int element of the Statement::RANK_ enum
 	 */
 	private $rank = self::RANK_NORMAL;