✨ Add SlevomatCodingStandard.Commenting.UselessInheritDocComment (#83)

Fixes #21

Author: dpi

Makefile

@@ -0,0 +1,15 @@
+check: test lint
+
+test:
+	bin/phpunit
+
+lint: codestyle static-analysis
+
+fix:
+	bin/phpcbf
+
+codestyle:
+	bin/phpcs
+
+static-analysis:
+	bin/phpstan

PreviousNextDrupal/ruleset.xml

@@ -33,6 +33,9 @@
         </properties>
     </rule>
 
+    <!-- SlevomatCodingStandard.Commenting -->
+    <rule ref="SlevomatCodingStandard.Commenting.UselessInheritDocComment" />
+
     <!-- SlevomatCodingStandard.Functions -->
     <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInCall" />
     <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration" />

README.md

@@ -131,6 +131,7 @@ function doesAThing(array $data): int {
 #### PSR2.Methods.FunctionClosingBrace.SpacingBeforeClose
 #### SlevomatCodingStandard.Classes.ClassStructure
 #### SlevomatCodingStandard.Classes.RequireMultiLineMethodSignature
+#### SlevomatCodingStandard.Commenting.UselessInheritDocComment
 #### SlevomatCodingStandard.Functions.RequireTrailingCommaInCall
 #### SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration
 #### SlevomatCodingStandard.Functions.StaticClosure

tests/Sniffs/UselessInheritDocCommentTest.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PreviousNext\CodingStandard\Tests\Sniffs;
+
+use SlevomatCodingStandard\Sniffs\Commenting\UselessInheritDocCommentSniff;
+
+/**
+ * @covers \SlevomatCodingStandard\Sniffs\Commenting\UselessInheritDocCommentSniff
+ */
+final class UselessInheritDocCommentTest extends Base {
+
+  public function testNoError(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/UselessInheritDocCommentNoError.php');
+    self::assertNoSniffErrorInFile($report);
+  }
+
+  public function testMissing(): void {
+    $report = self::checkFile(__DIR__ . '/fixtures/UselessInheritDocCommentError.php');
+    self::assertSame(1, $report->getErrorCount());
+    self::assertSniffError($report, 14, UselessInheritDocCommentSniff::CODE_USELESS_INHERIT_DOC_COMMENT);
+  }
+
+  protected static function getSniffName(): string {
+    return 'SlevomatCodingStandard.Commenting.UselessInheritDocComment';
+  }
+
+}

tests/Sniffs/fixtures/UselessInheritDocCommentError.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sniffs\fixtures;
+
+use PreviousNext\CodingStandard\Tests\Sniffs\fixtures\UselessInheritDocCommentParent;
+
+/**
+ * The class.
+ */
+final class UselessInheritDocCommentError extends UselessInheritDocCommentParent {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function foo(): void {
+    parent::foo();
+  }
+
+}

tests/Sniffs/fixtures/UselessInheritDocCommentNoError.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PreviousNext\CodingStandard\Tests\Sniffs\fixtures;
+
+/**
+ * The class.
+ */
+final class UselessInheritDocCommentNoError extends UselessInheritDocCommentParent {
+
+  /**
+   * Foo.
+   */
+  public function foo(): void {
+    parent::foo();
+  }
+
+}

tests/Sniffs/fixtures/UselessInheritDocCommentParent.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PreviousNext\CodingStandard\Tests\Sniffs\fixtures;
+
+/**
+ * The parent class.
+ */
+abstract class UselessInheritDocCommentParent {
+
+  public function foo(): void {
+  }
+
+}