Rector 1.0.0 🎉🎉🎉, mon ami, mon coach

S'il n'en fallait qu'un, ce serait Rector. Rector est extrêmement puissant et brillant et, vous savez quoi, il est gratuit !

Rector est une application formidable pour analyser et mettre à jour automatiquement votre code vers une version donnée de PHP, et cela veut dire aussi : inspecter votre façon de coder.

Rector va regarder chaque ligne de code, chaque boucle, chaque test conditionnel, chaque fonction, chaque classe d'un code source PHP et suggérer des améliorations.

Dans ce rôle, il ne va pas seulement détecter des améliorations possibles dans mon code (comme un outil d'analyse statique) mais, et c'est le plus gros avantage à mes yeux, il va me montrer comment devenir un meilleur développeur.

J'ADORE VRAIMENT RECTOR 💕

Comme beaucoup de gens, j'ai appris PHP tout seul et c'était à l'époque de PHP 5. Comme beaucoup de gens, j'ai certainement pris de mauvaises habitudes et, comme il est impossible de suivre chaque évolution du langage, mes compétences n'augmentent pas au même rythme que le langage.

Alors, peut-être que j'utilise encore une syntaxe à l'ancienne comme un simple if ... then ... else alors qu'en fait ce n'est pas utile. Peut-être que je vais utiliser une variable pour stocker une valeur alors que c'est totalement inutile.

Prenons un exemple très simple (sayHello.php) :

<?php

function sayHello($firstname = '')?
{
    if ($firstname == '') {?
        $text = 'Hello World!';
    } else {
        $text = 'Hello ' . $firstname;?
    }

    return $text;
}

echo sayHello('Christophe');

Simple et efficace, non ? Et surtout, le code est parfaitement fonctionnel et bien écrit, respectant toutes les conventions de mise en forme.

Qu'est-ce qui cloche dans mon code ?

• $firstname est une chaîne, non ? Alors pourquoi ne pas écrire string $firstname ?,
• depuis PHP 7.x, il existe un truc appelé ternary operator ; vous ne le saviez pas ?,
• en utilisant le ternary operator, la variable $text devient inutile et
• la fonction retourne une chaîne (la variable $text) mais le prototype de la fonction ne le mentionne pas. Alors pourquoi ne pas écrire function sayHello($firstname = ''): string

Voici ce que Rector en dit​

Avant même d'installer quoi que ce soit, voici la réponse que Rector donne sur ce fichier précis :

Un diff coloré — le code tel qu'il est, le code tel qu'il pourrait être — et, en bas de l'écran, une section Applied rules:.

Pourquoi ça fonctionne​

• Rector raisonne en règles nommées, pas en motifs. Chaque changement vient avec le nom de la règle qui l'a produit, et ce nom est un lien vers une explication documentée.
• Il parse votre code, il ne fait pas un grep. Rector construit l'arbre syntaxique du fichier, c'est pour ça qu'il peut voir qu'une variable n'existe que pour être retournée, ou qu'une valeur de retour ne peut être qu'une chaîne.
• Rien ne bouge tant que vous ne l'avez pas décidé. Avec --dry-run, vous obtenez le diff et vos fichiers restent exactement tels qu'ils étaient : lire les suggestions ne coûte rien.

Installer Rector​

Quand vous utilisez composer pour gérer les dépendances de votre projet, lancez simplement composer require rector/rector --dev dans une console. Cela va installer Rector comme dépendance de développement (ce qui est plutôt bien).

L'étape suivante consiste à créer un fichier de configuration. Vous pouvez utiliser un fichier standard (pour ça, lancez juste vendor/bin/rector et le fichier sera créé) ou créer le vôtre.

Je vous suggère de créer un fichier rector.php dans votre projet avec ce contenu :

<?php

declare(strict_types=1);?

use Rector\Config\RectorConfig;

return RectorConfig::configure()?
    ->withSkip(
        [
            '.git', 'node_modules','vendor'
        ]
    )
    ->withPhpSets(php82: true)?
    ->withPreparedSets(codeQuality: true, deadCode: true, typeDeclarations: true);?

Par simplicité, créez le fichier rector.php à la racine de votre projet.

Lancer Rector​

La commande qui a produit la capture ci-dessus est vendor/bin/rector process sayHello.php --dry-run --config rector.php.

Regardons-la de plus près :

• vendor/bin/rector : c'est l'exécutable à lancer,
• process : l'action à exécuter, c'est toujours process,
• sayHello.php : le fichier à analyser. Vous pouvez taper . pour tout votre projet ou p.ex. app quand app est un dossier,
• --dry-run : demande à Rector de seulement afficher les suggestions et de ne pas modifier le fichier et
• --config rector.php : c'est le nom de notre fichier de configuration.

Lancer cette commande revient donc à demander : s'il te plaît, jette un œil à mon script sayHello.php et montre-moi comment améliorer ma syntaxe. Et Rector le fait ; vite et sans juger, en montrant les changements qu'il pourrait faire et en expliquant pourquoi il les trouve meilleurs.

Règles appliquées​

Regardez la section Applied rules: à la fin de la capture d'écran ; voici les règles avec un lien vers leurs explications :

• SimplifyIfElseToTernaryRector
• SimplifyUselessVariableRector
• ReturnTypeFromStrictScalarReturnExprRector
• StrictStringParamConcatRector

SimplifyIfElseToTernaryRector​

En utilisant le ternary operator, on peut souvent remplacer une structure if then else par un test sur une seule ligne : le ternary operator.

function sayHello($firstname = '')
{
-    if ($firstname == '') {
-        $text = 'Hello World';
-     } else {
-        $text = 'Hello ' . $firstname;
-     }
+    $text = $firstname == '' ? 'Hello World' : 'Hello ' . $firstname;
     return $text;
}

SimplifyUselessVariableRector​

Je pense que tout le monde sera d'accord : stocker la valeur dans une variable $text puis retourner cette variable est inutile, ce n'est que de la pollution.

function sayHello($firstname = '')
-    $text = $firstname == '' ? 'Hello World' : 'Hello ' . $firstname;
-    return $text;
+    return $firstname == '' ? 'Hello World' : 'Hello ' . $firstname;
};

ReturnTypeFromStrictScalarReturnExprRector​

Quand le type de retour peut être déduit (ici, Rector comprend qu'on retourne une chaîne), le prototype de la fonction peut être adapté de cette manière.

class SomeClass
{
-    public function sayHello($firstname = '')
+    public function sayHello($firstname = ''): string
    {
        return $firstname == '' ? 'Hello World' : 'Hello ' . $firstname;
    }
}

StrictStringParamConcatRector​

Quand un paramètre est une chaîne mais n'est pas typé comme tel, Rector le voit et suggère de mettre à jour le prototype ainsi :

class SomeClass
{
-    public function sayHello($firstname = ''): string
+    public function sayHello(string $firstname = ''): string
    {
        return $firstname == '' ? 'Hello World' : 'Hello ' . $firstname;
    }
}

Code final​

Retour dans notre console : lancer vendor/bin/rector process sayHello.php --dry-run --config rector.php va m'afficher la nouvelle version refactorisée de mon code :

<?php

function sayHello(string $firstname = ''): string?
{
    return 'Hello ' . ($firstname == '' ? 'World!' : $firstname);?
}

echo sayHello();

Dernière chose, appliquer le changement​

Maintenant qu'on a pris le temps d'analyser les règles qui pourraient être appliquées et qu'on les trouve parfaitement adéquates, il est temps de refactoriser pour de vrai : il suffit de retirer le flag --dry-run et donc la commande finale à lancer est : vendor/bin/rector process sayHello.php --config rector.php.

Imaginez ce que ça pourrait donner sur tout mon projet si je lance vendor/bin/rector process . --dry-run --config rector.php.

Conclusion​

Un linter vous dit qu'une ligne est mauvaise. Rector vous dit ce qu'il écrirait à la place, et nomme la règle pour que vous puissiez aller lire pourquoi. C'est la différence entre un outil qui vous note et un coach qui vous apprend — et après quelques séances, vous arrêtez d'écrire la variable temporaire inutile dès le départ.

Il y a plus de 400 règles à l'heure actuelle ; voyez-les toutes sur https://getrector.com/documentation/rules-overview, et visitez https://getrector.com/ pour apprendre à configurer rector.php pour votre propre projet.

Rector n'est qu'une pièce de ma boîte à outils de qualité de code PHP ; voyez aussi comment reformater du code PHP mal formaté.