NoUselessCommentFixer - Introduction

.php_cs.dist

@@ -53,6 +53,7 @@ $config = PhpCsFixer\Config::create()
         'no_unneeded_final_method' => true,
         'no_unreachable_default_argument_value' => true,
         'no_unset_on_property' => true,
+        'no_useless_comment' => true,
         'no_useless_else' => true,
         'no_useless_return' => true,
         'ordered_class_elements' => true,

README.rst

@@ -1150,6 +1150,10 @@ Choose from the list of available rules:
 
   Unused ``use`` statements must be removed.
 
+* **no_useless_comment**
+
+  There must be no comment like "Class Foo".
+
 * **no_useless_else**
 
   There should not be useless ``else`` cases.

src/ConfigInterface.php

@@ -87,8 +87,6 @@ public function getPhpExecutable();
     public function getRiskyAllowed();
 
     /**
-     * Get rules.
-     *
      * Keys of array are names of fixers/sets, values are true/false.
      *
      * @return array
@@ -174,8 +172,6 @@ public function setPhpExecutable($phpExecutable);
     public function setRiskyAllowed($isRiskyAllowed);
 
     /**
-     * Set rules.
-     *
      * Keys of array are names of fixers or sets.
      * Value for set must be bool (turn it on or off).
      * Value for fixer may be bool (turn it on or off) or array of configuration

src/Fixer/Comment/NoUselessCommentFixer.php

@@ -0,0 +1,115 @@
+<?php
+
+/*
+ * This file is part of PHP CS Fixer.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace PhpCsFixer\Fixer\Comment;
+
+use PhpCsFixer\AbstractFixer;
+use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\Preg;
+use PhpCsFixer\Tokenizer\Token;
+use PhpCsFixer\Tokenizer\Tokens;
+
+/**
+ * @author Kuba Werłos <werlos@gmail.com>
+ */
+final class NoUselessCommentFixer extends AbstractFixer
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function getDefinition()
+    {
+        return new FixerDefinition(
+            'There must be no comment like "Class Foo".',
+            [
+                new CodeSample('<?php
+/**
+ * Class Foo
+ * Class to do something
+ */
+class Foo {}
+'),
+                new CodeSample('<?php
+class Foo {
+    /**
+     * Get bar
+     */
+    function getBar() {
+        return "bar";
+    }
+}
+'),
+            ]
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isCandidate(Tokens $tokens)
+    {
+        return $tokens->isAnyTokenKindsFound([T_COMMENT, T_DOC_COMMENT]);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getPriority()
+    {
+        // must be run before NoEmptyCommentFixer, NoEmptyPhpdocFixer, PhpdocTrimConsecutiveBlankLineSeparationFixer and PhpdocTrimFixer
+        return 6;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function applyFix(\SplFileInfo $file, Tokens $tokens)
+    {
+        foreach ($tokens as $index => $token) {
+            if (!$token->isGivenKind([T_COMMENT, T_DOC_COMMENT])) {
+                continue;
+            }
+
+            $nextIndex = $tokens->getTokenNotOfKindSibling(
+                $index,
+                1,
+                [[T_WHITESPACE], [T_COMMENT], [T_DOC_COMMENT], [T_ABSTRACT], [T_FINAL], [T_PUBLIC], [T_PROTECTED], [T_PRIVATE], [T_STATIC]]
+            );
+            if (null === $nextIndex) {
+                continue;
+            }
+
+            if ($tokens[$nextIndex]->isGivenKind([T_CLASS, T_INTERFACE, T_TRAIT])) {
+                $newContent = Preg::replace(
+                    '/((^|\R)\h*(#|\/*\**))\h*\b(Class|Interface|Trait)\h+[A-Za-z0-9\\\\_]+\.?(\h*\R\h*\*?|\h*$)/i',
+                    '$1',
+                    $token->getContent()
+                );
+            } elseif ($tokens[$nextIndex]->isGivenKind(T_FUNCTION)) {
+                $newContent = Preg::replace(
+                    '/((^|\R)\h*(#|\/*\**))\h*\b((Gets?|SetS?)\h+[A-Za-z0-9\\\\_]+|[A-Za-z0-9\\\\_]+\h+constructor)\.?(\h*\R\h*\*?|\h*$)/i',
+                    '$1',
+                    $token->getContent()
+                );
+            } else {
+                continue;
+            }
+
+            if ($newContent === $token->getContent()) {
+                continue;
+            }
+
+            $tokens[$index] = new Token([$token->getId(), $newContent]);
+        }
+    }
+}

src/Fixer/ConfigurableFixerInterface.php

@@ -23,8 +23,6 @@
 interface ConfigurableFixerInterface extends FixerInterface
 {
     /**
-     * Set configuration.
-     *
      * New configuration must override current one, not patch it.
      * Using `null` makes fixer to use default configuration (or reset configuration from previously configured back
      * to default one).

tests/AutoReview/FixerFactoryTest.php

@@ -146,6 +146,10 @@ public function provideFixersPriorityCases()
             [$fixers['no_unused_imports'], $fixers['blank_line_after_namespace']],
             [$fixers['no_unused_imports'], $fixers['no_extra_blank_lines']],
             [$fixers['no_unused_imports'], $fixers['no_leading_import_slash']],
+            [$fixers['no_useless_comment'], $fixers['no_empty_comment']],
+            [$fixers['no_useless_comment'], $fixers['no_empty_phpdoc']],
+            [$fixers['no_useless_comment'], $fixers['phpdoc_trim']],
+            [$fixers['no_useless_comment'], $fixers['phpdoc_trim_consecutive_blank_line_separation']],
             [$fixers['no_useless_else'], $fixers['braces']],
             [$fixers['no_useless_else'], $fixers['combine_consecutive_unsets']],
             [$fixers['no_useless_else'], $fixers['no_extra_blank_lines']],