Français
Français
Lors de l'écriture de code PHP, les spécifications de code cohérentes suivantes sont essentielles à la lisibilité et à la maintenabilité du code. Cependant, l'ajustement manuellement du code pour se conformer aux dernières normes de codage PHP peut être très fastidieuse et longue. Heureusement, avec l'aide d'outils de génération de code PHP, nous pouvons automatiser ce processus et générer facilement des extraits de code conformes aux dernières spécifications de code PHP.
Cet article introduira un outil de génération de code PHP commun - PHP-CS-Fixer, qui peut automatiquement résoudre les problèmes de spécification dans le code PHP basé sur une série de règles prédéfinies.
Tout d'abord, nous devons installer et configurer PHP-CS-Fixer. Exécutez la commande suivante de la ligne de commande à installer:
composer global require friendsofphp/php-cs-fixer
Une fois l'installation terminée, n'oubliez pas d'ajouter le répertoire d'installation aux variables d'environnement du système, afin que nous puissions utiliser PHP-CS-Fixer dans n'importe quel répertoire.
Après avoir installé l'outil, vous pouvez utiliser la commande suivante pour vérifier les problèmes de spécification dans le code:
php-cs-fixer fix src/
Cette commande traversera tous les fichiers PHP dans le répertoire `src /` et résoudre les problèmes de spécification dans le code conformément aux règles prédéfinies. Il convient de noter que le code réparé écrasera directement le fichier d'origine, il est donc recommandé d'effectuer une sauvegarde de code avant d'exécuter cette commande.
En plus d'exécuter manuellement les commandes pour corriger le code de l'ensemble du projet, nous pouvons également personnaliser les règles en modifiant le fichier de configuration. Créez un fichier nommé `.php_cs.dist` dans le répertoire racine du projet et remplissez le contenu suivant:
<?php
$finder = PhpCsFixerFinder::create()
->exclude( 'vendor' )
->in(__DIR__);
return PhpCsFixerConfig::create()
->setRules([
'@PSR12' => true,
'trailing_comma_in_multiline' => true,
// 其他规则...
])
->setFinder( $finder );
Dans ce fichier de configuration, nous définissons les dossiers et les fichiers qui doivent être vérifiés via `$ Finder` et utilisons la méthode` excluant 'pour exclure le répertoire «fournisseur». Ensuite, l'objet de configuration est créé via PHPCSFixerConfig :: Create et les règles sont définies à l'aide de la méthode SetRules.
Par exemple, la règle «@ psr12» est définie sur «True», indiquant que la dernière spécification de code PSR-12 est suivie. Vous pouvez également personnaliser d'autres règles telles que `TRAILING_COMMA_IN_MULTILINE`, qui ajoute des virgules à un tableau ou une liste de paramètres multi-lignes.
Après avoir configuré les règles, nous devons seulement exécuter la commande suivante pour corriger le code:
php-cs-fixer fix
Cette commande trouvera et réparera automatiquement tous les fichiers PHP dans le répertoire actuel.
Si vous souhaitez uniquement réparer un fichier spécifique, vous pouvez spécifier le chemin du fichier après la commande:
php-cs-fixer fix path/to/file.php
En utilisant des outils de génération de code PHP tels que PHP-CS-Fixer, nous pouvons considérablement améliorer la cohérence, la lisibilité et la maintenabilité de notre code. L'outil répare non seulement le code en fonction des règles prédéfinis, mais nous permet également de personnaliser les règles pour mieux répondre aux besoins du projet.
Bien que ces outils puissent régler automatiquement les problèmes de spécification de code, il est toujours recommandé d'effectuer des avis manuels après réparation pour s'assurer que toutes les opérations de réparation répondent aux besoins réels du projet.
