Comment utiliser les outils de génération de code pour générer automatiquement des extraits de code conformes aux dernières spécifications de code PHP ?
Lors de l'écriture de code PHP, suivre des spécifications de code cohérentes est très important pour la lisibilité et la maintenabilité du code. Cependant, l’écriture manuelle d’extraits de code conformes aux dernières spécifications de codage PHP peut s’avérer fastidieuse et prendre beaucoup de temps. Pour résoudre ce problème, nous pouvons utiliser des outils de génération de code pour générer automatiquement des extraits de code conformes aux dernières spécifications de code PHP.
Ce qui suit présente un outil de génération de code couramment utilisé - "PHP Coding Standards Fixer" (PHP-CS-Fixer en abrégé), qui peut résoudre automatiquement les problèmes standard dans le code PHP en fonction d'un ensemble de règles prédéfinies.
Tout d'abord, nous devons installer et configurer PHP-CS-Fixer. Exécutez la commande suivante dans la ligne de commande pour l'installer :
composer global require friendsofphp/php-cs-fixer
Une fois l'installation terminée, nous devons également ajouter le répertoire d'installation aux variables d'environnement du système afin que PHP-CS-Fixer puisse être exécuté dans n'importe quel répertoire.
Ensuite, nous pouvons utiliser la commande suivante pour vérifier les problèmes de spécification dans le code :
php-cs-fixer fix src/
Cette commande parcourra tous les fichiers PHP du répertoire src/
et corrigera le code selon les règles prédéfinies. questions normatives. Le code réparé écrasera directement le fichier d'origine, il est donc recommandé de sauvegarder le code avant d'exécuter cette commande. src/
目录下的所有PHP文件,并根据预设的规则来修复代码中的规范问题。修复后的代码将直接覆盖原文件,所以在运行该命令之前,建议备份代码。
除了手动运行命令来修复整个项目的代码,我们还可以通过编辑配置文件来自定义规则。在项目的根目录下创建一个名为.php_cs.dist
的文件,并填入以下内容:
<?php $finder = PhpCsFixerFinder::create() ->exclude('vendor') ->in(__DIR__); return PhpCsFixerConfig::create() ->setRules([ '@PSR12' => true, 'trailing_comma_in_multiline' => true, // 其他规则... ]) ->setFinder($finder);
在这个配置文件中,我们使用$finder
定义了需要检查的文件夹和文件,通过exclude
方法排除了vendor
目录,然后使用PhpCsFixerConfig::create
方法来创建配置对象,并使用setRules
方法定义了一组规则。
在setRules
方法中,设置了@PSR12
规则为true
,表示使用最新的PSR-12代码规范。除此之外,还可以自定义其他规则,比如trailing_comma_in_multiline
.php_cs.dist
dans le répertoire racine du projet et remplissez le contenu suivant : php-cs-fixer fix
$finder
Définir le dossiers et fichiers qui doivent être vérifiés, excluez le répertoire vendor
via la méthode exclude
, puis utilisez la méthode PhpCsFixerConfig::create
pour créer l'objet de configuration et définit un ensemble de règles à l'aide de la méthode setRules
. Dans la méthode setRules
, définissez la règle @PSR12
sur true
, ce qui signifie utiliser la dernière spécification de code PSR-12. De plus, d'autres règles peuvent être personnalisées, comme la règle trailing_comma_in_multiline
, qui ajoute des virgules aux tableaux multilignes et aux listes de paramètres. Une fois le fichier de configuration prêt, il suffit d'exécuter la commande suivante pour vérifier et réparer le code : php-cs-fixer fix path/to/file.php
Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!