Why does rector remove code comments?

[alexanderschnitzler]

Question

Sorry to bother you but after upgrading to rector 0.7.0 I have a different behavior processing files.
It seems that all comments that are formatted like doc blocks and which are not associated with a structure like a property or method are removed and I don't know what rule is causing this exactly.

I am running the php53 set only in this example.

Is it possible to print out which rule(rector) is responsible for a change?

$ ~/Development/TYPO3-development/TYPO3.CMS ±master⚡ » rector process typo3/sysext/backend/Classes/Clipboard/Clipboard.php -vvv --debug --set=php53
File "/home/alexander/Development/TYPO3-development/TYPO3.CMS/vendor/autoload.php" is about to be loaded in "AutoloadIncluder::includeCwdVendorAutoloadIfExists()" on line 63"
File "/home/alexander/composer-packages/rector/rector/vendor/rector/rector/../../autoload.php" is about to be loaded in "AutoloadIncluder::autoloadProjectAutoloaderFile()" on line 95"
File "/home/alexander/Development/TYPO3-development/TYPO3.CMS/vendor/autoload.php" is about to be loaded in "AutoloadIncluder::includeCwdVendorAutoloadIfExists()" on line 63"
File "/home/alexander/composer-packages/rector/rector/vendor/rector/rector/../../autoload.php" is about to be loaded in "AutoloadIncluder::autoloadProjectAutoloaderFile()" on line 95"
Rector v0.7.0
Config file: rector.yml

[parsing] typo3/sysext/backend/Classes/Clipboard/Clipboard.php
[refactoring] typo3/sysext/backend/Classes/Clipboard/Clipboard.php
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\FuncCall\DirNameFileConstantToDirConstantRector
    [applying] Rector\Php53\Rector\Ternary\TernaryToElvisRector
[printing] typo3/sysext/backend/Classes/Clipboard/Clipboard.php


1 file with changes
===================

1) typo3/sysext/backend/Classes/Clipboard/Clipboard.php

    ---------- begin diff ----------
--- Original
+++ New
@@ -1002,11 +1002,6 @@
         return $CMD;
     }

-    /*****************************************
-     *
-     * FOR USE IN tce_file.php:
-     *
-     ****************************************/
     /**
      * Applies the proper paste configuration in the $file array send to tce_file.php.
      * The current pad is pasted
    ----------- end diff -----------

[fsok]

I also noticed that version 0.7.0 reformats and removes comments.

Example: https://getrector.org/demo/aef2b6e0-d366-4b7e-83be-463003645d8b

[TomasVotruba]

Failing PR with simple test case is needed

[alexanderschnitzler]

So, does it mean that this is a bug and not intended behavior? And I guess this folder is just the right place to put a new test? https://github.com/rectorphp/rector/tree/master/tests/Issues

[TomasVotruba]

Yes, this should not happen.

Location sounds good!

[fsok]

#2867

[alexanderschnitzler]

Ah, thanks @fsok for taking care. :)

[afilina]

I don't understand why this ticket was closed or why the PR got merged. There are several tests failing in the pipeline specifically regarding comments. The comments are still being stripped in the new version.

https://github.com/rectorphp/rector/runs/449302535

[alexanderschnitzler]

If I understand correctly, the PR of @fsok only added the failing tests and @TomasVotruba solved the failing tests with #2869.

[afilina]

You are correct. It's a very weird approach but I'll accept that the final PR was actually correct. I'm still getting tons of stripped comments since 0.7.0, but my scenarios are different.

[afilina]

Is there any way to extend the PrettyPrinter so that I can at least add a workaround for getting the comments back into place, on top of statements? I have dozens of custom rectors now completely failing because of this bug.