Add "--only" option to process only a single rule

[cweiske]

The option for the "process" and "list-rules" commands applies the single given rule only, without needing to modify the configuration file.

The option value must be a fully classified class name:

  --only="Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector"

A hint is given when the user forgot to escape the backslashes.

---

It is impossible to modify the injected "$rectors" after the command line configuration is parsed, so I had to introduce the ConfigurationRuleFilter singleton.

Since both ListRulesCommand and ProcessCommand make use of the ConfigurationRuleFilter - but list-rules does not have a Configuration - I had to make the filterOnlyRule() method public to prevent code duplication.

Resolves rectorphp/rector#8899

---

Test it:

./bin/rector process --config=e2e/applied-rule-return-array-nodes/rector.php --dry-run --only="Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector"

./bin/rector list-rules --config=e2e/applied-rule-return-array-nodes/rector.php --only="Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector"

[TomasVotruba]

There should be kind of e2e tests that passes and that fails if data are incorrect

[cweiske]

I've added an end-to-end test that fails when e.g. the ConfigurationRuleFilter simply returns all rectors instead of filtering them.

I had to extend the e2eTestRunner to support additional command line options.

[samsonasik]

Register new e2e path to

rector-src/.github/workflows/e2e.yaml

Line 26 in 37226f1

directory:

[cweiske]

e2e-test is registered.

[cweiske]

Code is adjusted.
I also tested it in the windows cmd.exe, and it works:

[cweiske]

Class name quoting on Linux

How to input backslashes in a terminal (bash)

Works

• Double quotes + single backslash --only="Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector"
• Double quotes + double backslash --only="Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodRector"
• Single quotes + single backslash --only='Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector'
• Single quotes + double backslashes --only='Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodRector' (fixed)
• No quotes + double backslash --only=Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodRector
• No equal sign between --only and rule name --only "Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector"

$ ./bin/rector process --config=e2e/applied-rule-return-array-nodes/rector.php --dry-run --only="Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector"
 1/1 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

$ ./bin/rector process --config=e2e/applied-rule-return-array-nodes/rector.php --dry-run --only="Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodRector"
 1/1 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

$ ./bin/rector process --config=e2e/applied-rule-return-array-nodes/rector.php --dry-run --only='Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector'
 1/1 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

$ ./bin/rector process --config=e2e/applied-rule-return-array-nodes/rector.php --dry-run --only='Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodRector'
 2/2 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

$ ./bin/rector process --config=e2e/applied-rule-return-array-nodes/rector.php --dry-run --only=Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodRector
 1/1 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

$ ./bin/rector process --config=e2e/applied-rule-return-array-nodes/rector.php --dry-run --only "Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector"
 2/2 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

Does not work

• No quotes + single backslashes --only=Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector

$ ./bin/rector process --config=e2e/applied-rule-return-array-nodes/rector.php --dry-run --only=Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector

In OnlyRuleResolver.php line 46:
                                                                                        
  Rule "RectorDeadCodeRectorClassMethodRemoveUnusedPrivateMethodRector" was not found.  
  The rule has no namespace. Make sure to escape the backslashes, and add quotes around the rule name: --only="My\Rector\Rule"

Class name quoting on Windows

Standard cmd.exe shell

Works

• Double quotes + single backslash --only="Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector"
• Double quotes + double backslash --only="Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodRector"
• Single quotes + single backslash --only='Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector' (fixed)
• Single quotes + double backslashes --only='Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodRector' (fixed)
• No quotes + single backslashes --only=Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector
• No quotes + double backslash --only=Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodRector
• No equal sign between --only and rule name --only "Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector"

[TomasVotruba]

Rule "Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector" was not found.

This input should be handled to work, as we can narrow slashes to 1.

Rule "RectorDeadCodeRectorClassMethodRemoveUnusedPrivateMethodRector" was not found.

This input should make a not about slahes or quotes, to guide user to success.

These error were reasons to remove the old feature, so they should be covered now with helpful response 👍

[cweiske]

This input should make a not about slahes or quotes, to guide user to success.

The error message consists of 2 lines:

Rule "RectorDeadCodeRectorClassMethodRemoveUnusedPrivateMethodRector" was not found.  
The rule has no namespace - make sure to escape the backslashes correctly.            

It mentions backslashes. How shall I phrase it better?

[samsonasik]

is escapeshellarg($rule) can cover it?

[TomasVotruba]

It mentions backslashes. How shall I phrase it better?

Ideally with copy paste response. The missing quotes are more helpful in this case, as slashes are correct.

[cweiske]

I've adjusted the code and the tests:

• Double backslashes are automatically converted to single backslashes (you get them when double-quoting backslashes while single-quoting the value: --only='Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodRector')
• end-to-end-tests for different quoting styles with and without = between --only and the rule name.
• Changed error message for the missing-namespaces problem:
  • note that I do not know the original CLI parameter with slashes, and cannot offer a copy-and-paste solution.

$ ./bin/rector process --config=e2e/applied-rule-return-array-nodes/rector.php --dry-run --only=Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector

In OnlyRuleResolver.php line 49:
                                                                                                                                
  Rule "RectorDeadCodeRectorClassMethodRemoveUnusedPrivateMethodRector" was not found.                                          
  The rule has no namespace. Make sure to escape the backslashes, and add quotes around the rule name: --only="My\Rector\Rule"  

[cweiske]

I've tested all combinations on Windows (see comment above) and found that when using single quotes, the single quotes appear in the parameter value:

R:\>"c:\Program Files\php\php.exe" ./bin/rector process --config=e2e/applied-rule-return-array-nodes/rector.php --dry-run --only='Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector'

In OnlyRuleResolver.php line 49:

  Rule "'Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector'" was not found.
  Make sure it is registered in your config or in one of the sets

R:\>"c:\Program Files\php\php.exe" ./bin/rector process --config=e2e/applied-rule-return-array-nodes/rector.php --dry-run --only='Rector\\DeadCode\\Rector\\ClassMethod\\RemoveUnusedPrivateMethodRector'

In OnlyRuleResolver.php line 49:

  Rule "'Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPrivateMethodRector'" was not found.
  Make sure it is registered in your config or in one of the sets

So I've adjusted the code to remove them if necessary, and using single quotes on windows works now, too.

[cweiske]

Anyone?

[cweiske]

@TomasVotruba what do you say?

[cweiske]

@TomasVotruba Wouldn't this be nice to have in rector 2.0.0?

[TomasVotruba]

Thanks for the ping and your work. I'll look into this today and will merge 👍
It will land in 2.0 for sure

[TomasVotruba]

Very well done feature, thank you for your work @cweiske 👏